Documentation Index
Start here. This is your map to all documentation.
Quick Links
Components
| Component | Purpose |
|---|---|
| Code Mapping | Code mapping links documentation to source code files via the ## Paths section. |
| Configuration | The configuration system manages pave’s .pave.toml file, which controls documentation paths, validation rules, and template settings. |
| Pave CLI | Pave is a command-line tool for creating, validating, and managing PAVED documentation. |
| Prompt Generation | The prompt generation system creates structured prompts for AI agents to produce PAVED-compliant documentation. |
| Templates | The templates system provides scaffolding for new PAVED documents. |
| Validation Engine | The validation engine parses markdown files into a structured form and validates them against configurable rules from the PAVED framework. |
| Verification | The verification system extracts and executes commands from the ## Verification section of PAVED documents. |
Runbooks
- Runbook: Adding a New CLI Command to Pave
- Runbook: Onboard Existing Project to Pave
- Runbook: Release Pave
- Runbook: Update Pave Documentation
Architecture Decisions
- ADR: Dogfooding Pave for Self-Compliance
- ADR: Use PAVED Framework for Documentation
- ADR: Use Rust for Implementation
Generated by pave. Last updated: 2026-01-18