core/workbench-ui/README.md
Shay 172afc2d9e
docs(workbench): align UI catch-up plan and route docs (#890)
* docs(workbench): refresh UI route inventory

* docs(workbench): add master UI catch-up plan

* docs(workbench): add UI guide catch-up addendum

* docs(workbench): add construction read model implementation brief

* docs(workbench): add trace construction tab implementation brief

* docs(workbench): add generalization audit UI brief

* docs(workbench): add proposal artifact and demo theater brief

* docs: remove trailing whitespaces
2026-06-23 10:02:17 -07:00

2.5 KiB

CORE Workbench UI

React/Vite/TypeScript frontend for CORE Workbench — a local operator/auditor UI over the deterministic engine. 16 registry-driven routes (src/app/routes.ts): chat; trace (per-turn pipeline / field-invariant / leeway / evidence-bundle tabs); contemplation; guided determinism tour; replay (hash-to-hash); demos; proposals + HITL ratification; evals (wrong=0 ledger); calibration (gold-tether arena); runs; lived-life; vault; packs; CORE-Logos; audit; and settings. Read-only by default, 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)
pnpm build               # TypeScript + Vite production build

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).

Catch-up doctrine

The Workbench is an evidence surface, not a mutation console. New UI work must only render backend-provided read models, committed artifacts, or existing allowlisted execution paths. Proposal-first construction evidence, residual-gated practice traces, generalization audit reports, and CORE-Logos pack evidence must remain diagnostic/read-only unless a later ADR admits a narrow handler path.

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