API
Contracts for every route another client or system calls: Markdown, llms.txt, search records, crawler routes and any future integration.
Contracts for every route handler and endpoint that another client or system calls — the
Markdown routes, llms.txt, the search records, and any future integration.
Living snapshots. Edit in place so each file describes the system as it is right now. No revision tables, no "previously X, now Y" — delete what is no longer true (ADR-0002).
Conventions
- File name:
<resource>.mdx. - Each endpoint: purpose, who may call it and what content it can return (cross-reference
content/docs/maintain/rbac/), request, responses, caching, side effects. - A public endpoint says what keeps private content out of it.
Template: ../_templates/api.mdx
Documents
| Document | Status | ADR |
|---|---|---|
| Machine-readable content routes | Current | — (Fumadocs scaffold) |
| Crawler routes | Current | ADR-0035 |
PRD — the universe theme
Why the site needed a wider sky than one solar system, and what the Verse must do for readers moving between its levels.
API — Machine-readable content routes
The contracts of the routes tools read: per-page Markdown, llms.txt, llms-full.txt, Open Graph images, search records and the proxy's redirects.