Skip to content

refactor(contracts): compact Architecture Documentation and Crosscutting Concepts#487

Merged
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:refactor/compact-architecture-contracts
May 16, 2026
Merged

refactor(contracts): compact Architecture Documentation and Crosscutting Concepts#487
rdmueller merged 1 commit into
LLM-Coding:mainfrom
raifdmueller:refactor/compact-architecture-contracts

Conversation

@raifdmueller
Copy link
Copy Markdown
Contributor

@raifdmueller raifdmueller commented May 16, 2026

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-diagrams and pugh-matrix anchors already carry. That bloat works against the anchor approach.

Both architecture contracts are trimmed to name the anchor + the project-specific decision only:

  • Architecture Documentation: dropped the C4 stereotype explanation and the per-chapter diagram enumeration; kept the actual choices — C4-PlantUML library not generic boxes, PlantUML not Mermaid, AsciiDoc format, "Accepted (inferred)" ADR status.
  • Crosscutting Concepts: dropped the per-concept content lists; kept the project's five-concept baseline and the T-ID traceability rule.
  • The § 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 build succeeds; both contracts render in dist/contracts/index.html
  • llms.txt lists all 14 contracts with the compacted templates
  • On the live /contracts page both cards read tight, no § symbols

🤖 Generated with Claude Code

Summary by CodeRabbit

Release Notes

  • Documentation
    • Präzisierte arc42-Dokumentationsstruktur mit allen 12 Kapiteln und AsciiDoc-Standard.
    • Aktualisierte Anforderungen für Diagramme (PlantUML und C4-Modelle).
    • Überarbeitete ADR-Standards mit Pugh-Matrix und Kennzeichnung von Entscheidungen.
    • Definierte fünf Basis-Konzepte für Crosscutting Concerns (Threat Model, Security, Test, Observability, Error Handling).

Review Change Stack

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

coderabbitai Bot commented May 16, 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: b0afe17d-308e-4592-bdb5-30cd012c3d48

📥 Commits

Reviewing files that changed from the base of the PR and between abe0ed9 and 432a3e5.

📒 Files selected for processing (2)
  • website/public/data/contracts.json
  • website/public/llms.txt

Walkthrough

Die PR präzisiert zwei Architecture Contracts in den Dateien contracts.json und llms.txt: Der architecture-documentation-Contract wird konkretisiert (arc42, AsciiDoc, PlantUML/C4-PlantUML, ADR/Pugh-Matrix), der crosscutting-concepts-Contract auf fünf Basis-Konzepte mit Traceability-Anforderungen neu definiert.

Changes

Contract-Definitionen für Architektur-Dokumentation

Layer / File(s) Zusammenfassung
Architecture-Documentation Contract
website/public/data/contracts.json, website/public/llms.txt
Contract-Template wird präzisiert: arc42 mit allen 12 Kapiteln, AsciiDoc als Docs-as-Code-Standard, PlantUML + C4-PlantUML für Diagramme fest vorgeschrieben, Nygard-ADRs mit Pugh-Matrix für Entscheidungen, Kennzeichnung von „Accepted (inferred)" und ? für nicht bestätigte Team-Urteile, Verweis auf separaten Crosscutting-Concepts-Contract.
Crosscutting-Concepts Contract
website/public/data/contracts.json, website/public/llms.txt
Contract wird auf „arc42 Chapter 8" umgestellt und auf fünf Basis-Konzepte in fester Reihenfolge definiert: Threat Model (STRIDE + Threat-IDs), Security (Mitigationen mit T-ID-Referenzen), Test (Pyramid + Traceability), Observability (Logs/Metrics/Traces/Audit), Error Handling (Patterns); zusätzliche 8.x-Konzepte nur bei System-Relevanz.

Possibly related PRs

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 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änderung des Pull Requests präzise: zwei Contract-Templates werden komprimiert/refaktoriert.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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

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 1ccda4a into LLM-Coding:main May 16, 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