Skip to content

Commit 82da792

Browse files
raifdmuellerclaude
authored andcommitted
docs: add C4 diagram rules and get_dependencies to CLAUDE.md
Add C4 quality rules learned from Simon Brown's review to ensure future diagram generation applies the rules proactively. Also add missing get_dependencies to MCP tools table. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent ab03bb3 commit 82da792

File tree

4 files changed

+15
-3
lines changed

4 files changed

+15
-3
lines changed

CLAUDE.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,5 +222,17 @@ Located in `src/docs/arc42/chapters/09_architecture_decisions.adoc`:
222222
| `update_section` | Update section content (with optimistic locking) |
223223
| `insert_content` | Insert content before/after sections |
224224

225+
| `get_dependencies` | Get include tree for AsciiDoc documents |
226+
225227
For detailed tool documentation, see `src/docs/50-user-manual/`.
226228

229+
## C4 Diagram Quality Rules
230+
231+
When creating or modifying C4 diagrams in arc42 docs:
232+
- File systems, databases are `ContainerDb` inside system boundary, NOT `System_Ext`
233+
- Component diagrams show internals of ONE container — keep consistent across diagrams
234+
- You can NOT zoom into components, only into containers
235+
- Use `LAYOUT_WITH_LEGEND()` consistently on all diagrams
236+
- Write abstraction type in Container_Boundary labels (e.g. `"MCP Server [Container: Python, FastMCP]"`)
237+
- Review checklist: https://c4model.com/review
238+

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "dacli"
3-
version = "0.4.34"
3+
version = "0.4.35"
44
description = "Documentation Access CLI - Navigate and query large documentation projects"
55
readme = "README.md"
66
license = { text = "MIT" }

src/dacli/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
"""
66

77

8-
__version__ = "0.4.34"
8+
__version__ = "0.4.35"

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)