...
- A source is declared in a config file that’s committed to the repo. This means anybody can propose a source by submitting a PR and debating its validity in a github issue.
- Sources could include W3C Respec docs, IETF RFCs, Aries RFCs, DIDComm specs hosted at DIF, etc. Corporate websites wouldn’t work because A) they’re too partisan; B) they’d require random, browser-style web crawling, which is too hard to automate well.
- Crawler pulls docs and scans them, looking for regexes that allow it to isolate term declarations, their associated definitions, and examples that demonstrate their usage.
- Output from crawler is a set of candidate terms that must be either admitted to a pipeline, or rejected, by human judgment. Candidates that are already in the corpus are ignored, so this just helps us keep up to date with evolving term usage in our industry.
Content Templates
Concept Template (to be further developed on github)
Concept ID: 12345 (this is a 5-digit number that’s embedded in the filename, such as c-12345.md) Criterion en text: <text that allows the reader to evaluate whether or not something qualifies as an instance of the concept in every (yes, every) relevant use-case> Definition en text: blah blah blah <other language code> text: lorem ipsum cu prorat links to media (diagrams, audio, video) Links to any discussions in github issues Notes history and theory of the concept in its larger mental model implications Related Concepts Tags |
Term
...
Template (to be further developed on github)
Term: faster than light Short form: Acronym: FTL Language: en Labels concept: c-12345 (filename for this term would be t-12345.x.md, where 12345 comes from the concept, and x is 1-3 digits that uniquely identify the term in the context of its concept) Links to any discussions in github issues Notes metaphors or mental/conceptual models (or namespaces) that inform the choice of this label for the concept implications Examples of usage Scope: (description of the scope of application) Tags |
Glossary
...
Template (to be further developed on github)
Name: ToIP Governance Glossary Language: en Scope: (description of the scope and purpose for which the glossary is supposed to be used.) Taglist: (any term that has a tag from this list will be included in this glossary) Links to any discussions in github issues Notes: |
...