Skip to content

feat: add architecture diagram for docs/ARCHITECTURE.md (issue #118) - #165

Merged
ulises-jeremias merged 4 commits into
Create-Python-App:mainfrom
emberb170d:docs/architecture-diagram-issue-118
Aug 17, 2026
Merged

feat: add architecture diagram for docs/ARCHITECTURE.md (issue #118)#165
ulises-jeremias merged 4 commits into
Create-Python-App:mainfrom
emberb170d:docs/architecture-diagram-issue-118

Conversation

@emberb170d

@emberb170demberb170d commented Aug 9, 2026

Copy link
Copy Markdown
Contributor

Adds a mermaid architecture diagram showing the flow from CLI → templates.json → template + extensions merge → generated project. Addresses issue #118 (docs: add architecture diagram to docs/ARCHITECTURE.md).

Summary by CodeRabbit

  • Documentation

    • Added an architecture overview diagram describing the project generation workflow, including templates, extensions, Git setup, and dependency installation.
  • New Features

    • Standardized template formatting with shared editor configuration defaults.
    • Added Python 3.12 version settings across supported templates, helping ensure consistent development environments.

@coderabbitai

coderabbitaiBot commented Aug 9, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 4cdf9417-4929-4b53-8477-8b2e37bf2259

📥 Commits

Reviewing files that changed from the base of the PR and between 7d73b4a and f8a28b3.

📒 Files selected for processing (1)
  • docs/ARCHITECTURE.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • docs/ARCHITECTURE.md

📝 Walkthrough

Walkthrough

The PR adds shared editor settings to six templates and Python 3.12 pinning to five templates. It also adds an architecture diagram that documents template merging, project generation, Git initialization, and dependency installation.

Changes

Template standards and architecture

Layer / File(s)Summary
Template development defaults
templates/*/.editorconfig, templates/*/.python-version
Six templates add shared editor formatting rules. Five templates add Python 3.12 version files.
Architecture generation flow
docs/ARCHITECTURE.md
The architecture documentation adds a Mermaid flowchart for CLI input, registry resolution, template and extension merging, project creation, Git initialization, and dependency installation.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and concisely describes the main change: adding an architecture diagram to docs/ARCHITECTURE.md.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/ARCHITECTURE.md`:
- Around line 22-35: Update the Mermaid architecture diagram around the Git and
Install nodes to show their generation guards: indicate that Git initialization
is skipped when CPA_SKIP_GIT=1, and that uv sync requires pyproject.toml and is
skipped with --no-install. Keep the existing generation flow intact while making
both conditions visible on the relevant nodes or edges.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 32f070f9-960d-4b2a-adcd-ab4924cd521a

📥 Commits

Reviewing files that changed from the base of the PR and between 6986f9b and 7d73b4a.

📒 Files selected for processing (12)
  • docs/ARCHITECTURE.md
  • templates/celery-worker/.editorconfig
  • templates/celery-worker/.python-version
  • templates/cli-starter/.editorconfig
  • templates/cli-starter/.python-version
  • templates/django-api/.editorconfig
  • templates/django-api/.python-version
  • templates/fastapi-starter/.editorconfig
  • templates/fastapi-starter/.python-version
  • templates/mlops-sklearn-starter/.editorconfig
  • templates/mlops-sklearn-starter/.python-version
  • templates/uv-workspace-starter/.editorconfig

Comment threaddocs/ARCHITECTURE.md
Address CodeRabbit review feedback by showing:
- git init is skipped when CPA_SKIP_GIT=1
- uv sync requires pyproject.toml and is skipped with --no-install
Also added warm styling to conditional nodes for visual distinction.
@ulises-jeremias

Copy link
Copy Markdown
Member

The mermaid in ARCHITECTURE.md is enough for #118, but this PR is not merge-ready yet:

Please rebase onto current main, drop those already-merged files so the PR is diagram-only, restore a trailing newline on ARCHITECTURE.md if it disappeared, and let L1 re-run. Also retitle to docs: rather than feat:.

@ulises-jeremias
ulises-jeremias merged commit 005f616 into Create-Python-App:mainAug 17, 2026
52 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@emberb170d@ulises-jeremias