Skip to content

docs: dark manual twin + cross-linked documentation (release prep)#45

Merged
DemchaAV merged 1 commit into
developfrom
docs/release-prep
Jul 2, 2026
Merged

docs: dark manual twin + cross-linked documentation (release prep)#45
DemchaAV merged 1 commit into
developfrom
docs/release-prep

Conversation

@DemchaAV

@DemchaAV DemchaAV commented Jul 2, 2026

Copy link
Copy Markdown
Owner

Why

Release prep for 0.3.0: the manual needed its dark twin (the strongest reskin demo the repo can make — same source, one theme object swapped), and the docs guides didn't yet reference the manual or the new 0.3.0 surfaces.

What changed

  • manual-dark.pdf — the same manual.md through DefaultMarkdownTheme.dark() (6 pages, identical structure; footer now uses the theme's muted ink so it reads on both surfaces). ManualTest.darkManualComposer() pins it.
  • Docs interlinked: README links both manuals; architecture / theming / custom-renderers cross-link the manual; theming.md gains a FooterTokens page-chrome section; custom-renderers.md gains a renderer-swap section with the BookTocRenderer example.
  • CHANGELOG entry for the manual (light + dark) under [Unreleased].

Verification

./mvnw clean verifyBUILD SUCCESS, 181 tests, 0 failures. Dark page 1 visually confirmed: dark navy surface, light text, readable dot-leader contents with live page numbers, footer.

assets/readme/manual-dark.pdf renders the SAME manual.md through DefaultMarkdownTheme.dark() — one theme object swapped, whole document reskinned; the manual's closing section says so and ManualTest.darkManualComposer() pins it (same page count/structure as light, dark chrome intact). The footer now uses the theme's muted ink so it reads on both surfaces. Documentation is now interlinked for the release: README links both manuals; docs/{architecture,theming,custom-renderers}.md cross-link the manual; theming.md gains the FooterTokens page-chrome section; custom-renderers.md gains the renderer-swap section with the BookTocRenderer example. Suite green (181).
@DemchaAV DemchaAV merged commit 0818191 into develop Jul 2, 2026
4 checks passed
@DemchaAV DemchaAV deleted the docs/release-prep branch July 2, 2026 05:32
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