docs(templates): point template docs at the extracted templates.core#252
Merged
Conversation
Update the current template docs to the post-extraction names: the CV theme is BrandTheme in templates.core.theme, and the markdown/text helpers, header widgets, and shared widgets live under templates.core.*. - package-map: add core.theme/text/identity/widgets rows, fold the old widgets+decorations entries into one core.widgets row, note MarkdownText moved to core.text. - v2-layered guides, AUTHORS, which-template-system, api-stability, recipes, overview, CONTRIBUTING: CvTheme to BrandTheme, cv.v2.theme to core.theme, and corrected widget package homes. - coverletter package-info: the reused renderer is core.text.RichParagraphRenderer. Historical records (ADRs, CHANGELOG, migration guides) are left as point-in-time records.
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
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
An earlier set of refactors (#248–#251) moved the shared template layer into
templates.core.{theme,text,identity,widgets}, but the user-facing docs still named the oldcv.v2locations — a reader copy-pastingnew CvTheme(...)now hits a compile error.What
core.theme/core.text/core.identity/core.widgetsrows, folded the retiredwidgets+decorationsinto onecore.widgetsrow, notedMarkdownTextmoved tocore.text.CvTheme→BrandTheme,cv.v2.theme→core.theme, and corrected widget package homes (header widgets now incore.identity) across the v2-layered guides,cv/v2/AUTHORS.md,which-template-system,api-stability,recipes,overview,CONTRIBUTING.core.text.RichParagraphRenderer.Follow-up (separate docs PR): redraw the three ASCII layer diagrams (cv/v2 package-info, quickstart, AUTHORS) — they teach the composition flow (still accurate); only box labels/alignment need the core relabel.
Tests
./mvnw verify javadoc:javadoc -pl .→ BUILD SUCCESS, 1612 tests, 0 failures; render byte-identical (no snapshot updates); javadoc report clean.