Files
the-custodian/state-hub/dashboard/src/reference.md
tegwick 1e0ae37c89 docs: add State Hub reference page and restructure reference index
New page (docs/state-hub.md) covers:
- Why: the invisible state problem across repos and agents
- What: Derived Data Store, Read Model, Agent Orchestration Layer,
  Cross-Repo Observatory — and what it is NOT
- Derived Data Store principle (ADR-003): fingerprint cache, rebuild
  guarantee, force-refresh
- Repository Orchestrator: session protocol, cross-domain coordination
  via messages + capability routing, Kaizen agents
- Architecture diagram (ASCII), technology choices, data model overview
- Running the hub, design principles, related docs

reference.md: add Architecture & Design section grouping state-hub,
TPSC, GDPR maturity, SCOPE.md, capabilities, and goals docs.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
2026-03-20 02:01:58 +01:00

3.0 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

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