tegwick
20ce332d55
- ref-cell.js: REF column component — click=copy deeplink, dblclick=open
- field-help.js: field registry + fieldRow helper with help-tip decoration;
FK fields (task_id, workstream_id, repo_id) render as async-linked cells
with entity-title bubble-help on hover
- GET /token-events/{id} endpoint + get-by-id tests
- GET /repos/by-id/{repo_id} UUID lookup endpoint
- Landing pages: /token-events/[id], /workstreams/[id], /repos/[slug], /tasks/[id]
- token-cost.md: REF + Name columns on all three tables; parallel fetch of
workstreams/tasks for title resolution
- reference.md: entity detail page URL scheme documented
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
3.9 KiB
title
| 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 | Contribution types, lifecycle, third-party todo workflow |
| 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 |
| 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, workstream 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 |
| Tasks | Task statuses, priorities, filter bar, status distribution chart |
| Technical Debt | Debt types, severities, statuses, registration |
| Todo | Internal/Ecosystem/Third-party classification, data sources |
| Workstream Health | WHI formula, six base metrics, per-domain breakdown |
| Workstreams | Workstream statuses, dependency edges, WHI KPI card |
Architecture & Design
| Topic | What it covers |
|---|---|
| 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, workstreams, 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 |