Open Source Documentation - Resources
Looking for great examples of projects doing it right, or want to learn the formats discussed today? This page centralizes all relevant links and repositories.
Best-in-Class Repositories
- Cardano Node: A gold standard for infrastructure documentation. It features on-page Mermaid diagrams (Architecture-as-code), comprehensive versioning notes, and links to specialized developer portals.
- Cardano Developer Portal: The ultimate example of community-driven documentation. It includes detailed Style Guides, a formal Contributing Framework, and clear technical setup procedures.
- Mastering Cardano: An exemplary case of "The Document as a Product." This repository demonstrates how a collaborative, open-source technical book handles complex cryptographic concepts and global contributions.
- Aiken Design Patterns: An exceptional example of Conceptual & Logic Documentation. It breaks down complex, unintuitive smart contract patterns (like Merkelized Validators and Linked Lists) into clear, actionable technical explanations.
- Rust Programming Language: A world-renowned external example for their "The Book" approach and dedication to Executable Documentation, where doc-examples are continuously tested for correctness.
Format Learning Resources
- Markdown: Markdownguide.org - The definitive guide to standard Markdown.
- AsciiDoc: Asciidoctor Documentation - The official writer's guide to mastering AsciiDoc features.
- Typst: Typst Documentation - The official syntax and styling guide for the modern LaTeX alternative.
- LaTeX: Overleaf Learn - Interactive tutorials for diving into LaTeX typesetting.
These resources belong to the Q1 2026 Developer Experience Working Group.