...
- Markdown (this is the format currently required for ToIP specifications)
- Kramdown vs. Markdown-it
- something else
Diagrams and images:
Research into a ToIP / WebofTrust diagrams directory: Decentralized Diagrams Directory
- Mermaid
- D2
- something else
Comparison site: https://text-to-diagram.com/
Differences Mermaid vs D2:
- Images & Icons: What are the available options for including images and icons
- Markdown: Use Markdown for text objects in the diagram
- Code snippets: Render syntax-highlighted code snippets
- Autoformat: Language tooling to autoformat a file
- Responsive dark mode: Can the diagram render with both light and dark mode, - switching depending on user preference
- PDF exports: Can the CLI export PDF output
Document rendering:
- Spec-up (this is our primary specification authoring tool)
- Respec
- MKdocs
- Docusaurus
- something else
...
- Method
- Publication deliverable / permanent links
- Spec-Up versioning and git/github strategy - see concern
Image versioning:
- a sustainable way of storing and referencing source and (auto)generated results of diagrams
- a layered structure - and overall maintenance of this documentation for different user groups and levels in a consistent way
- Broken links checker
Tooling:
- A set of GitHub actions that render publicly accessible:
- Webpages?
- Word documents?
- PDFs?
...
Acronym | Full Name of Deliverable | Deliverable Type | Link to Draft Deliverable | Lead Authors | Status/Notes |
---|---|---|---|---|---|
ST | Specification Template | Template | https://github.com/trustoverip/specification-template | Draft | |
... | Specification Style Guide | Guide | https://wikilf-toip.trustoveripatlassian.orgnet/wiki/display/HOME/Specification+Style+Guide | ||
TGG | Terminology Governance Guide | Guide | https://henkvancann.github.io/terminology-governance-guide/ | @henkvancann | Draft |
...