Skip to content

WebOfTrust/WOT-terms

Repository files navigation

What

WOT-terms

It's documentation and functionality to explore this documentation. We aim to document everything related to KERI, ACDC and CESR and alike (umbrella term is KERI Suite).

What is this?

In How we did we document 'the making of' this site that consists of

  • data; which we call WOT-terminology or WOT-terms
  • functionality; which we call KERISSE

WOT-terms

Is the data part of this site and consists of:

  • whitepapers
  • code of the KERI Suite
  • Glossary
  • Q-and-A's
  • Concepts behind the KERI Suite
  • blogs
  • etc

KERISSE

Is the functionality part of this site and consists of:

Why

To let autonomic identifiers florish.

For who

WOT-terms is pimarilly aimed at KERI Suite developers (to be)

Policy

See the documents in this repo titled LICENSE.md and CONTRIBUTING.md for licensing and contributing policy. Besides the IETF licensing terms, these include the comprehensive Apache2 license for all associated intellectual property (IP) including patents. The advantage of one comprehensive license for all contributions is that there will always be alignment between all contributors and for any type of contribution. This alignment includes an inbound=outbound policy for all related IP. We only want contributions to KERI made here in the WebOfTrust project that are licensed as free, and nonreciprocal open source be it software or specification.

Meetings

We have technical meetings twice a week on Monday and Thursdays.

The Edu Meetings held every other Thursday (First meeting was on 2022 July 28), stopped April 2023.

The meeting agenda of the Technical Meeting may be found here. The zoom link is also at the top of the page.

Related Meetings

Technical

ACDC leverages KERI. The ACDC Task Force meeting is hosted at ToIP and meets on the alternate weeks at the same time as the KERI meetings. The ACDC meetings complement the KERI meetings. Both meetings are focussed on technicalities, specifications and code developments.

Conceptual

There also is the Concepts and terminology of Trust over IP. It's a meeting that aligns Trust over IP (North America) and eSSIF (Europe) efforts in getting understood: concepts, terminology and glossaries and importantly being able to use and reference each others work.

Install this project

This repo is a documentation website with a Typesense search engine and a scraper engine that collects documentation.

This website is built in Docusaurus ( https://docusaurus.io ). The Typesense search engine is integrated in Docusaurus. Also the scraper engine code is inside the Docusaurus code.

This repo has three parts:

  • Docusaurus documentation site
  • Typesense search engine
  • Chatbot (under construction)

Run website

What should you do to install this project:

  • Run git clone url

  • Run npm install

  • Create .env based on .env.example and secret info

  • Now you can run a local version of the Docusaurus website: $ npx docusaurus start. The search engine also works now.

How we did describes the follow-up steps.