docs(readme): lead with v1.8, retire the v1.6 spotlight#214
Merged
Conversation
The README still centred on v1.6 while the v1.8 'illustrative' work (native charts, SVG, gradients) was buried in a single overlong release-status sentence, so the landing page lagged the engine. - Shrink the Release-status blurb to a one-liner that links to a new 'What's new in v1.8' section (chart preview + capability bullets, the fonts consumption change, and the ConfigLoader removal). - Replace 'What's in v1.6' / 'v1.6 primitives in 30 lines' with 'v1.8 primitives in 30 lines' — native chart, overshoot-free line, SVG import + block alignment, all lifted from runnable examples. - Correct the iText 7 comparison row: it has a high-level layout API, not just 'manual + helpers'. - Keep 'Cinematic by default' but ground it with the new primitives.
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
The README still centred on v1.6 — the v1.8 "illustrative" capabilities (native vector charts, SVG import, gradients) were buried in one overlong release-status sentence, so the landing page lagged the engine.
What
keepTogether()), the fonts consumption change, and theConfigLoaderremoval stated up front.v1.6 primitives in 30 lines→v1.8 primitives in 30 lines— native chart, overshoot-freeMONOTONEline, SVG import + block alignment. Snippets lifted from the runnable examples (ChartShowcaseExample,BlockAlignExample), not invented.Removes the
What's in v1.6release-history block (it lives in the CHANGELOG).Tests
DocumentationCoverageTest,CanonicalSurfaceGuardTest,DocumentationExamplesTest,VersionConsistencyGuardTest— 31 tests, 0 failures.assets/readme/chart-showcase.png), migration link, and the#whats-new-in-v18anchor all verified to resolve.