Skip to content

{{PROJECT_NAME}} Documentation

Welcome to the official documentation for {{PROJECT_NAME}}.

Overview

{{PROJECT_NAME}} is built on top of the blueprint-repo-blueprints template, which provides a language-agnostic foundation for documentation, architecture decision records, and developer tooling.

Getting Started

Replace this section with project-specific setup instructions.

Project Structure

{{PROJECT_NAME}}/
├── meta/           # Development philosophy, ADRs, and plans
├── docs-src/       # Documentation source files (MkDocs)
├── scripts/        # Utility and automation scripts
└── .github/        # GitHub-specific configuration

Development Philosophy

All work in this project follows the Development Philosophy, which emphasizes:

  • Code is for Humans First — Clarity over cleverness
  • Favor Simplicity — Static-first design with minimal complexity
  • Confidence Through Testing — Comprehensive automated tests
  • Clean Commit History — Atomic commits with descriptive messages

Contributing

For information on contributing to this project, see the Contributing Guidelines.

Getting Help