Reference
TBD. Auto-generated TypeDoc API reference will live here.
Wiring this up is a Phase 5 follow-up — see ../plan/phase-5-hardening.md. The mechanical setup is documented in the nextra-docs hub guide and consists of:
- Add
typedoc+typedoc-plugin-markdownas dev dependencies. - Add
typedoc.jsonconfigured to output markdown into this directory. - Add an
npm run docs:referencescript that regenerates the output. - Add a CI job that re-runs the script and fails the build if
docs/reference/is dirty (catches edits to source that didn’t refresh the reference).
Until then, the authoritative API surface is the source in src/ and the per-module narratives in components.