Overview

🚀Doc Gen Developer Guide

Contributor Guide

Extend project-tree analysis and Markdown generation while preserving deterministic, narrow output behavior.

Commandmake check

📦Category

Development

🚀Quick Command

setup -> focused change -> widening validation

---

Pythonpytestpre-commitoutput safety

---

Contributor priorities

structure print and structure analyze are read-only. structure generate may write only its resolved output document, while --dry-run may scan and render but must not create directories or files.

✨Development Boundaries

💻CLI

Keep parsing, option resolution, errors, and presentation under app/doc_gen/cli.

🏗️Structure Core

Keep scanning, profiles, smart mode, metadata, analysis, and generation under app/doc_gen/core/structure.

📄Render and Write

Keep Markdown rendering separate from persistence so dry-run cannot reach the writer.

🛡️Safety

Use temporary projects and assert that only the selected output can change.

---

Quality workflow

Install Doc Gen with its contributor dependencies, enable the repository hook, run the smallest affected test, and finish with make check plus applicable generation and dry-run regression coverage.

ℹ️Pre-commit is one quality layer

Hooks handle Ruff, formatting, whitespace, and newline policy. They do not replace output-boundary tests, complete pytest coverage, or applicable Docker, Compose, package, and documentation checks.

---

🚀Related Commands

Commands commonly used together with this command.

Development Setup

Install Doc Gen and its contributor tools.

Testing

Validate generation and read-only behavior.

Contributing

Prepare a focused Doc Gen change.

Architecture

Trace scanning, rendering, and persistence responsibilities.