Skip to content

Latest commit

 

History

History
77 lines (47 loc) · 4.8 KB

README.md

File metadata and controls

77 lines (47 loc) · 4.8 KB
Raw

What

WOT-terms

WOT is "WebofTrust". It's the home of all KERI-related open-source code. The umbrella term is KERI Suite. It covers KERI core, ACDC, CESR, OOBI, and all other parts.

What is this?

This repo manages the content and functionality of all concepts and terminology behind the KERI Suite. It offers a glossary with definitions and links to the terminology source management tools. It also feeds the dictionary tool Kerific.

Documentation subsystems and their technologies

  • This repo handles concepts and terminology resulting in a glossary run as a Docusaurus site (GitHub pages)
  • The KERI Suite documentation, which is also a Docusaurus site (GitHub pages)
  • The KERI Suite Search Engine, which is Typesense-based GitHub pages; custom-made Bootstrap.
  • The Kerific SSI dictionary: Self-Sovereign Identity dictionary including KERI terms (browser extension for Brave/Edge/Chrome).

WOT-terms

Is the data part of this site and consists of:

  • Glossary
  • Concepts behind the KERI Suite

Why

Clear criteria for term definitions around KERI are needed.

For who

The WOT-terms repo is primarily aimed at people trying to understand the inner workings of the KERI Suite and how the suite relates to other identifier systems in the SSI field.

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 that 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 GitHub pages website based on Docusaurus that manages terminology through a source management tool, which currently is the wiki of WOT-terms.

This website is built in Docusaurus ( https://docusaurus.io ).

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.

{ Kor, change link pls How we did } describes the follow-up steps.

Origin

Mid 2024 we've split up old WOT-terms repo into:

Apart from this, we still have:

  • kerific: SSI-terminology dictionary including KERI terms (browser extension for Brave/Edge/Chrome).