fix(contracts): specify the bundled <C4/...> stdlib include for C4 diagrams#501
Merged
rdmueller merged 1 commit intoMay 17, 2026
Conversation
…agrams Closes LLM-Coding#500. The architecture-documentation contract said building blocks use C4 "with the C4-PlantUML standard library (local include …)". "Local include" was ambiguous: a recovery run read it as "vendor the C4-PlantUML files into the repo" and emitted !include c4/C4_Container.puml pointing at copies it never committed — unresolvable includes. There are three include forms; only one is intended: - !include https://... — remote fetch, Kroki cannot resolve it - !include c4/C4_Container.puml — vendored copies in the repo - !include <C4/C4_Container> — PlantUML's bundled stdlib, no repo files, no network — this is the one Contract now names the `!include <C4/...>` stdlib form (angle brackets) explicitly and rules out both the remote URL and vendored copies. template + templateDe updated; llms.txt regenerated. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Caution Review failedThe pull request is closed. ℹ️ 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 die Architecture-Documentation-Anforderungen für PlantUML C4-Diagramme. Die bisherige Formulierung "local include" wird durch die explizite Spezifikation des bundled-stdlib-Formats ChangesArchitecture Documentation Präzisierung
Geschätzter Aufwand🎯 1 (Trivial) | ⏱️ ~3 Minuten Möglicherweise verwandte PRs
✨ 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #500.
Problem
The
architecture-documentationcontract said building blocks use C4 "with the C4-PlantUML standard library (local include …)". "Local include" was ambiguous — in the Contracts5 experiment run a recovery agent read it as vendor the C4-PlantUML files into the repo and emitted!include c4/C4_Container.pumlpointing at copies it never committed, leaving unresolvable includes.Three include forms exist; only one is intended:
!include https://.../C4_Container.puml!include c4/C4_Container.puml!include <C4/C4_Container>Fix
The contract now names the
!include <C4/...>stdlib form (angle brackets) explicitly and rules out both the remote URL and vendored copies.template+templateDeupdated;llms.txtregenerated.Test plan
npm run buildsucceeds;/contractsrenders the updated cardllms.txtshows the new C4 wording🤖 Generated with Claude Code
Summary by CodeRabbit
Releasenotes