docs(readme): announce v1.9.0 "navigable" + add the v1.8→v1.9 migration guide#254
Merged
Conversation
…ation guide - README "Release status" now names v1.9.0 (codename "navigable") as Latest stable, and the "What's new" section covers in-document navigation, the native TOC / page references / bookmarks, multi-section documents, the per-page-margin / bleed / row-layout additions, inline chips / SVG / emoji, and render-to-images. Install snippets stay at 1.8.0 (the release tooling flips them at cut time). - Add docs/roadmaps/migration-v1-8-to-v1-9.md — additive-only upgrade guide with a per-area TL;DR table, the one negative-margin behaviour note, the 2.0-bound shim deprecations, and the upgrade snippet. - Index the v1.8->v1.9 and the previously unlisted v1.7->v1.8 guides in docs/README.md.
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
1 participant
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.
Why
v1.9.0 — the in-progress release — had no release-facing docs yet. The README
"Release status" blockquote still advertised v1.8.0 ("illustrative") as the
latest stable; the release tooling does not touch that prose block (it only
flips the install snippets), so without this
mainwould keep rendering theprevious version as latest once v1.9.0 ships. There was also no
migration-v1-8-to-v1-9.md, while every prior minor (v1.4→…→v1.8) ships one,and
docs/README.mdhad stopped indexing the migration guides at v1.6→v1.7.What changed
"navigable") as Latest stable, and the "What's new" section is rewritten
for the navigation release: in-document anchors / internal links, the native
clickable TOC, page references, bookmarks, multi-section documents, per-page
margins / bleed / row layout, inline chips / SVG icons / colour emoji, and
render-to-images. Install snippets stay at 1.8.0 — the release tooling flips
them at cut time, and
VersionConsistencyGuardTestenforces README == pom.docs/roadmaps/migration-v1-8-to-v1-9.md(new) — additive-only upgradeguide: a per-area TL;DR table, the one negative-margin behaviour note, the
2.0-bound cover-letter / CV shim deprecations (informational, not breaking),
and the upgrade snippet.
docs/README.md— index the new v1.8→v1.9 guide, and the previouslyunlisted v1.7→v1.8 guide alongside it.
Verification
./mvnw -B -ntp test -pl . -Dtest=DocumentationCoverageTest,CanonicalSurfaceGuardTest,DocumentationExamplesTest,VersionConsistencyGuardTest→ BUILD SUCCESS, 31 green. No legacy tokens in the new prose; the README
install snippets stay consistent with the 1.8.0 pom; internal links resolve.
Docs-only change — no Java touched.
Lane: docs — v1.9.0 release-facing documentation (README status + what's-new,
migration guide, docs index).