Skip to content

Commit 86d7d01

Browse files
asq-sheriffclaude
andcommitted
docs: redesign Project Structure and Tool Stack diagrams for clarity
Project Structure: - Simplified to 3 clear subgraphs: Source, Tests, Config - Each file shows name and description on same node - Removed confusing edge labels connecting to parent Tool Stack: - Clear left-to-right flow from Code to all tools - Each tool in its own labeled subgraph with category icon - Tool features listed directly in nodes (bold name + descriptions) - Removed redundant edge labels 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <[email protected]>
1 parent b662370 commit 86d7d01

File tree

1 file changed

+40
-52
lines changed

1 file changed

+40
-52
lines changed

README.md

Lines changed: 40 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -65,33 +65,28 @@ flowchart LR
6565
### Project Structure
6666

6767
```mermaid
68-
flowchart TB
69-
subgraph ROOT["project_name/"]
70-
direction TB
71-
subgraph SRC["src/"]
72-
subgraph PKG["project_name/"]
73-
INIT["__init__.py"]
74-
MAIN["main.py"]
75-
CLI["my_cli.py"]
76-
RICH["rich_demo.py"]
77-
end
68+
graph LR
69+
subgraph Project["📁 project_name"]
70+
direction LR
71+
72+
subgraph Source["src/project_name/"]
73+
A["__init__.py<br/><i>Package init</i>"]
74+
B["main.py<br/><i>Core logic</i>"]
75+
C["my_cli.py<br/><i>CLI interface</i>"]
76+
D["rich_demo.py<br/><i>Terminal UI</i>"]
7877
end
79-
subgraph TESTS["tests/"]
80-
TEST["test_main.py"]
78+
79+
subgraph Tests["tests/"]
80+
E["test_main.py<br/><i>Test suite</i>"]
8181
end
82-
PYPROJ["pyproject.toml"]
83-
PRECOMMIT[".pre-commit-config.yaml"]
84-
README["README.md"]
85-
GITIGNORE[".gitignore"]
86-
end
8782
88-
INIT ---|Package initialization| PKG
89-
MAIN ---|Core application logic| PKG
90-
CLI ---|Typer CLI interface| PKG
91-
RICH ---|Rich terminal demos| PKG
92-
TEST ---|Pytest test suite| TESTS
93-
PYPROJ ---|Unified Python config| ROOT
94-
PRECOMMIT ---|Git hooks config| ROOT
83+
subgraph Config["Configuration"]
84+
F["pyproject.toml<br/><i>Project config</i>"]
85+
G[".pre-commit-config.yaml<br/><i>Git hooks</i>"]
86+
H[".gitignore"]
87+
I["README.md"]
88+
end
89+
end
9590
```
9691

9792
---
@@ -156,36 +151,29 @@ pre-commit install --install-hooks
156151
## 📦 Tool Stack
157152

158153
```mermaid
159-
flowchart TB
160-
subgraph TOOLCHAIN["Modern Python Toolchain"]
161-
direction LR
162-
subgraph LINT["Linting & Formatting"]
163-
RUFF[Ruff]
164-
end
165-
subgraph TYPE["Type Checking"]
166-
MYPY[Mypy]
167-
end
168-
subgraph TEST["Testing"]
169-
PYTEST[Pytest]
170-
end
171-
subgraph SEC["Security"]
172-
BANDIT[Bandit]
173-
end
154+
flowchart LR
155+
CODE[Your Python Code]
156+
157+
CODE --> RUFF
158+
CODE --> MYPY
159+
CODE --> PYTEST
160+
CODE --> BANDIT
161+
162+
subgraph Linting["🔍 Linting & Formatting"]
163+
RUFF["<b>Ruff</b><br/>Replaces Black + isort + Flake8<br/>10-100x faster"]
174164
end
175165
176-
RUFF ---|Replaces Black, isort, Flake8| LINT
177-
RUFF ---|10-100x faster| LINT
178-
MYPY ---|Strict mode enabled| TYPE
179-
MYPY ---|Full type inference| TYPE
180-
PYTEST ---|Async & coverage support| TEST
181-
PYTEST ---|Fixtures & parameterized| TEST
182-
BANDIT ---|SAST scanning| SEC
183-
BANDIT ---|OWASP compliance| SEC
184-
185-
CODE[Your Code] -->|lint & format| RUFF
186-
CODE -->|type check| MYPY
187-
CODE -->|test| PYTEST
188-
CODE -->|security scan| BANDIT
166+
subgraph Typing["🔷 Type Checking"]
167+
MYPY["<b>Mypy</b><br/>Strict mode<br/>Full type inference"]
168+
end
169+
170+
subgraph Testing["🧪 Testing"]
171+
PYTEST["<b>Pytest</b><br/>Async support<br/>Coverage reports"]
172+
end
173+
174+
subgraph Security["🔒 Security"]
175+
BANDIT["<b>Bandit</b><br/>SAST scanning<br/>OWASP compliance"]
176+
end
189177
```
190178

191179
---

0 commit comments

Comments
 (0)