refactor(contracts): compact Architecture Documentation and Crosscutting Concepts#487
Conversation
…ing Concepts A contract composes anchors; it should not re-explain the methodology the anchor already triggers. The previous templates spelled out what C4 is (Person/System/Container/Component stereotypes), what each arc42 chapter contains, and the Pugh 3-point scale — all knowledge the arc42, c4-diagrams and pugh-matrix anchors already carry. That bloat works against the anchor approach. Both templates are trimmed to name the anchor plus the project-specific decision only: - C4 detail dropped; kept the actual choice — C4-PlantUML library, not generic boxes; PlantUML, not Mermaid. - Per-chapter diagram enumeration dropped; kept the rule that context, building-block and runtime chapters carry a diagram. - arc42 chapter content (what Chapter 8.x concepts mean) dropped; kept the project's five-concept baseline and the T-ID traceability rule. - The `§` notation note is gone — chapters are now referenced as "Chapter 3" / "Kapitel 3", so there is nothing to disambiguate. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
WalkthroughDie PR präzisiert zwei Architecture Contracts in den Dateien ChangesContract-Definitionen für Architektur-Dokumentation
Possibly related PRs
🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
Summary
A contract should compose anchors, not re-explain the methodology the anchor already triggers. The previous templates had drifted into mini-specs — spelling out C4 stereotypes, arc42 chapter content, and the Pugh 3-point scale, all knowledge the
arc42,c4-diagramsandpugh-matrixanchors already carry. That bloat works against the anchor approach.Both architecture contracts are trimmed to name the anchor + the project-specific decision only:
§notation note is gone entirely — chapters are now referenced as "Chapter 3" / "Kapitel 3", so there is nothing to disambiguate.Net: 30 lines removed, 18 added.
Test plan
npm run buildsucceeds; both contracts render indist/contracts/index.htmlllms.txtlists all 14 contracts with the compacted templates/contractspage both cards read tight, no§symbols🤖 Generated with Claude Code
Summary by CodeRabbit
Release Notes