Skip to content

Commit 07225be

Browse files
committed
docs: polish proof and generated output references in README
1 parent bc70588 commit 07225be

3 files changed

Lines changed: 17 additions & 14 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ and want boundaries that remain **visible and verifiable** as systems, teams, an
4040
* Maven 3.9+
4141
* macOS / Linux / WSL (the proof runner is a shell script)
4242

43-
> Goal: see **GREEN → RED → GREEN** using **build-time architecture guardrails**.
43+
> **Goal:** see **GREEN → RED → GREEN** using **build-time architecture guardrails (strict mode)**.
4444
>
4545
> No app startup required. Guardrails run during `mvn verify` and fail the build deterministically on boundary violations.
4646
@@ -80,7 +80,7 @@ CODEGEN_JAR="$(ls -1 ../../target/codegen-blueprint-*.jar | head -n 1)" ./proof/
8080
*`mvn verify` fails **deterministically** with a generated ArchUnit rule
8181
* ✅ The violation is reverted and the build returns to green
8282

83-
Full walkthrough (screenshots + exact failures):
83+
**Executable evidence bundle (screenshots, exact failures, and proof artifacts):**
8484

8585
👉 [Executable Architecture Proof](docs/demo/executable-architecture-proof.md)
8686

docs/demo/executable-architecture-proof.md

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This document provides an end-to-end **GREEN → RED → GREEN** proof that Code
99

1010
## Table of Contents
1111

12-
- [Fast Proof (Console-First)](#fast-proof-consolefirst)
12+
- [Fast Proof (Console-First)](#fast-proof-console-first)
1313
- [What this proves](#what-this-proves)
1414
- [Proof Flow (High-Level)](#proof-flow-highlevel)
1515
- [Proof Output (Persistent, Inspectable Artifacts)](#proof-output-persistent-inspectable-artifacts)
@@ -46,10 +46,10 @@ This document provides an end-to-end **GREEN → RED → GREEN** proof that Code
4646
- [Why this matters](#why-this-matters-1)
4747

4848

49-
## Fast Proof (ConsoleFirst)
49+
## Fast Proof (Console-First)
5050

51-
If you want to see the **GREEN → RED → GREEN** proof **purely via the console**
52-
no screenshots, no explanations, just deterministic build output — run:
51+
If you want to see the **GREEN → RED → GREEN** proof (**strict architecture guardrails**)
52+
**purely via the console**no screenshots, no explanations, just deterministic build output — run:
5353

5454
```bash
5555
# From the repository root
@@ -58,7 +58,8 @@ chmod +x ./proof/proof-runner.sh
5858
CODEGEN_JAR="$(ls -1 ../../target/codegen-blueprint-*.jar | head -n 1)" ./proof/proof-runner.sh
5959
```
6060

61-
The command exits with a **non‑zero code on any unexpected behavior** and prints a concise, step‑by‑step status to the console.
61+
The command exits with a **non-zero code on any contract violation or unexpected behavior**
62+
and prints a concise, step-by-step execution status to the console.
6263

6364
---
6465

@@ -182,7 +183,7 @@ The `proof-output` directory proves:
182183

183184
This transforms guardrails from:
184185

185-
*"trust me, it works"*
186+
*trust me, it works*
186187

187188
into:
188189

@@ -191,6 +192,7 @@ into:
191192
---
192193

193194
## Notes
195+
194196
* Each run is append‑only; older runs are preserved unless manually removed
195197
* For deeper inspection of generated projects, run with:
196198

@@ -201,16 +203,16 @@ KEEP_WORK_DIR=1 ./proof-runner.sh
201203
---
202204

203205
> This is not documentation.
204-
> This is not convention.
206+
> This is not a convention.
205207
>
206208
> **This is architecture enforced, evaluated, and proven at build time.**
207209
208210
---
209211

210212
## Why there is a detailed walkthrough below
211213

212-
The remainder of this document is the **high-resolution proof**
213-
the **human-readable version of the console-first proof**:
214+
The remainder of this document is the **highresolution proof**
215+
the **humanreadable version of the consolefirst proof**:
214216

215217
* screenshots of the generated structure
216218
* the exact minimal code change that introduces the violation *(same as the script injects)*
@@ -614,8 +616,9 @@ If you want to see what **actual projects generated by Codegen Blueprint look li
614616

615617
see:
616618

617-
**Generated Project README Previews**
618-
[Generated Readmes](./generated-readmes.md)
619+
* 📘 **Generated Project README Previews** — real, generated README outputs shipped with projects
620+
621+
[Generated Readmes](./generated-readmes.md)
619622

620623
These READMEs are **real generator output**, not examples.
621624

docs/policies/release-discipline.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -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 or introduce new architectural intent.
113+
> Patch releases may remove accidental loopholes; they do not redefine the intended contract or introduce new architectural intent.
114114
115115
---
116116

0 commit comments

Comments
 (0)