docs(install): document the 2.0 module install matrix#306
Merged
Conversation
The 2.0 module split gives consumers several coordinates, but the docs still described the pre-split single artifact. Add a "which artifact?" matrix to the README install section — graph-compose for PDF out of the box (the 1.x default), graph-compose-bundle for batteries included, graph-compose-core for a lean bring-your-own-backend engine, and the opt-in templates / office backends — and explain that a bare graph-compose-core throws MissingBackendException until a render backend is on the classpath. Add a MissingBackendException entry to the troubleshooting guide, and a dependency callout to the layered-template guides (quickstart, using-templates, which-template-system) noting the presets ship in the opt-in graph-compose-templates artifact.
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 2.0 module split gives consumers several coordinates (
graph-compose,graph-compose-core, the render backends,graph-compose-templates,graph-compose-bundle), but the install docs still described the pre-split singleartifact — so a reader couldn't tell which one they need, and a lean-core user had no
pointer when rendering threw.
What
graph-composefor PDFout of the box (the 1.x default),
graph-compose-bundlefor batteries-included,graph-compose-corefor a lean bring-your-own-backend engine, and the opt-intemplates / DOCX / PPTX coordinates. The primary
graph-compose:2.0.0snippet stays theversion anchor; the matrix carries no per-module version literals (single source of truth).
MissingBackendExceptionentry — the lean-core failure mode(render without a backend), with the one-line fix.
quickstart,using-templates,which-template-system)gain a dependency callout: the presets ship in the opt-in
graph-compose-templatesartifact, not bundled in
graph-compose.Tests
CanonicalSurfaceGuardTest,DocumentationCoverageTest,PackageMapGuardTest,VersionConsistencyGuardTest, POI/PDF isolation) — 27 tests, 0failures. New relative links resolve; README carries no legacy-API tokens.