Shay a791b23008 docs(workbench): refresh READMEs to shipped reality (index + surfaces)

The workbench READMEs were frozen in the W-026..W-031 planning era. Bring them
current after the Wave 1 / R / M arc:

- docs/workbench/README.md (index): add the 5 unindexed docs (wave-1-evidence-
  spine, wave-R-mastery-revamp, wave-M-worthiness, b4-leeway-producer-scope,
  design-system); replace the false "Current Status" (which still pointed at the
  superseded feat/w026 prototype) with the shipped state + a 14-route surface
  table; mark the W-026..W-031 queue delivered; note Wave M complete (B+C+D+B4),
  Phase E + parallel tracks remaining.
- workbench-ui/README.md: fix the stale one-line surface list and the "src/routes
  placeholder components" description (routes are registry-driven in src/app/;
  routes.ts is the single source). Left the dump-api-schemas.py reference intact
  (it exists, distinct from dump-schemas.py).
- README.md (top level): the workbench section said "eleven routes" — now
  fourteen, naming Tour, Contemplation, and Calibration and the per-turn
  pipeline/field/leeway/bundle evidence.

Docs-only; no code or gate touched. UI-UX-GUIDE (the routes.docs.test-gated
route table) is unchanged and already at 14.

2026-06-13 20:37:29 -07:00

2 KiB

Raw Permalink Blame History

CORE Workbench UI

React/Vite/TypeScript frontend for CORE Workbench — a local operator/auditor UI over the deterministic engine. 14 registry-driven routes (src/app/routes.ts): chat; trace (per-turn pipeline / field-invariant / leeway / evidence-bundle tabs); the guided determinism tour; replay (hash-to-hash); demos; proposals + HITL ratification; evals (wrong=0 ledger); calibration (gold-tether arena); runs; vault; packs; and audit. Read-only, with allowlisted execution only.

Local development

# Terminal 1 — start the API (W-026)
uv run core workbench api

# Terminal 2 — start the frontend
cd workbench-ui
pnpm install
pnpm dev         # http://127.0.0.1:5173

Custom API URL

VITE_WORKBENCH_API_URL=http://127.0.0.1:9000 pnpm dev

Design system baseline

pnpm preview   # Serves dist/ on http://127.0.0.1:4173
# Navigate to /preview for the Branch 1 design-system baseline

Tests

pnpm test                # Vitest unit + component tests
pnpm test:enum-coverage  # Badge enum coverage (requires uv)

Schema drift detection

The TypeScript types in src/types/api.ts mirror workbench/schemas.py. To check for drift after Python schema changes:

# From repo root
uv run python scripts/dump-api-schemas.py
# Then run: pnpm test (api.test.ts catches field-level drift)

Architecture

src/app/ — Shell, TopBar, LeftNav, StatusFooter, ApiErrorBoundary, and the route surfaces in src/app/<route>/. src/app/routes.ts is the single route registry (feeds App, LeftNav, command palette, shortcuts, and conformance).
src/api/ — apiFetch client, TanStack Query hooks
src/types/ — TypeScript mirrors of Python schemas (src/types/api.ts)
src/routes/ — the Chat route entry
src/design/ — design-system substrate (tokens, primitives, doctrine gates)

ADR cross-references

ADR-0160 — Workbench v1 architecture
ADR-0162 — Design substrate (Branch 1)
ADR-0156, ADR-0157, ADR-0158 — Engine-state checkpoint and reboot audit trail

2 KiB Raw Permalink Blame History