Skip to content

refactor(contracts): tighten Architecture Documentation, stop bolding template body#488

Merged
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:refactor/architecture-contract-tighten
May 17, 2026
Merged

refactor(contracts): tighten Architecture Documentation, stop bolding template body#488
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:refactor/architecture-contract-tighten

Conversation

@raifdmueller
Copy link
Copy Markdown
Contributor

@raifdmueller raifdmueller commented May 17, 2026

Summary

Follow-up to #487, addressing a point-by-point review of the Architecture Documentation contract.

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 is redundant when that contract is selected, 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.

Bug fix — contracts-page.js: plain template lines were rendered with font-medium, so every non-bullet line looked semi-bold. Now rendered at normal weight.

Test plan

  • npm run build succeeds; contract renders in dist/contracts/index.html
  • On the live /contracts page the Architecture Documentation card reads as three tight paragraphs at normal weight

🤖 Generated with Claude Code

Summary by CodeRabbit

Versionshinweise

  • Dokumentation

    • Richtlinien für Architektur-Dokumentation überarbeitet und präzisiert
    • C4-Diagramme verwenden standardmäßig lokale PlantUML-Includes
    • ADR-Entscheidungsdokumentation mit standardisierter 3-Punkt-Pugh-Matrix (-1/0/+1)
  • Style

    • Template-Rendering für Text-Einträge optimiert

Review Change Stack

… 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>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 17, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: ee51af95-c89f-4ad8-9dd1-dce78ef7556a

📥 Commits

Reviewing files that changed from the base of the PR and between 1ccda4a and a6eb238.

📒 Files selected for processing (3)
  • website/public/data/contracts.json
  • website/public/llms.txt
  • website/src/components/contracts-page.js

Walkthrough

Die 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.

Changes

Architektur-Dokumentations-Vertragsverfeinerung

Layer / Datei(en) Zusammenfassung
Vertragsinhalte für C4-PlantUML und ADR/Pugh-Matrix
website/public/data/contracts.json, website/public/llms.txt
Die Vorlagen für architecture-documentation werden aktualisiert: C4-PlantUML nutzt explizit die Standard-Library via lokales Include, Architekturentscheidungen werden als ADRs mit 3-Punkt-Pugh-Matrix (-1/0/+1) spezifiziert. Anforderungen zu expliziter arc42-Kapitel-Nummerierung und AsciiDoc-Formatvertrag werden entfernt. Die Behandlung von „Accepted (inferred)" und ?-Markierungen bleibt bestehen.
Anpassung der Vertragskartenrendering
website/src/components/contracts-page.js
Nicht-Listen-Zeilen in Vertragsvorlagen werden in einfache <span>-Elemente ohne font-medium-Klasse gerendert, während Listen-Zeilen unverändert bleiben.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • LLM-Coding/Semantic-Anchors#486: Beide PRs aktualisieren direkt die Vertragsvorlage architecture-documentation zur Verschärfung der C4-PlantUML-Nutzung (lokales !include) und ADR/Pugh-Matrix (-1/0/+1, „Accepted (inferred)" mit ?) in website/public/data/contracts.json.
  • LLM-Coding/Semantic-Anchors#369: Beide PRs aktualisieren die Vertragsvorlage architecture-documentation in website/public/data/contracts.json zur Verfeinerung der C4-PlantUML/ADR-Pugh-Matrix-Formulierungen und Include-Anleitung.
  • LLM-Coding/Semantic-Anchors#487: Beide PRs ändern die Inhalte des Vertrags architecture-documentation (C4-PlantUML-Bibliotheks-/Include-Regeln und ADR/Pugh-Matrix-Verhalten) in website/public/data/contracts.json und website/public/llms.txt.
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed Der Titel beschreibt die Hauptänderungen präzise: die Verbesserung der Architecture Documentation und das Entfernen der Fettformatierung im Template-Body. Er spiegelt beide signifikanten Änderungen der Changeset wider.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


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 and usage tips.

@rdmueller rdmueller merged commit 26d0b79 into LLM-Coding:main May 17, 2026
7 checks passed
Sign up for free to 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