Skip to content

docs: add per-module READMEs#315

Merged
DemchaAV merged 1 commit into
2.0-devfrom
build/2.0-r1-module-readmes
Jul 6, 2026
Merged

docs: add per-module READMEs#315
DemchaAV merged 1 commit into
2.0-devfrom
build/2.0-r1-module-readmes

Conversation

@DemchaAV

@DemchaAV DemchaAV commented Jul 6, 2026

Copy link
Copy Markdown
Owner

Why

The 2.0 split produced eleven module directories, but only examples/ and benchmarks/
had a README. A developer browsing render-pdf/, templates/, bundle/, etc. on GitHub had
no per-folder explanation of what the artifact is or when to depend on it.

What

A README in each remaining module directory:

  • Published: render-pdf, render-docx, render-pptx, templates, testing, the
    graph-compose wrapper, bundle, fonts, emoji — each states what the artifact is, when
    to 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.
  • Internal: qa, aggregator — marked "not published to Maven Central", with the reactor
    build command.

Coordinates are stated version-free (each links the root install matrix for the pinned
snippet), so cut-release.ps1 never has to touch these files and they can't drift.

Tests

  • All relative links across the eleven files resolve (link-checker).
  • A cold fact-check verified every claim against the real poms/source — coordinates, packaging
    (jar wrapper / pom bundle), 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.

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.
@DemchaAV DemchaAV merged commit bb6f87a into 2.0-dev Jul 6, 2026
10 checks passed
@DemchaAV DemchaAV deleted the build/2.0-r1-module-readmes branch July 6, 2026 09:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant