docs: retire the classic template surface from the guides#286
Open
DemchaAV wants to merge 1 commit into
Open
Conversation
The 2.0 line removed the classic template presets, the built-in *Template classes, BusinessTheme, and the legacy PDF API, but the guides still described them as shipping and supported. Rewrite which-template-system.md as the naming history plus a migration map for pre-2.0 callers (classic presets -> same-named layered presets, built-ins -> ModernInvoice / ModernProposal, legacy PDF API -> canonical DSL); retier api-stability.md (the Supported and Legacy tiers hold no packages on the 2.0 line, the sealed-hierarchy examples re-anchor to CvSection, and the section-4 map lists the actual template packages); banner the v1-classic docs as archived; and update the README, docs index, v2-layered README, and examples README rows that still routed authors to the removed surface. The README's canonical-DSL fingerprint in DocumentationCoverageTest follows the hero snippet (BusinessTheme -> DocumentTextStyle). Tests: ./mvnw verify javadoc:javadoc -pl . — 1378 tests, 0 failures, javadoc clean.
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 line removed the classic template presets, the built-in
*Templateclasses,BusinessTheme, and the legacy PDF API — but the guides still described them as shipping, supported, and in places "recommended". Third 3-13 docs slice: the conceptual/ledger docs.What (9 files)
which-template-system.md— rewritten slim (238 → 130 lines): the naming history ("classic" / "Templates v2" / built-ins / legacy PDF API, all with their 2.0 fate) + a migration map for pre-2.0 callers — classic presets → same-named layered presets (full 16-row table kept), built-ins →ModernInvoice/ModernProposal, legacy PDF API → canonical DSL. Every named class/factory/package fact-checked against the tree by an independent pass.api-stability.md— §1 Supported + Legacy tiers reworded (no package holds them on the 2.0 line; policy definitions kept); §2 sealed examples re-anchored from the deletedBlock/TemplateModuleBlocktoCvSection(+ its post-rename path); §4 tier map rebuilt to the actual packages (templates.api/core/cv/coverletter/invoice/proposal/data).v1-classic/{README,authoring}.md— 🗄️ archived banners (removed in 2.0, kept for pre-2.0 callers, nothing below updated) replacing the false "still ships / neither is deprecated" notes.README.md— Templates section now leads with the layered surface + the migration map; retiredInvoiceTemplateV2mention →ModernInvoice. ZeroBusinessThemetokens remain, so theDocumentationCoverageTestREADME fingerprint follows the hero snippet (BusinessTheme→DocumentTextStyle).docs/README.md/v2-layered/README.md/examples/README.md— invoice/proposal author routing, "still ships, still supported", and the authoring-cheatsheet pointers fixed to the live surface.Follow-ups (next docs slice — bodies not touched here)
docs/templates/business-templates.md(whole body teaches the removed built-ins — flaggedcapabilities.md,getting-started.md,first-document.md,architecture/{overview,package-map}.md, contributing guides, and the examples/README invoice gallery prose. Also pre-existing: five public sealed types absent from the api-stability §2 list (DocumentPaint,DocumentPathSegment,DocumentLinkTarget,ChartSize,ChartSpec).Tests
./mvnw verify javadoc:javadoc -pl .— 1378 tests, 0 failures, javadoc clean (includes the updatedDocumentationCoverageTest). All links in touched docs verified to resolve (295 OK; the only broken ones are inside the archived v1-classic body, pointing at deleted source — covered by the archive banner).