Examples & coverage¶
The examples/ directory holds
runnable deployment recipes (the Dashboard is a deployable service, so its examples are
ways to run it, not agent specs), and this page doubles as the documentation coverage
map — every shipped surface either has a documented home or an explicit, reasoned deferral.
Deployment recipes¶
| Scenario | Recipe | Guide |
|---|---|---|
| Try it in ~2 min (Dashboard + ephemeral in-memory kneo-serv, static-dev admin) | docker-compose.yml |
Quickstart |
| Production — supported single-instance SQLite (OIDC + same-origin TLS proxy) | docker-compose.prod.yml + nginx.conf |
Deployment · Security hardening |
| Production — best-effort multi-replica Postgres (not soak-certified, ADR-012) | docker-compose.prod-postgres.yml + Dockerfile.postgres |
Deployment › state store |
| All configuration knobs, annotated | .env.example |
Environment variables |
The canonical run walkthrough is Quickstart + Connecting; when a recipe comment and the guides differ, the guides win.
Coverage — the three axes¶
Depth is measured against the shipped surface, not the legacy guide set. Three axes keep
cross-cutting features (that no single page owns) from slipping. Completeness is a Pre-cut
checkpoint (folded into the Phase-7 doc-fidelity gate, audited against
frontend/src/design/layout.tsx + the endpoint matrix).
1. Page → doc (top-level SPA nav)¶
| Nav page | Route | Documented in |
|---|---|---|
| Overview | /overview |
Runs & debugging › Overview |
| Runs · Run detail | /runs |
Runs & debugging |
| Error clusters | /errors |
Runs & debugging › Error clusters |
| Human tasks | /human-tasks |
Human-in-the-loop |
| Health | /health |
Audit & health › Health |
| Audit | /audit |
Audit & health › Audit |
| Launch | /launch |
Runs & debugging › Launching a spec |
| Policies | /policies |
Policies & credentials › Environment policies |
| Credentials | /credentials |
Policies & credentials › Credential inventory |
| Settings | /settings |
Settings |
| Deployments | (reserved) | reserved / disabled — a platform-owned surface, not shipped (nav item is dark) |
2. Router → doc (BFF /api/*)¶
Endpoint-level truth (class · deps · capability · effect) is the generated, CI-gated endpoint matrix. Grouped by operator-facing home:
| Routers | Home |
|---|---|
runs · traces · overview |
Runs & debugging |
spend · pricing |
Cost & spend |
human_tasks |
Human-in-the-loop |
audit (platform) · health · ops |
Audit & health · Deployment › probes |
policies · credentials |
Policies & credentials |
launch |
Runs & debugging › Launching |
connections · access · preferences |
Settings · Connecting |
annotations · saved_filters |
Runs & debugging (lifecycle depth → guide deepening, below) |
auth · sessions |
Security hardening · Connecting |
audit_log (dashboard-local) |
Data handling · state-store audit contract |
3. Workflow / capability (cross-cutting)¶
Features no single page owns — the axis the review added so they can't be orphaned:
| Feature | Home |
|---|---|
| Launch history / one-click re-launch | Runs & debugging › Launching |
settings.write meta-capability · Access re-auth |
Settings › Access |
| Best-effort audit / attribution | Data handling · audit contract |
| Approximate cost / truncated-window | Cost & spend |
| Platform version floors / graceful degrade | Connecting › Platform compatibility |
| Runs/Audit CSV & JSON export | Runs › Export · Audit › Export |
| Run-bundle export | Runs › Export a run bundle |
| Bulk Stop (multi-run cancel) | Runs › Bulk Stop |
| Saved-filter lifecycle (incl. the update path) | Runs › Saved filters |
Annotation conflict handling (409 optimistic-concurrency) |
Runs › Notes & annotations |
| Request-ID troubleshooting | Troubleshooting › Using the request id |
Every cross-cutting feature now has a documented home — the Pre-cut coverage checkpoint (audited
against layout.tsx + the endpoint matrix) confirms none is orphaned at rc.
Related¶
- Quickstart · Connecting — the canonical run walkthrough.
- endpoint matrix — generated per-endpoint truth.