Documentation

This is the in-product documentation browser at /docs in the Control Plane — a read-only viewer over the Canonical Documentation Corpus, the same generated corpus that also feeds docs.faburai.com. There is no backend module of its own; the page (control-plane/modules/docs/ui/docs-page.tsx) is a thin client over the shared docsserve package, mounted by the Control Plane router as an internal viewer with full visibility and no entitlement gate, since it is read by FaburAI staff running an install as much as by customers.

The corpus is baked into the Control Plane image at build time (docs/corpus/ copied into the Docker image), not fetched at runtime — which is exactly what makes it work with zero network access in an air-gapped install, and why it is frozen at exactly the deployed version until the next upgrade replaces it. A deployment built without a corpus directory is a valid configuration, not an error: the page detects the missing mount and shows "Documentation is not installed in this deployment" with a link to the hosted site instead of failing.

The browser gives a reader three ways in: a left-hand navigation tree built from the corpus's product areas and capabilities (via /api/cp/v1/docs/nav), free-text search across entity titles and summaries (/api/cp/v1/docs/search), and — for a capability landed on directly rather than browsed to — a "Reference" section on its page that surfaces its own sub-pages (API, interface, configuration, schema, change history) so a reader who arrived via search or a shared link isn't stuck without a path down into the detail. Each page renders a small literal-markdown subset (bold and inline code only) plus structured "facts" — typed, sourced claims like an API endpoint or a database column — with their own provenance where the corpus records it.

A Data Plane can also serve documentation, but by default it proxies reads to its Control Plane rather than carrying and maintaining a second copy — /api/cp/v1/docs-relay exists specifically for that, passing along the requesting tenant's account kind so the Data Plane's readers get the same visibility and entitlement projection they would get by reading the Control Plane directly. Only a standalone Data Plane, with no reachable Control Plane, falls back to serving its own baked-in corpus.