Version: Current
Historical release snapshot. These docs are frozen. Read current docs.
Reference
import StatusPill from ‘../../../components/StatusPill.astro’;
The reference section is generated wherever a machine-readable source exists, so a page cannot drift from the thing it describes.
| Page | Source of truth | Checked by the gate |
|---|---|---|
| API reference | acumen-vnext/docs/openapi/acumen-v1.openapi.json |
yes |
| Command reference | acumen-vnext/cmd/acumen/main.go and cli/internal/cli/*.go (configured in tools/docs-engine/sources.json) |
yes |
| Configuration | acumen flags/custody and tcp/tcp-mcp bootstrap env/flag reads (configured in tools/docs-engine/sources.json) |
yes |
| Error codes | internal/protocol/errtaxonomy/taxonomy.go |
yes |
| Error actions | written by hand from the taxonomy | no, but the codes it names are checked |
| RPC reference | proto/tcps/studio/v1/*.proto |
yes |
| Model catalogue snapshots | acumen model/catalogue contract and dated snapshot captures | no, snapshots are dated observations |
| Changelog | this repository’s commit history | no, it is a feed |
| Docs health | public/docs-health.json |
no, it is a measurement |
Legacy acumen and consumer detail pages remain under Reference for migration context. They are labeled as legacy details. Do not read them as current live guidance.
For a complete migration guide covering base URLs, key handling, model aliases, streaming, error handling, and failover, see Migrating a client to acumen.
How a page is generated
Section titled “How a page is generated”tools/docs-engine/generate.mjs reads each source, renders markdown, and either
writes it (--write) or compares it with the file on disk (--check). The gate runs --check. If a gateway route changes, the docs build fails until
the reference is regenerated.
When a source is absent
Section titled “When a source is absent”A checkout without a sibling acumen-vnext or cli repository reports those
pages as skipped rather than failing. That is a deliberate trade: a contributor
on a laptop can build the site, while the scheduled cycle on the docs host runs
with --require-sources so a silent absence cannot pass as green.