Skip to content

Documentation evidence — issue-3 ​

What the capability-docs gate checks, and where it is met.

Capability docs ​

One doc per requirement group under docs/capabilities/, each from the-loop's capability template (what it is, normative current behaviour, design pointers, history rows to this spec and to decisions 002–004):

Requirement groupCapability doc
R1entities-and-registry
R2hooks
R3plugins
R4, R5prompts-and-skills
R6tools
R7remote-agents
R8, R9tasks-and-plans
R10context-window
R11persistence
R12, R13participants-and-channels
R14, R15a2a-server
R16heartbeat
R17observability
R18models
R19durable-execution
R20surfaces-and-renderers
R21configuration
R22, R23repo-tooling (history row for issue-3: module tree, Any ban, contract tests)
R24demo

docs/capabilities/capabilities.md indexes them by column (harness, service, surfaces, repository). docs/architecture/architecture.md was rewritten from the one-function placeholder to the layer map, the module table and a request's life.

Guides and reference pages ​

  • docs/guide/getting-started.md: the demo end to end, what happens, the e2e tests.
  • docs/guide/deployment.md: the perimeter requirement (decision-003), processes, the configuration and secrets tables with the keyring lookups, retention per data kind (store TTLs, Temporal Cloud history retention, trace backend), observability.
  • docs/a2a/extensions.md, docs/a2a/ext/task/v1.md, docs/a2a/ext/channel/v1.md: the three advertised extensions; the task and channel pages embed the committed schemas so the extension URIs resolve to documentation on the published site.
  • README.md: what is in the box and how to run the demo.

Checks ​

CheckCommandOutcome
markdownlintnpx markdownlint-cli2 "docs/**/*.md" README.md (the pre-commit hook)0 issues
docs buildbun run --cwd docs docs:buildbuild complete, no dead links
navdocs/.vitepress/config.mts: Guide gains Getting started and Deployment; a new A2A group; capabilities are listed from the directory—

Decisions 002–004 are linked from the capability docs that depend on them (durable-execution, a2a-server, participants-and-channels, hooks, tools, tasks-and-plans).