Skip to main content

ADR 0001: Docusaurus information architecture baseline

Statusโ€‹

Accepted

Contextโ€‹

The docs app had navigation entries for many pages that were absent in site-docs/**. This produced brittle routes and made contributor onboarding harder.

Decisionโ€‹

Define a small, maintainable baseline structure with hand-authored pages for:

  • top-level overview and getting-started docs,
  • developer guide, API guide, ADR index, and charts,
  • a sidebar that primarily reflects existing docs and uses autogenerated sections only where content exists.

Consequencesโ€‹

Positiveโ€‹

  • Fewer broken routes and clearer contributor expectations.
  • Easier expansion: new docs can be added incrementally without rewriting nav.
  • Better separation of hand-authored docs versus generated API output.

Negativeโ€‹

  • Reduced ambition in initial sidebar scope compared with a fully pre-populated information architecture.

Follow-upโ€‹

Expand ADR and charts sections over time as implementation decisions mature.