Presentation: MkDocs with Material Theme
We serve the Spec library as a static documentation site using MkDocs (Material theme). Developers browse, search, and cross-reference Specs via this site; CI/CD consumes tool configs directly, not the website.
Considered options: - Raw Markdown on GitHub — no search, no sidebar, no version switching. - Custom SPA (React/Vue) — interactive but high maintenance, premature for the current scale. - MkDocs — zero-cost hosting (GitHub Pages), built-in search, sidebar navigation, dark mode, versioning via mike. - CLI-only — good for developers but hides the big picture from Tech Leads.
Consequences:
- The website is a read-only view; it does not enforce anything. Enforcement lives in CI/CD tool configs.
- MkDocs' mkdocs.yml nav can be auto-generated from Spec front-matter, keeping sidebar in sync with files.
- GitHub Pages deployment is a single gh-pages branch push, trivially CI-able.