openrig/docs/as-built/README.md

kind, title, status, topics, domains, applies-when, siblings, prerequisite-reads, last-verified-against-source, last-updated

kind	title	status	topics	domains	applies-when	siblings	prerequisite-reads	last-verified-against-source	last-updated
as-built	As-Built Docs — Module Index	active	knowledge-and-context observability	engineering-advisor operating-advisor product-advisor	Starting a technical task and choosing the as-built module or source entry point to read. This index describes the document tree; each module carries its own source-verification stamp.	codemap.md arteries.md test-layers.md cli-reference.md frontmatter-schema.md		e8f0ab340d	2026-10-08

OpenRig as-built docs

These pages describe the code and point to its owning files. This index was checked against main commit e8f0ab340db773392ec8be75b072d1c0f3068a50. A linked module's last-verified-against-source is its own verification boundary; updating this index does not revalidate that module or identify a running daemon or published package.

For the repository overview and contributor recipes, start with ARCHITECTURE.md. Use codemap.md to locate source, arteries.md to identify dependent paths before a change, and test-layers.md to choose checks.

Repository surfaces

The npm workspaces are packages/daemon, packages/cli, packages/tui, and packages/ui (root package manifest). The daemon provides the SQLite-backed HTTP services; CLI, TUI and MCP clients consume them. Runtime adapters include Claude Code, Codex, Pi, OMP, terminal and stub implementations under packages/daemon/src/adapters/.

The CLI package contains the assembled daemon, TUI and web UI. User reference documents ship from docs/reference/; this as-built tree is developer documentation. The assembly is in scripts/build-package.sh, with the published file list in packages/cli/package.json.

Module index

Daemon and runtime

Module	Read for
daemon-core.md	Process startup, service wiring, database migrations and HTTP mounts.
adapters-and-runtimes.md	Runtime adapter methods, harness launch/resume and native-session checks.
agent-spec-and-startup.md	Spec resolution, resource projection, startup delivery and identity.
coordination-primitive.md	Stream, queue, inbox/outbox, handoff and closure.
workflow-runtime.md	Workflow specifications, instances, projection, trails and watchdog policies.
mission-control.md	Queue observations, actions and their audit records.
lifecycle-snapshot-restore.md	Snapshot capture, restore decisions and continuity checks.
transport-and-transcripts.md	Session messaging, capture, transcripts, chat and ask.
workspace-primitive.md	Workspace and repository declarations, project resolution and scope.
content-surfaces.md	File reads/writes, path checks, progress indexing and steering composition.
living-notes-review.md	Review gathering/composition, proof records, approvals, export and media.
plugin-agent-image-context-pack.md	Plugin discovery, agent images, context packs and compaction policy.
packaging-bootstrap-bundles.md	Package assembly, reusable topology bundles and bootstrap/install paths.
architecture-rules-and-event-system.md	Cross-cutting invariants, events and compatibility notes.

Navigation, checks and reference

Document	Read for
codemap.md	Question-to-module navigation and source entry points.
arteries.md	Code paths where changes affect several subsystems.
test-layers.md	Test scope, isolation, scenarios and hosted CI.
cli-reference.md	CLI commands and options; confirm changing details in packages/cli/src/index.ts and command help.
frontmatter-schema.md	Metadata fields used by these documents.
architecture.md	Compatibility pointer from the former monolithic architecture page.
DESIGN.md	Visual and design-system specification.

Web UI reference

Each page below carries its own verification stamp. This index checks that the pages exist, not their contents.

Document	Topic
ui.md	Compatibility pointer to the UI modules.
shell-and-routing.md	Web UI shell and routing.
topology.md	Web topology views.
project-and-for-you.md	Project and attention surfaces.
library-specs-and-design-system.md	Library/spec views and design-system pointers.

For the terminal UI, start at packages/tui/src/main.ts, its HTTP client packages/tui/src/daemon-client.ts, and the TUI sections of test-layers.md.

Derive the document inventory

At the named commit there are 26 Markdown files: 14 under architecture/, 4 under ui/, and 8 at the root of this tree (including both compatibility pointers). Reproduce these counts from the repository root:

source_commit=e8f0ab340db773392ec8be75b072d1c0f3068a50
git ls-tree -r --name-only "$source_commit" -- docs/as-built | grep -E '\.md$' | wc -l
git ls-tree -r --name-only "$source_commit" -- docs/as-built/architecture | grep -E '\.md$' | wc -l
git ls-tree -r --name-only "$source_commit" -- docs/as-built/ui | grep -E '\.md$' | wc -l
git ls-tree -r --name-only "$source_commit" -- docs/as-built | grep -E '^docs/as-built/[^/]+\.md$' | wc -l

Read a module's source stamp and prerequisite pointers before relying on it. Source code at the named commit is the authority when prose disagrees; frontmatter-schema.md describes how the stamp is represented.