Docs map

The user guide is built from docs/book. Start with getting started, agent setup, commands, or configuration.

Supporting documents

Design notes record intent; the released CLI and current reference describe available behavior.

• assets/banner-dark.svg — README banner for dark backgrounds.
• assets/banner-light.svg — README banner for light backgrounds.
• design-codex-source-plugin.md — Codex event and installer design; compare with the installed source plugin.
• plans/001-initial-plan.md — Historical — original architecture and initial implementation plan.
• plans/002-invocation-tracking.md — Historical — design for tracking successes as well as failures.
• plans/003-kiro-source-plugin.md — Historical — Kiro source-plugin implementation plan.
• plans/004-cursor-source-plugin.md — Historical — Cursor source-plugin implementation plan.
• plans/004-gemini-cli-source-plugin.md — Proposal for Gemini CLI capture; not a claim of released support.
• plans/006-pave-command-corrections.md — Design for flag-aware command correction.
• plans/007-recipe-aliases.md — Proposal for multi-step recipe expansion.
• plans/008-turn-reconstruction.md — Design for reconstructing turns from transcripts.
• plans/009-new-dp-suggest.md — Design for suggestions from observed failures.
• plans/009-signposting-eval.md — Signposting contract, event definitions, and evaluation design.
• plans/backlog.md — Candidate future work; not the released feature list.
• private-key-checks.md — Contributor guide to the private-key refusal controls.
• tasks/phase-1-core.md — Historical — Phase 1: Core (Collect + Store) implementation checklist.
• tasks/phase-2-reporting.md — Historical — Phase 2: Reporting implementation checklist.
• tasks/phase-3-suggestions.md — Historical — Phase 3: Suggestions & Aliases implementation checklist.
• tasks/phase-4-polish.md — Historical — Phase 4: Polish implementation checklist.
• tasks/phase-5-invocations.md — Historical — Phase 5: Invocation Tracking implementation checklist.

Supplementary development book

The root book/ contains supplementary architecture, operations, and development notes. It is a separate tree and is not the book published by the Pages workflow. Use the current user guide above for CLI setup.

Theme provenance

The Coal override in docs/book/custom/css/custom.css is vendored byte-for-byte from Caboodle at b351e6de. Keep it in sync with the stack standard.

Maintainers

Release and README re-proof is the required checklist whenever updating the README’s pinned release or expected output.