Skip to content

Commit 26d0b79

Browse files
authored
Merge pull request #488 from raifdmueller/refactor/architecture-contract-tighten
refactor(contracts): tighten Architecture Documentation, stop bolding template body
2 parents 1ccda4a + a6eb238 commit 26d0b79

3 files changed

Lines changed: 6 additions & 10 deletions

File tree

website/public/data/contracts.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
"description": "How we document architecture with diagrams, ADRs, and decision evaluation",
2929
"descriptionDe": "Wie wir Architektur mit Diagrammen, ADRs und Entscheidungsbewertung dokumentieren",
3030
"anchors": ["arc42", "c4-diagrams", "adr-according-to-nygard", "pugh-matrix"],
31-
"template": "Architecture documentation follows arc42 — all 12 chapters, numbered as in arc42 (Chapter 3, Chapter 5.1).\n\nFormat is AsciiDoc, per the Docs-as-Code contract. Reverse-engineered use-case files and the entity model keep whatever format their source skill emits.\n\nEvery context, building-block and runtime chapter carries at least one diagram. Diagrams are PlantUML, not Mermaid; building blocks use C4 drawn with the C4-PlantUML library, not generic boxes.\n\nDecisions are ADRs (Nygard) with a Pugh Matrix. When the rationale is unconfirmed, ADR Status is \"Accepted (inferred)\" and Pugh cells needing team judgment are marked `?` rather than guessed.\n\nCrosscutting concepts (Chapter 8): see the \"Crosscutting Concepts\" contract.",
32-
"templateDe": "Architekturdokumentation folgt arc42 — alle 12 Kapitel, nummeriert wie in arc42 (Kapitel 3, Kapitel 5.1).\n\nFormat ist AsciiDoc, gemäß Docs-as-Code-Contract. Reverse-engineerte Use-Case-Dateien und das Entity Model behalten das Format, das ihre Quell-Skill erzeugt.\n\nJedes Kontext-, Baustein- und Laufzeit-Kapitel enthält mindestens ein Diagramm. Diagramme sind PlantUML, nicht Mermaid; Bausteine als C4, gezeichnet mit der C4-PlantUML-Bibliothek, nicht als generische Kästen.\n\nEntscheidungen sind ADRs (Nygard) mit Pugh-Matrix. Wenn die Begründung unbestätigt ist, lautet der ADR-Status \"Accepted (inferred)\", und Pugh-Zellen, die Team-Urteil erfordern, werden mit `?` markiert statt geraten.\n\nQuerschnittliche Konzepte (Kapitel 8): siehe Contract \"Crosscutting Concepts\".",
31+
"template": "Architecture documentation follows arc42.\n\nEvery context, building-block and runtime chapter carries at least one diagram. Diagrams are PlantUML, not Mermaid; building blocks use C4 with the C4-PlantUML standard library (local include, not the remote URL — Kroki cannot fetch it), not generic boxes.\n\nDecisions are ADRs (Nygard) with a 3-point Pugh Matrix (-1/0/+1). When the rationale is unconfirmed, ADR Status is \"Accepted (inferred)\" and Pugh cells needing team judgment are marked `?` rather than guessed.",
32+
"templateDe": "Architekturdokumentation folgt arc42.\n\nJedes Kontext-, Baustein- und Laufzeit-Kapitel enthält mindestens ein Diagramm. Diagramme sind PlantUML, nicht Mermaid; Bausteine als C4 mit der C4-PlantUML Standard Library (lokales Include, nicht die Remote-URL — Kroki kann sie nicht laden), nicht als generische Kästen.\n\nEntscheidungen sind ADRs (Nygard) mit einer 3-Punkt-Pugh-Matrix (-1/0/+1). Wenn die Begründung unbestätigt ist, lautet der ADR-Status \"Accepted (inferred)\", und Pugh-Zellen, die Team-Urteil erfordern, werden mit `?` markiert statt geraten.",
3333
"category": "architecture"
3434
},
3535
{

website/public/llms.txt

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5657,15 +5657,11 @@ Clarify requirements using the Socratic Method:
56575657

56585658
## Architecture Documentation
56595659

5660-
Architecture documentation follows arc42 — all 12 chapters, numbered as in arc42 (Chapter 3, Chapter 5.1).
5660+
Architecture documentation follows arc42.
56615661

5662-
Format is AsciiDoc, per the Docs-as-Code contract. Reverse-engineered use-case files and the entity model keep whatever format their source skill emits.
5662+
Every context, building-block and runtime chapter carries at least one diagram. Diagrams are PlantUML, not Mermaid; building blocks use C4 with the C4-PlantUML standard library (local include, not the remote URL — Kroki cannot fetch it), not generic boxes.
56635663

5664-
Every context, building-block and runtime chapter carries at least one diagram. Diagrams are PlantUML, not Mermaid; building blocks use C4 drawn with the C4-PlantUML library, not generic boxes.
5665-
5666-
Decisions are ADRs (Nygard) with a Pugh Matrix. When the rationale is unconfirmed, ADR Status is "Accepted (inferred)" and Pugh cells needing team judgment are marked `?` rather than guessed.
5667-
5668-
Crosscutting concepts (Chapter 8): see the "Crosscutting Concepts" contract.
5664+
Decisions are ADRs (Nygard) with a 3-point Pugh Matrix (-1/0/+1). When the rationale is unconfirmed, ADR Status is "Accepted (inferred)" and Pugh cells needing team judgment are marked `?` rather than guessed.
56695665

56705666
*Referenced anchors: arc42, c4-diagrams, adr-according-to-nygard, pugh-matrix*
56715667

website/src/components/contracts-page.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ function renderContractCard(contract, isSelected) {
109109
if (line.startsWith('- ')) {
110110
return `<span class="text-[var(--color-text-secondary)]">• ${esc(line.slice(2))}</span>`
111111
}
112-
return `<span class="font-medium">${esc(line)}</span>`
112+
return `<span>${esc(line)}</span>`
113113
})
114114
.join('<br>')
115115

0 commit comments

Comments
 (0)