DocBuilder Documentation

Technical documentation organized by the Diátaxis framework.

Structure

📚 Tutorials

Step-by-step learning guides:

• Getting Started

🛠️ How-To Guides

Task-oriented guides:

• Add Content Transforms
• Configure Forge Namespacing
• Configure Webhooks
• Customize Index Pages
• Enable Hugo Render
• Enable Multi-Version Docs
• Enable Page Transitions
• Prune Workspace Size
• Run Incremental Builds
• Setup Linting
• Use Relearn Theme
• Write Cross-Document Links

📖 Reference

Technical specifications:

• CLI Reference
• Configuration Reference
• Content Transforms
• Build Report Format
• Index File Handling
• Lint Rules

💡 Explanation

Architecture and design rationale:

• Architecture Documentation Index
• Comprehensive Architecture
• Architecture Diagrams
• Package Architecture
• Namespacing Rationale
• Skip Evaluation
• Renderer Testing
• Webhook Isolation

Architecture Decision Records

• ADR-000: Uniform Error Handling
• ADR-001: Golden Testing Strategy
• ADR-002: In-Memory Content Pipeline
• ADR-003: Fixed Transform Pipeline
• ADR-004: Forge-Specific Markdown
• ADR-005: Documentation Linting
• ADR-006: Drop Local Namespace
• ADR-007: Merge Generate Into Build

Quick Start

New Users:

1. Getting Started Tutorial
2. CLI Reference
3. Configuration Reference

Developers:

1. Architecture Documentation
2. Package Architecture
3. Contributing Guide

Operations:

1. Run Incremental Builds
2. Build Report Format
3. Configure Webhooks

Documentation Principles

This documentation follows these principles:

1. User-Centric - Organized by what users want to achieve
2. Progressive Disclosure - Start simple, add complexity as needed
3. Searchable - Clear structure, consistent terminology
4. Maintained - Updated with code changes
5. Tested - Examples are verified to work

Contributing to Documentation

We welcome documentation contributions! When contributing:

1. Follow the Diátaxis framework structure
2. Use clear, concise language
3. Include code examples where applicable
4. Test all commands and configurations
5. Update index files when adding new documents

See Contributing Guide for details.

Getting Help

• Questions: Open a GitHub Discussion
• Issues: Report bugs or feature requests via GitHub Issues
• Architecture Questions: Review Architecture Documentation first
• Usage Help: Start with Tutorials and How-To Guides

Documentation Status

Last Major Update: December 2025

Coverage:

• ✅ Getting Started Tutorial
• ✅ CLI Reference
• ✅ Configuration Reference
• ✅ Build Report Reference
• ✅ Comprehensive Architecture Documentation
• ✅ Package-Level Documentation
• ✅ Visual Architecture Diagrams
• ✅ How-To Guides
• ⏳ Additional tutorials (in progress)

Feedback: Documentation feedback is highly appreciated! Please open an issue if you find areas that need improvement.