tegwick
fb363b37d3
History is archived fleet-side, so the read surface has no remaining job. - api/routers/suggestions.py: whole prefix 410s with a pointer to intake and to the archive; the router drops from 176 lines to a stub - mcp_server: the 6 suggestion tools removed outright rather than stubbed -- a retired tool that still appears in the tool list costs every agent session context on every call, which is the opposite of retiring it - write_idempotency: 5 /suggestions rules dropped - dashboard: suggestions.md deleted, nav entry removed, reference.md and wsjf-triage.md updated; docs/suggestions.md rewritten as archive pointer - tests: two tests pinned the old read-live behaviour and now pin the retirement contract instead Tables stay: they are retire/archive in SHR-INV-0001 and are captured by the final dump at T06. Untouched, and worth knowing during cutover: ui-feedback.md / todo.md 'suggestions' are Shift+click dashboard feedback backed by technical_debt, a different entity that shares the word. E3 (dashboard-meta) is that page; its owner is state-hub-until-cutover so it retires at the T06 window, not now. Full suite 612 passed. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
4.4 KiB
4.4 KiB
| title |
|---|
| Reference |
import {withDocHelp} from "./components/doc-overlay.js";
const _h1 = document.querySelector("#observablehq-main h1");
if (_h1) { _h1.style.position = "relative"; withDocHelp(_h1, "/docs/reference"); }
Reference
In-depth documentation for each dashboard page, data model, and design convention used in the Custodian State Hub.
Dashboard pages
| Page | What it covers |
|---|---|
| Connecting to the Hub | Local and remote connection setup, ops-bridge tunnels, MCP transports |
| Contributions | Outbound third-party BR/FR/EP/UPR artifacts, lifecycle, todo class (not a work-record kind) |
| Decision Health | KPI formula, avg resolve time, open-age colour thresholds |
| Decisions | Decision types, statuses, escalation rules, filter bar |
| Dependencies | Dependency edges, registration, cycle detection |
| Domains | Domain model, statuses, cards with repos |
| Extension Points | EP types, statuses, priorities, registration |
| Intakes | Work-record kind for sparks; lifecycle, promotion, API/MCP |
| Inter-Repo Communication | Boundary rule, Internal/Ecosystem/Third-party taxonomy, routing workflows |
| Live Data | Poll interval, live indicator states, offline recovery |
| Overview | State summary sections, workplan chart, blocking decisions, next steps |
| Progress Log | Event types, append-only policy, session protocol |
| Repos | Repo registry, SBOM coverage map, ingestion commands |
| SBOM | Lockfile ingestion, licence report, copyleft detection |
| Suggestions (archived) | Retired backlog; archived record and pointer to intakes |
| Tasks | Task statuses, priorities, filter bar, status distribution chart |
| Technical Debt | Debt types, severities, statuses, registration |
| Todo | Internal/Ecosystem/Third-party classification, data sources |
| Workplan Health | WHI formula, six base metrics, per-domain breakdown |
| Workplan Lifecycle | Workplan stored states, health labels, flow operations |
| Workplans | Workplan statuses, dependency edges, WHI KPI card |
| WSJF Triage | Daily triage reports, action vocabulary, advisory review workflow |
Architecture & Design
| Topic | What it covers |
|---|---|
| Work Records | Umbrella term, unit vs structure, spine, lifecycle vs DoX quality badges |
| State Hub | Why/how/what — Derived Data Store principle, orchestrator role, architecture diagram, design principles |
| TPSC | Third-Party Services Catalog — tpsc.yaml format, ingest, MCP tools |
| TPSC — GDPR Maturity | 7-level CNIL/IAPP scale, per-level guidance, key GDPR concepts |
| SCOPE.md | The scope file format and how to write one |
| Capabilities | Capability catalog, request routing, MCP tools |
| Goals | Domain and repo goals, priority ordering |
Entity Detail Pages & REF Column
Every entity table in the dashboard includes a REF column (leftmost) that shows
the 1-based row number for the current view. Clicking the REF number copies a
deep-link to the clipboard in the format /data/<recordtype>/<id>. Double-clicking
opens that link in a new tab.
The deep-link target is an entity detail page that renders all fields of the record
in a key-value layout. Each field key is decorated with a <help-tip> that shows a
one-sentence description of the field and a "Learn more" link to the relevant
documentation section.
Currently implemented record types:
| Record type | URL pattern | Source endpoint |
|---|---|---|
token-events |
/token-events/<id> |
GET /token-events/{id} |
Further record types (repos, workplans, tasks) will be added in subsequent workplans.
Meta
| Topic | What it covers |
|---|---|
| Ralph Workplan | /ralph-workplan skill — installation, usage, workplan format, COULOMBCORE setup |
| Reference & Context Help | How reference pages work; the ? context-help button |