The documentation tree contains two different kinds of material:
- Product documentation — stable explanations of how to install, operate, and understand CSM.
- Engineering evidence — phase contracts, validation reports, migration notes, and generated repository artifacts.
Start with the product documentation. Use phase documents when you need design history or verification evidence.
| Document | Purpose |
|---|---|
| Main README | Product overview, quick start, database modes, and project status |
| AgentBook Version Control | Product boundary, current vertical slice, game-development profile, and evolution path |
| Feature Map | Complete subsystem and runtime tool inventory |
| Product Architecture | Stable runtime layers, write paths, read paths, and provider boundaries |
| Contributing | Development workflow, gates, migration rules, and PR expectations |
| Security | Vulnerability reporting and memory-system security considerations |
| Data Privacy and Lifecycle | Stored data, project isolation, retention, deletion, export, and encryption responsibilities |
| CSM Doctor and Troubleshooting | Safe installation diagnostics, common fixes, and support escalation bundle |
| Codex Installation | Direct MCP and marketplace installation paths, support limits, and live verification |
| Configuration Reliability | Strict configuration parsing, precedence, and failure behavior |
| Schema Support Matrix | Supported schema window and upgrade compatibility |
| Startup and Rollback | Atomic startup ownership and recovery behavior |
| Release Process | Artifact boundary, release gate, publishing, and rollback contract |
| Supply-Chain Security | Dependency, license, SBOM, secret-scan, attestation, and publishing controls |
The npm artifact intentionally ships the stable customer and operator documents above, not the full engineering archive. Phase contracts, benchmark outputs, migration notes, and closure evidence remain available in the source documentation tree. This keeps the customer package bounded while preserving public implementation history.
The following files are generated or maintained by the auto-documentation system:
ARCHITECTURE.mdSYSTEM_MAP.mdDECISIONS.mdRUNBOOK.mdCHANGELOG_LIVE.mdDEBUG_NOTES.mdAGENT_MEMORY.md
These files are useful for live repository operations, but they are not the canonical product overview. They may contain workspace-specific paths, snapshots, or recently captured source excerpts.
Use PRODUCT_ARCHITECTURE.md for the stable public architecture and the generated files for current operational evidence.
| Information | Canonical location |
|---|---|
| Product positioning and setup | README.md |
| Feature inventory | docs/FEATURES.md |
| Stable architecture | docs/PRODUCT_ARCHITECTURE.md |
| Development workflow | CONTRIBUTING.md |
| Security guidance | SECURITY.md |
| Current project state | AGENTBOOK_STATE.md |
| Historical implementation evidence | docs/PHASE*.md |
| Generated repository graph and operating notes | Generated operational documents |
When behavior changes, update the canonical product document and the relevant contract or evidence document in the same change.