Skip to content

Commit 7666315

Browse files
committed
docs: clarify GA guarantees, remove misleading production/runtime claims, and fix generated README formatting
1 parent 68a9596 commit 7666315

11 files changed

Lines changed: 39 additions & 32 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@
2626

2727
Codegen Blueprint exists for that exact moment: when architecture needs to become **observable**, not aspirational.
2828

29-
> If you’re looking for a fast scaffold, use Spring Initializr.
30-
> This is for teams who want architecture that stays **observable and executable** over time.
29+
> This separation keeps the core engine isolated from technology choices
30+
> and enables future stack expansion **without changing the engine’s architectural contract**.
3131
3232
---
3333

@@ -629,6 +629,8 @@ From Day Zero to Production — architecture stays **intentional**, **testable**
629629

630630
### 🧭 Roadmap Principles (Order Matters)
631631

632+
> This roadmap expresses direction and intent, not contractual guarantees.
633+
632634
Blueprint evolves in intentional layers to protect its core promise:
633635

634636
1. **Prove the contract** (determinism, guardrails, reproducible proof)

SECURITY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,6 @@ Severity determines prioritization and disclosure timing.
9090

9191
* Codegen Blueprint generator engine (domain, application, adapter)
9292
* CLI interface and option parsing
93-
* Generated architecture guardrails (e.g., ArchUnit tests/rules)
9493
* Templates, profiles, and build configuration produced by the generator
9594
* CI/CD configuration and repository automation
9695

docs/architecture/architecture-governance-and-ai-protocol.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,10 @@ Therefore:
5757

5858
Every non-trivial change follows this explicit sequence:
5959

60-
> **Skipping any step invalidates the change — regardless of test results.**
60+
> **Skipping any step makes the change not eligible for merge — regardless of test results.**
6161
62-
This protocol exists to ensure architectural intent survives beyond individual implementations.
62+
This protocol exists to ensure that architectural intent
63+
survives beyond individual implementations and tooling outcomes.
6364

6465
### 3.1 Intent
6566

@@ -135,20 +136,23 @@ This protocol exists to ensure architectural intent survives beyond individual i
135136

136137
## 5. Architecture Guardrails Philosophy
137138

138-
* Architecture guardrails are **opt-in**, never hidden
139-
* Guardrails rules are **generated**, not hard-wired
139+
Architecture guardrails exist to make architectural intent
140+
**visible and enforceable at build time**.
140141

141-
> Generated guardrails rules are platform-defined and centrally evolved,
142-
> while remaining visible and reviewable at the service level.
142+
They are:
143143

144-
Supported guardrails modes (explicitly selected at generation time):
144+
* **explicitly opt-in** — never implicit or hidden
145+
* **generated artifacts** — not hand-written conventions
146+
* **evaluated during the build** — not at runtime
147+
148+
Supported guardrails modes are selected explicitly at generation time:
145149

146150
* `none` — generation only
147-
* `basic` — structural & dependency guards
151+
* `basic` — structural and dependency boundaries
148152
* `strict` — architecture drift prevention
149153

150-
> Architecture guardrails must surface violations deterministically —
151-
> or they must not be claimed at all.
154+
> Guardrails are only claimed where violations
155+
> surface deterministically via the build.
152156
153157
---
154158

docs/architecture/architecture-guardrails-rulebook.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -615,11 +615,15 @@ Whether a project enables:
615615
is determined **explicitly by CLI flags and release-level defaults**,
616616
not by this document.
617617

618-
For **Codegen Blueprint 1.0.0 GA**:
618+
For **Codegen Blueprint 1.0.0 GA**, guardrails activation follows the
619+
**CLI contract and release notes**:
619620

620-
* The default guardrails mode is **`basic`**
621-
* **`strict`** guardrails are **explicitly opt-in**
622-
* No project is forced into strict enforcement unless explicitly requested
621+
* `basic` is the default mode unless explicitly overridden
622+
* `strict` is opt-in only
623+
* No project is forced into strict enforcement without an explicit request
624+
625+
> 📌 The authoritative source for defaults and activation behavior
626+
> is the **CLI contract and the release notes**, not this rulebook.
623627
624628
The **authoritative source** for:
625629

docs/architecture/executable-architecture-contract.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Anything not explicitly listed here is **out of scope** for 1.0.0 GA.
4848

