Maintain these docs

The hub is a small platform app. Public guides and private repository notes have separate publication rules, so adding an internal README does not automatically publish its body to the internet.

Public guides

Guide source lives in apps/documentation/content/. The catalog in apps/documentation/catalog.py defines titles, navigation groups, and stable URLs.

Use Markdown headings, tables, code fences, and descriptive links. Page headings get stable anchors and populate the table of contents. Raw HTML is not executed. Prefer links to the current guides when explaining deployed behavior.

When a capability changes, update its public guide and the underlying operator documentation in the same change. Distinguish what is deployed, what is optional, and what was an earlier proposal.

App documentation

Every non-template app manifest creates a public overview at /docs/apps/<slug>/. Arena has an explicit entry because it is a standalone service. The directory is metadata-driven; it does not query production data or execute model calls.

Add a README.md or other Markdown note at the top of an app folder, or under its docs/ directory. After deployment, the overview links those files as administrator-only notes. Use the README for purpose, access requirements, architecture, important workflows, limitations, and tests.

Curated overview descriptions can be expanded in the documentation catalog. An app with no README still has an overview and links to relevant platform guides.

Operator references

The allowlist includes repository docs/*.md, approved app Markdown locations, Arena documentation, and the shared Films README. It does not serve arbitrary source files, credentials, runtime files, or files chosen by a URL path.

Private note bodies are excluded from anonymous search. Links between allowlisted Markdown files are rewritten to their documentation URLs. References to unpublished source files remain labeled text instead of broken download links.

Validate and ship

at doctor documentation
at deploy --skip-build

Check the public guides, app directory, mobile navigation, search, and at least one protected note. Verify that signed-out users cannot read or search private content. Then commit the app and accompanying catalog updates.

The documentation app overview links to implementation notes for this hub.