state-hub/dashboard/src/reference.md

---
title: Reference
---

```js
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](/docs/connecting) | Local and remote connection setup, ops-bridge tunnels, MCP transports |
| [Contributions](/docs/contributions) | Outbound third-party BR/FR/EP/UPR artifacts, lifecycle, todo class (not a work-record kind) |
| [Decision Health](/docs/decisions-kpi) | KPI formula, avg resolve time, open-age colour thresholds |
| [Decisions](/docs/decisions) | Decision types, statuses, escalation rules, filter bar |
| [Dependencies](/docs/dependencies) | Dependency edges, registration, cycle detection |
| [Domains](/docs/domains) | Domain model, statuses, cards with repos |
| [Extension Points](/docs/extensions) | EP types, statuses, priorities, registration |
| [Intakes](/docs/intakes) | Work-record kind for sparks; lifecycle, promotion, API/MCP |
| [Inter-Repo Communication](/docs/inter-repo-communication) | Boundary rule, Internal/Ecosystem/Third-party taxonomy, routing workflows |
| [Live Data](/docs/live-data) | Poll interval, live indicator states, offline recovery |
| [Overview](/docs/overview) | State summary sections, workplan chart, blocking decisions, next steps |
| [Progress Log](/docs/progress-log) | Event types, append-only policy, session protocol |
| [Repos](/docs/repos) | Repo registry, SBOM coverage map, ingestion commands |
| [SBOM](/docs/sbom) | Lockfile ingestion, licence report, copyleft detection |
| [Suggestions (legacy)](/docs/suggestions) | Retired gated-need table; pointer to intakes |
| [Tasks](/docs/tasks) | Task statuses, priorities, filter bar, status distribution chart |
| [Technical Debt](/docs/debt) | Debt types, severities, statuses, registration |
| [Todo](/docs/todo) | Internal/Ecosystem/Third-party classification, data sources |
| [Workplan Health](/docs/workstream-health-index) | WHI formula, six base metrics, per-domain breakdown |
| [Workplan Lifecycle](/docs/workstream-lifecycle) | Workplan stored states, health labels, flow operations |
| [Workplans](/docs/workstreams) | Workplan statuses, dependency edges, WHI KPI card |
| [WSJF Triage](/docs/wsjf-triage) | Daily triage reports, action vocabulary, advisory review workflow |

---

## Architecture & Design

| Topic | What it covers |
|-------|---------------|
| [Work Records](/docs/work-records) | Umbrella term, kind registry, spine, lifecycles, legacy name map |
| [State Hub](/docs/state-hub) | Why/how/what — Derived Data Store principle, orchestrator role, architecture diagram, design principles |
| [TPSC](/docs/tpsc) | Third-Party Services Catalog — tpsc.yaml format, ingest, MCP tools |
| [TPSC — GDPR Maturity](/docs/gdpr-maturity) | 7-level CNIL/IAPP scale, per-level guidance, key GDPR concepts |
| [SCOPE.md](/docs/scope) | The scope file format and how to write one |
| [Capabilities](/docs/capabilities) | Capability catalog, request routing, MCP tools |
| [Goals](/docs/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](/docs/ralph-workplan) | `/ralph-workplan` skill — installation, usage, workplan format, COULOMBCORE setup |
| [Reference & Context Help](/docs/reference) | How reference pages work; the ? context-help button |