You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(examples): reorganise gallery by maturity tier (G2) (#87)
Wires up Track G2 from the v1.6.5→1.7 readiness taskboard.
examples/README.md previously grouped the 26 examples by the
GraphCompose release that introduced them (Built-in templates /
Cinematic v1.5 / v1.5 feature showcases / v1.6 feature showcases /
Public-API surface / Production patterns / Operational documents).
That layout is useful as a release history but unhelpful for someone
landing on the examples folder for the first time who needs to know
"which one do I read first" or "is this still recommended for new
code".
The gallery now categorises by maturity / intent, in five tiers with
the legend block introduced at the section header:
🚀 Start here — minimum-friction entry points
🧱 Core DSL — daily-driver features
📋 Templates recommended — v2 / layered template surfaces
🔧 Advanced SPI — production patterns + specialty SPIs
🗄️ Legacy — pre-rebuild surface, do not start new code
Tier counts: 🚀 4 · 🧱 6 · 📋 4 · 🔧 8 · 🗄️ 4 = 26 examples
(unchanged from before — no examples added or removed).
All anchor IDs (#cv-single-template, #invoice-cinematic-v2, etc.)
are preserved verbatim, so existing deep links from the canonical
README, ADRs, and external sources continue to resolve. Only the
gallery index is restructured; the detailed sections below the
gallery are untouched.
The 🗄️ Legacy tier description links to docs/templates/which-template-system.md
(from G1) for the V1 → V2 migration path, so the two onboarding-clarity
PRs cross-link naturally.
Verification:
- ./mvnw -B -ntp test -pl . -Dtest='CanonicalSurfaceGuardTest,DocumentationCoverageTest,DocumentationExamplesTest,VersionConsistencyGuardTest'
-> 30 tests, 0 failures
- ./mvnw -B -ntp -f examples/pom.xml clean compile
-> BUILD SUCCESS (5.2s)
CHANGELOG entry added to v1.6.6 — Planned under the existing
### Documentation subsection (alongside the G1 entry).
Copy file name to clipboardExpand all lines: examples/README.md
+37-36Lines changed: 37 additions & 36 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,68 +32,69 @@ Then run all 26 examples in one shot:
32
32
Generated PDFs land in `examples/target/generated-pdfs/`. The same
33
33
`mvnw.cmd` form works on Windows PowerShell with backslash paths.
34
34
35
-
## Gallery
35
+
## Gallery — pick by your goal
36
36
37
-
### Built-in document templates
37
+
Examples are categorised by **maturity / intent**, not by the GraphCompose
38
+
release that introduced them. Pick the row that matches how far along you
39
+
are with the canonical DSL, then jump to its detailed section below.
38
40
39
-
| Example | What it shows | Preview · Source |
40
-
|---|---|---|
41
-
|[Cover Letter](#cover-letter)| One-page `BusinessTheme.modern()` cover letter with section presets |[PDF](../assets/readme/examples/cover-letter.pdf) · [Source](src/main/java/com/demcha/examples/templates/coverletter/CoverLetterFileExample.java)|
42
-
|[Invoice (V1)](#invoice-v1)|`InvoiceTemplateV1` driven from `InvoiceDocumentSpec`|[PDF](../assets/readme/examples/invoice.pdf) · [Source](src/main/java/com/demcha/examples/templates/invoice/InvoiceFileExample.java)|
43
-
|[Proposal (V1)](#proposal-v1)|`ProposalTemplateV1` driven from `ProposalDocumentSpec`|[PDF](../assets/readme/examples/proposal.pdf) · [Source](src/main/java/com/demcha/examples/templates/proposal/ProposalFileExample.java)|
44
-
|[Module-first Profile](#module-first-profile)| Authoring directly against `DocumentSession.module(...).paragraph(...)`|[PDF](../assets/readme/examples/module-first-profile.pdf) · [Source](src/main/java/com/demcha/examples/flagships/ModuleFirstFileExample.java)|
45
-
|[CV — single template](#cv-single-template)| One CV via `ModernProfessional.create(BusinessTheme.modern())` (Templates v2) |[PDF](../assets/readme/examples/cv-modern-professional.pdf) · [Source](src/main/java/com/demcha/examples/templates/cv/CvFileExample.java)|
46
-
|[CV — template gallery](#cv-template-gallery)| All 14 v2 CV presets in one orchestrated run |[Source](src/main/java/com/demcha/examples/templates/cv/CvTemplateGalleryFileExample.java)|
47
-
|[Cover letter — template gallery](#cover-letter-template-gallery)| All 14 paired v2 cover-letter presets in one orchestrated run |[Source](src/main/java/com/demcha/examples/templates/coverletter/CoverLetterTemplateGalleryFileExample.java)|
|[Handcrafted Proposal](#handcrafted-proposal)| v1.4-style cinematic proposal composed by hand |[PDF](../assets/readme/examples/project-proposal-cinematic.pdf) · [Source](src/main/java/com/demcha/examples/templates/proposal/CinematicProposalFileExample.java)|
41
+
> **Maturity legend.**
42
+
> 🚀 **Start here** — minimum-friction entry points; pick one if you've never used the canonical DSL before.
43
+
> 🧱 **Core DSL** — features you'll author against every day once the basics click.
44
+
> 📋 **Templates recommended** — the v2 / layered template surfaces and how to drive them; pick when you want a one-line CV / invoice / proposal / cover-letter.
> 🗄️ **Legacy** — pre-rebuild examples kept for downstream callers still on V1; do not start new code here. See [`docs/templates/which-template-system.md`](../docs/templates/which-template-system.md) for the V1 → V2 migration path.
56
47
57
-
### v1.5 feature showcases
48
+
### 🚀 Start here
58
49
59
50
| Example | What it shows | Preview · Source |
60
51
|---|---|---|
61
-
|[Shape containers](#shape-containers)|Circles, ellipses, rounded cards with `ClipPolicy.CLIP_PATH`|[PDF](../assets/readme/examples/shape-container.pdf) · [Source](src/main/java/com/demcha/examples/features/shapes/ShapeContainerExample.java)|
62
-
|[Transforms](#transforms)|`rotate`, `scale`, and per-layer `zIndex` swap |[PDF](../assets/readme/examples/transforms.pdf) · [Source](src/main/java/com/demcha/examples/features/transforms/TransformsExample.java)|
|[CV — template gallery](#cv-template-gallery)|All 14 v2 CV presets in one orchestrated run |[Source](src/main/java/com/demcha/examples/templates/cv/CvTemplateGalleryFileExample.java)|
73
+
|[Cover letter — template gallery](#cover-letter-template-gallery)|All 14 paired v2 cover-letter presets in one orchestrated run |[Source](src/main/java/com/demcha/examples/templates/coverletter/CoverLetterTemplateGalleryFileExample.java)|
|[Weekly schedule](#weekly-schedule)| Bar / restaurant shift schedule via reusable `WeeklyScheduleRenderer` with typed `DayShift` API |[PDF](../assets/readme/examples/weekly-schedule.pdf) · [Source](src/main/java/com/demcha/examples/templates/schedule/WeeklyScheduleFileExample.java)|
|[Invoice (V1)](#invoice-v1)|`InvoiceTemplateV1` driven from `InvoiceDocumentSpec` — pre-rebuild surface, supported only |[PDF](../assets/readme/examples/invoice.pdf) · [Source](src/main/java/com/demcha/examples/templates/invoice/InvoiceFileExample.java)|
95
+
|[Proposal (V1)](#proposal-v1)|`ProposalTemplateV1` driven from `ProposalDocumentSpec` — pre-rebuild surface, supported only |[PDF](../assets/readme/examples/proposal.pdf) · [Source](src/main/java/com/demcha/examples/templates/proposal/ProposalFileExample.java)|
96
+
|[Handcrafted Proposal](#handcrafted-proposal)| v1.4-style cinematic proposal composed by hand — pre-template authoring; kept for parity reference |[PDF](../assets/readme/examples/project-proposal-cinematic.pdf) · [Source](src/main/java/com/demcha/examples/templates/proposal/CinematicProposalFileExample.java)|
97
+
|[Weekly schedule](#weekly-schedule)| Bar / restaurant shift schedule via `WeeklyScheduleRenderer` (`WeeklyScheduleTemplateV1` — no V2 yet; will be re-shaped before 2.0) |[PDF](../assets/readme/examples/weekly-schedule.pdf) · [Source](src/main/java/com/demcha/examples/templates/schedule/WeeklyScheduleFileExample.java)|
0 commit comments