paver

PAVED docs for the AI agent era

Getting Started πŸš€

Get paver up and running in your project in under 5 minutes.

Installation πŸ“¦

# Build from source
cargo build --release

# Or install directly
cargo install --path .

Initialize Your Project 🎬

paver init

This creates a .paver.toml configuration file in your project root with sensible defaults.

Your First Document πŸ“

Create a component document:

paver new component my-service

This scaffolds docs/components/my-service.md with all the PAVED sections ready to fill in:

  • Purpose - What does this service do?
  • Interface - How do you use it?
  • Configuration - What settings are available?
  • Verification - How do you know it works?
  • Examples - Show me the code
  • Gotchas - What trips people up?
  • Decisions - Why these choices?

Generate an Index πŸ—ΊοΈ

Keep your docs navigable:

paver index

This scans your docs/ directory and generates docs/index.md with:

  • Quick links to top-level docs
  • Categorized sections (Components, Runbooks, ADRs)
  • Purpose summaries extracted from each doc

Validate Your Docs βœ…

Enforce quality rules:

paver check

This validates your documentation against configured rules:

  • Max line limits (default: 300)
  • Required sections (Verification, Examples)
  • PAVED structure compliance

Configuration βš™οΈ

View your config:

paver config list

Modify settings:

paver config set rules.max_lines 500

Next Steps 🎯