refactor(contracts): tighten Architecture Documentation, stop bolding template body#488
Conversation
… template body Architecture Documentation contract: - Drop "all 12 chapters, numbered as in arc42" — the arc42 anchor already carries the chapter structure and numbering. - Drop the AsciiDoc/format line — the Docs-as-Code contract sets the format; restating it here is redundant when that contract is selected and inconsistent when it is not. - Drop the Chapter 8 cross-reference — redundant when the Crosscutting Concepts contract is selected, a dangling pointer when it is not. - Name the C4-PlantUML standard library explicitly with a local include (not the remote URL, which Kroki cannot fetch). - State the Pugh scale as 3-point (-1/0/+1) — a genuine project choice, since Pugh matrices also come in -2..+2 and weighted variants. contracts-page.js: plain template lines were rendered with font-medium, making every non-bullet line look semi-bold. Render them at normal weight. 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 (3)
WalkthroughDie Verträge für Architektur-Dokumentation werden aktualisiert, um C4-PlantUML mit lokalem Standard-Library-Include und ADRs mit 3-Punkt-Pugh-Matrix (-1/0/+1) explizit zu spezifizieren. Die Rendering-Komponente wird angepasst, um diese Vorlagen ohne Medium-Font-Gewicht für reguläre Zeilen anzuzeigen. ChangesArchitektur-Dokumentations-Vertragsverfeinerung
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint skipped: no ESLint configuration detected in root package.json. To enable, add 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
Follow-up to #487, addressing a point-by-point review of the Architecture Documentation contract.
Architecture Documentation contract:
arc42anchor already carries the chapter structure and numbering.Bug fix —
contracts-page.js: plain template lines were rendered withfont-medium, so every non-bullet line looked semi-bold. Now rendered at normal weight.Test plan
npm run buildsucceeds; contract renders indist/contracts/index.html/contractspage the Architecture Documentation card reads as three tight paragraphs at normal weight🤖 Generated with Claude Code
Summary by CodeRabbit
Versionshinweise
Dokumentation
Style