Documentation standard¶
| Concern | Standard or convention | NOW integration |
|---|---|---|
| Content purpose | Diátaxis | Every curated page is one tutorial, how-to, explanation, or reference page |
| Authoring | CommonMark-compatible Markdown with MkDocs extensions | Source remains readable in the repository and renders through MkDocs Material |
| Protocol reference | AsyncAPI 3.0 | contract/asyncapi.yaml is authoritative; a deterministic Markdown projection is committed |
| Architecture diagrams | Mermaid | Diagrams are source-controlled and always followed by a text equivalent |
| Accessibility | WCAG 2.2 AA target | Semantic landmarks, heading rules, alt text, keyboard skip link, contrast-aware theme, responsive tables, and reduced-motion CSS are gated |
| Vulnerability discovery | RFC 9116 | Release builds generate /.well-known/security.txt only from configured contact data |
| Search metadata | Schema.org TechArticle |
Curated pages emit JSON-LD from front matter |
| Search scope | Curated guidance before evidence ledgers | Linked deep records keep stable rendered URLs, while docs/reference-index.yaml excludes deep and append-only records from primary search |
| Verification date | Human attestation in ISO YYYY-MM-DD form |
The gate rejects malformed and future dates; the date does not replace source-derived currency checks |
| Page navigation | MkDocs Material instant navigation | Internal links replace the document content without a full-page reload; page-dependent scripts subscribe to navigation updates |
| Release availability | Stable feature IDs and profiles | docs/feature-catalog.yaml drives page notices and generated availability tables; planned runtime flag keys are explicit but not claimed as implemented |
| Audience ownership | One owning explanation per audience purpose | User pages explain product use; the developer guide explains code; the coding-agent guide contains only operational agent protocol and links back for technical detail |
| Publication | Standalone /docs/ preview now; selected independent target docs.newoldworldmac.com |
The app repository owns source, gates, and future GitHub Pages deployment; the website repository links to it without rebuilding its container |
The gate checks the properties that can be derived locally. A captured image is
refused unless its manifest entry records privacy_reviewed: true; human
review still owns clarity, task success, visual accuracy, meaningful
alternative text, and whether that declaration is actually justified by the
pixels. Likewise, last_verified records when a person last checked a page;
the gate validates that date but does not infer freshness from elapsed time.
Machine-derived claims use manifests, live source comparisons, and
derived-doc source digests instead.