docs(examples): the catalogue stops calling current code legacy - #497
Conversation
Two examples sat under "🗄️ Legacy — pre-rebuild examples kept for downstream callers still on V1; do not start new code here", with a link to a V1 → V2 migration path. There is no V1. That surface was removed in 2.0 — docs/templates/which-template-system.md says so in its second sentence — both examples compile against the current DSL, and three hundred lines below the same file calls one of them a "useful starting point". The category is renamed to what those examples actually are: documents assembled from primitives, with no template behind them. The run instructions led with GenerateAllExamples, which empties the output directory and regenerates roughly a hundred documents. A reader following the page top to bottom paid for the whole catalogue before seeing a single example. Single-example first now, pointing at the Start-here table for which one to pick; the batch entry point sits below it, labelled as the way the committed previews and the showcase site are refreshed. Also removes the release labels the #491 sweep left behind — "v1.5 feature showcases", "v1.8 native vector charts", "the v1.9 book primitives", "byte-identical to v1.4" — and, in the recipe index, a 1.x migration guide that is still reachable from the documentation index's historical section. ./mvnw -B -ntp clean verify — BUILD SUCCESS, 692 tests in the closing module.
7242c90 to
06befc7
Compare
|
Both fixed, and both deserved the catch — a PR about instruction accuracy that shipped two inaccurate instructions in the run path is the worst place for them. 1. The class-name rule is now stated and proven. The text gives the derivation explicitly — drop 2. I left the
Head is now |
Why
Two entries in the example gallery sat under this heading:
There is no V1. docs/templates/which-template-system.md says in its second sentence that GraphCompose 2.0 ships no other template system, both examples compile against
2.1.1-SNAPSHOTon the current DSL, and three hundred lines below the same file describes one of them as a "useful starting point when your domain doesn't fit any built-in template". A reader looking for exactly that — hand-composed, no preset — was told not to start there.Separately, the run instructions led with
GenerateAllExamples. That is not a cheap first command: it is a hand-written list of a hundredgenerate()calls preceded byExampleOutputPaths.clean(), so a reader following the page in order emptied the output directory and rendered the whole catalogue before seeing one document.What changed
#handcrafted-proposaland#weekly-schedulesub-anchors are untouched, so nothing that links into the file breaks.ModuleFirstFileExample, a Start-here row), then the batch entry point below it, labelled as the way the committed previews and the showcase site get refreshed.## v1.5 feature showcases, "all v1.8 native vector charts", "the v1.9 book primitives", "byte-identical to v1.4", and "v1.5 cinematic features" in the intro. AlsoXxxTemplateV2, a wrapper name that never existed under that spelling and no longer exists under any.What I did not do
The recon for the previous PR noted that four Start-here rows (Engine Showcase, Engine Deck, Twin Output, Maven Central Banner) are bold labels rather than in-page links, unlike the four above them. That is not an oversight:
grep '^### 'shows those four examples have no detail section in the file to link to. Giving them anchors means writing four new sections, which is a different change from this one.Verification
./mvnw -B -ntp clean verify—BUILD SUCCESS, exit 0, 692 tests in the closing module.DocumentationSnippetCompileTest6 (this file carries 39 java fences, all still marked),CanonicalSurfaceGuardTest11 (every relative link resolves),DocumentationCoverageTest5.grep -n "v1\.[0-9]\|\bV1\b\|Legacy"overexamples/README.mdreturns nothing.One thing worth an eyeball rather than a test: the new pointer
[🚀 Start here](#-start-here)is the only link in the repository to an emoji heading, and no test validates in-page anchors —CanonicalSurfaceGuardTestskips#targets by design. The slug follows github-slugger's rule (emoji stripped, leading space becomes the leading hyphen), but the rendered page is the only place to confirm it.Lane: docs. No production code, no public API.