The PMAT Book

Official comprehensive documentation for PMAT

📚 Read the Book Online | PMAT Repository

Table of Contents

• Features
• About
• Quick Start
• Book Structure
• Contributing
• Resources

Features

• 28 Chapters - Comprehensive coverage from installation to advanced usage
• TDD-Validated Examples - Every code example is tested and verified
• Real-World Tutorials - Practical guides for actual use cases
• Complete CLI Reference - Full documentation of all PMAT commands

About

This book provides comprehensive documentation for PMAT, covering:

• Installation and setup
• Core concepts and analysis capabilities
• MCP (Model Context Protocol) integration
• Technical Debt Grading (TDG) system
• Code similarity detection
• Real-world usage examples
• Advanced features and optimization

Building the Book

Prerequisites

• Rust and Cargo (for installing mdBook)
• Git

Quick Start

# Clone the repository
git clone https://github.com/paiml/pmat-book.git
cd pmat-book

# Install git hooks (RECOMMENDED to prevent 404 issues)
bash scripts/install-hooks.sh

# Install dependencies
make install-deps

# Build the book
make build

# Serve locally (opens in browser)
make serve

The book will be available at http://localhost:3000

Important: The git hook warns you about unpushed commits that would cause the live book at https://paiml.github.io/pmat-book/ to be out of date. Always push your commits after committing!

Available Commands

make help          # Show all available commands
make build         # Build the book
make serve         # Serve with auto-reload
make clean         # Remove build artifacts
make validate      # Run quality checks
make test          # Test code examples (when implemented)

Book Structure

src/
├── SUMMARY.md                # Table of contents
├── title-page.md            # Title page
├── foreword.md              # Foreword
├── introduction.md          # Introduction
├── ch01-*.md               # Installation and setup
├── ch02-*.md               # Core concepts
├── ch03-*.md               # MCP integration
├── ch04-*.md               # Advanced features
├── ch05-*.md               # CLI mastery
├── ch06-*.md               # Real-world examples
├── ch07-*.md               # Architecture patterns
├── ch08-*.md               # Performance and scale
├── appendix-*.md           # Reference materials
└── conclusion.md           # Conclusion

Contributing

Contributions are welcome! Please ensure:

1. All code examples are tested and working
2. Chapter status blocks are updated
3. Run make validate before submitting

Status

The book is currently in active development. Chapters marked as "✅ Working" are production-ready.

Resources

• PMAT GitHub Repository
• Pragmatic AI Labs
• MCP Documentation

License

MIT License - See LICENSE file for details