docs: add per-module READMEs#315
Merged
Merged
Conversation
Each published module (render-pdf / render-docx / render-pptx / templates / testing / the graph-compose wrapper / bundle / fonts / emoji) and the internal build modules (qa / aggregator) gets a README: what the artifact is, when to depend on it versus the alternatives, its key entry points, and links to the root install matrix and the modules migration guide. Coordinates are stated version-free so a module README never drifts from the release version.
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
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 2.0 split produced eleven module directories, but only
examples/andbenchmarks/had a README. A developer browsing
render-pdf/,templates/,bundle/, etc. on GitHub hadno per-folder explanation of what the artifact is or when to depend on it.
What
A README in each remaining module directory:
render-pdf,render-docx,render-pptx,templates,testing, thegraph-composewrapper,bundle,fonts,emoji— each states what the artifact is, whento depend on it versus the alternatives, its key entry point (with a real usage snippet), and
links back to the root install matrix + the modules migration guide.
qa,aggregator— marked "not published to Maven Central", with the reactorbuild command.
Coordinates are stated version-free (each links the root install matrix for the pinned
snippet), so
cut-release.ps1never has to touch these files and they can't drift.Tests
(
jarwrapper /pombundle), opt-in/bundling, the SPI registration, and each code snippet;it caught three snippet signature errors (
compose(session, spec),assertMatchesBaseline,the instance
RichText.text("").emoji(...)) which are fixed.