4949
The engine today:
5050

51-
> Generates clean, production‑viable Spring Boot services with **architectureaware** and **testready** output.
51+
> Generates deterministic, build-verified Spring Boot projects with **architecture-aware** and **test-ready** output.
5252
5353
---
5454

@@ -311,4 +311,4 @@ Any change touching architecture must answer:
311311
* Architecture‑aware structure
312312
* Predictable foundations for evolution
313313

314-
> 🚀 **Executable Architecture becomes observable — and testable — here.**
314+
> **Executable Architecture becomes observable — and testable — here.**

docs/demo/executable-architecture-proof.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,9 +71,9 @@ This single command demonstrates — end to end — that Codegen Blueprint can:
7171
* fail the build **deterministically** when a boundary is violated
7272
* return to green immediately once the violation is removed
7373

74-
No app server run.
75-
No runtime checks.
76-
No custom test harness.
74+
No application run (no `spring-boot:run`, no `java -jar`).
75+
No runtime enforcement — guardrails are evaluated at build time.
76+
No custom test framework beyond standard JUnit + ArchUnit.
7777

7878
> **Architecture is evaluated by the build itself.**
7979
@@ -165,7 +165,7 @@ A machine‑readable and human‑readable execution ledger:
165165
* exact log and excerpt file references
166166
* final proof result
167167

168-
This file is the **contractual evidence** that the proof executed as intended.
168+
This file is the **primary evidence ledger** that the proof executed as intended.
169169

170170
---
171171

@@ -266,7 +266,7 @@ Specifically, it demonstrates that:
266266
* A style guide
267267

268268
No manual app server is started.
269-
The proof is driven by **`mvn verify`** (tests may start a Spring test context as part of the build — that is still build-time evaluation).
269+
The proof is driven by **`mvn verify`**
270270

271271
---
272272

docs/demo/generated/hexagonal/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ They provide **deterministic** feedback during:
131131
* Canonical vocabulary (generated contract surface):
132132
* `src/test/java/io/github/blueprintplatform/greeting/architecture/archunit/HexagonalGuardrailsScope.java`
133133
* Generated rules live under:
134-
* `src/test/java/io/github/blueprintplatform/greeting/architecture/archunit/`
134+
* `src/test/java/io/github/blueprintplatform/greeting/architecture/archunit/`
135135

136136
---
137137

docs/demo/generated/standard/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ They provide **deterministic** feedback during:
125125
* Canonical vocabulary (generated contract surface):
126126
* `src/test/java/io/github/blueprintplatform/greeting/architecture/archunit/StandardGuardrailsScope.java`
127127
* Generated rules live under:
128-
* `src/test/java/io/github/blueprintplatform/greeting/architecture/archunit/`
128+
* `src/test/java/io/github/blueprintplatform/greeting/architecture/archunit/`
129129

130130
---
131131

docs/policies/release-discipline.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Where:
5454

5555
## 1.0.0 — General Availability (GA)
5656

57-
Version **1.0.0** marks the point where Codegen Blueprint becomes a **stable product**, not an experiment.
57+
Version **1.0.0** marks the point where Codegen Blueprint becomes a **contractually stable product**, not an experiment.
5858

5959
From this version onward:
6060

@@ -110,7 +110,7 @@ If a project was generated under **1.0.0** and was valid under the GA contract,
110110
* A fix that corrects behavior that was **objectively incorrect, unsafe, or security-relevant**.
111111
* In rare cases, this can **tighten guardrails** when the previous behavior was a bug (e.g., a rule not being applied correctly).
112112

113-
> Patch releases may remove accidental loopholes; they do not redefine the intended contract.
113+
Patch releases may remove accidental loopholes; they do not redefine the intended contract or introduce new architectural intent.
114114

115115
---
116116

pom.xml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@
1515
<artifactId>codegen-blueprint</artifactId>
1616
<version>1.0.0</version>
1717
<name>codegen-blueprint</name>
18-
<description>Hexagonal, profile-driven blueprint engine for generating production-ready project scaffolding across
19-
frameworks and languages
20-
</description>
18+
<description>Architecture-first project generator for Spring Boot with build-time executable architecture guardrails.</description>
2119
<url>https://github.com/blueprint-platform/codegen-blueprint</url>
2220

2321
<licenses>

0 commit comments

Comments
 (0)