4.4: add Architecture Doc Generator (closes #99) #273

Open
Rockachopa wants to merge 1 commits from step35/99-4-4-architecture-doc-generat into main
Owner

Implements the Architecture Doc Generator per acceptance criteria:

  • Maps module dependencies: Detects intra-repo Python imports and produces dependency table
  • Identifies entry points: Scans for if __name__ == '__main__' guards and executable scripts
  • Generates architecture diagram (ASCII): Box-and-arrow ASCII diagram included in ARCHITECTURE.md
  • 1 per repo: Generator produces ARCHITECTURE.md at repo root; script is reusable across repos

New files:

  • scripts/architecture_doc_generator.py — standalone, no deps beyond stdlib
  • ARCHITECTURE.md — generated for this repo (42 modules, 35 entry points, 13 edges)

Validation: python3 scripts/architecture_doc_generator.py runs clean and produces non-empty output.

Closes #99

Implements the Architecture Doc Generator per acceptance criteria: - Maps module dependencies: Detects intra-repo Python imports and produces dependency table - Identifies entry points: Scans for `if __name__ == '__main__'` guards and executable scripts - Generates architecture diagram (ASCII): Box-and-arrow ASCII diagram included in ARCHITECTURE.md - 1 per repo: Generator produces ARCHITECTURE.md at repo root; script is reusable across repos New files: - `scripts/architecture_doc_generator.py` — standalone, no deps beyond stdlib - `ARCHITECTURE.md` — generated for this repo (42 modules, 35 entry points, 13 edges) Validation: `python3 scripts/architecture_doc_generator.py` runs clean and produces non-empty output. Closes #99
Rockachopa added 1 commit 2026-04-26 16:20:41 +00:00
4.4: add Architecture Doc Generator
Some checks failed
Test / pytest (pull_request) Failing after 8s
3e6882b3ac
- Maps module dependencies within the repo by scanning Python imports
- Identifies entry points (scripts with __main__ guard)
- Generates ASCII diagram showing module relationships
- Produces ARCHITECTURE.md per repo

Implements acceptance criteria for issue #99.

Generated: 42 modules scanned, 35 entry points, 13 dependency edges.
Smoke test: runs clean, produces non-empty ARCHITECTURE.md.

Closes #99
Owner

🛡️ Goblin Patrol Alert 🛡️

Hey brother — this PR has been idle for 6 days and is unassigned.

The goblin fleet has been notified. A goblin may claim this if it remains stale.

— Timmy Goblin Wizard King

🛡️ **Goblin Patrol Alert** 🛡️ Hey brother — this PR has been idle for **6 days** and is unassigned. The goblin fleet has been notified. A goblin may claim this if it remains stale. — Timmy Goblin Wizard King
Some checks failed
Test / pytest (pull_request) Failing after 8s
This pull request can be merged automatically.
This branch is out-of-date with the base branch
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin step35/99-4-4-architecture-doc-generat:step35/99-4-4-architecture-doc-generat
git checkout step35/99-4-4-architecture-doc-generat
Sign in to join this conversation.