docs(readme): add a repository module map#368
Merged
Conversation
The README explained which artifact to depend on but not how the repository itself is organised. Add a Modules subsection under Architecture: the published Maven Central coordinates (engine in core/, render backends, templates, testing, the graph-compose wrapper + bundle), the independently-versioned fonts/emoji companions, and the development-only modules (qa, coverage, examples, benchmarks), plus the one-line build story — root pom is the reactor aggregator, ./mvnw clean verify builds every module, -pl :<artifactId> scopes to one.
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's Installation section answers "which artifact do I depend on" (the consumer
"which artifact?" table), but nothing in the README explains how the repository is
organised — which modules exist, which are published vs internal, and how to build the whole
thing. A newcomer had to open CONTRIBUTING or the poms to find out.
What
A compact Modules subsection under
## Architecture(complementary to the consumer table,which answers a different question):
graph-compose-core(incore/), the render backends,graph-compose-templates,graph-compose-testing, and thegraph-composewrapper +graph-compose-bundle.graph-compose-fonts,graph-compose-emoji.qa,coverage,examples,benchmarks../mvnw clean verifybuilds everymodule,
-pl :<artifactId>scopes to one.Links to CONTRIBUTING for the branch-routing table + full flow (no duplication — CONTRIBUTING owns
routing and the gate).
Docs-only; no build or runtime change.
Tests
CanonicalSurfaceGuardTest,DocumentationCoverageTest,VersionConsistencyGuardTest(READMEinstall-snippet version),
PackageMapGuardTest— all green. Install snippets untouched.