Documentation README

This is the entry point for agent-doc documentation, specs, and product-planning material.

Start Here

• README - project overview, install commands, quick start, architecture summary, editor setup, and security model.
• Introduction - concise user-facing introduction.
• Quick Start - shortest path from a markdown file to an agent-doc cycle.
• Installation - install paths for the CLI and editor integrations.
• Configuration - project and document configuration.

Guides

• Commands - user-facing command guide.
• Document Format - session frontmatter and component layout.
• Components - named component patching model.
• Dashboard-as-Document - dashboard workflow.
• Run Flow - normal edit, diff, response, write, and commit flow.
• Editor Integration - JetBrains, VS Code, and other editor integration notes.
• Agent Backends - Claude, Codex, OpenCode, and direct harness behavior.

Reference

• Specification - includes the root functional specification.
• Flow Map - FlowCore ownership map and typed event migration plan.
• Active Turn Lifecycle And Replay Paths
  • generated diagrams for active turns, route readiness, prompt ownership, stale cache/conflict replay, and late fallback replay.
• IPC - editor IPC architecture and fallback behavior.
• Full-Document IPC Corruption Chain
  • separate Mermaid logic chain for repeated full-document IPC corruption and the end-to-end disabled path.
• Prompt Duplicate Closeout Repair
  • Mermaid process diagram for the disabled full-content IPC path and duplicate-prompt closeout repair.
• Race Condition Analysis - concurrency hazards and mitigations.
• Reactive Stream - reactive stream notes.
• Changelog - version history.

Specs

The canonical spec entry point is SPEC.md. Split specs live under specs/ for focused review:

• Overview
• Document Format
• Snapshot System
• Diff Computation
• Agent Backend
• Config
• Commands
• Core Commands
• Closeout Commands
• Orchestration Commands
• Session Tmux Commands
• Session Routing
• Session Actor Contract
• Git Integration
• Security
• Debounce
• Deterministic Simulation
• State Backbone
• Pending System
• Supervisor
• Codex Support

Development

• Building
• Conventions
• Editor specs
• VS Code README
• JetBrains spec

Examples And Ontology

• Example session docs
• Ontology README

PRDs

No PRD or product-requirements documents are currently present in this repo. When PRDs are added, link them from this section and keep this README as the documentation entry point.