Skip to content

docs(templates): point template docs at the extracted templates.core#252

Merged
DemchaAV merged 1 commit into
2.0-devfrom
docs/templates-core-refresh
Jun 28, 2026
Merged

docs(templates): point template docs at the extracted templates.core#252
DemchaAV merged 1 commit into
2.0-devfrom
docs/templates-core-refresh

Conversation

@DemchaAV

Copy link
Copy Markdown
Owner

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 old cv.v2 locations — a reader copy-pasting new CvTheme(...) now hits a compile error.

What

  • package-map: rebuilt the Template-Layer table — added core.theme / core.text / core.identity / core.widgets rows, folded the retired widgets+decorations into one core.widgets row, noted MarkdownText moved to core.text.
  • Guides & references: CvThemeBrandTheme, cv.v2.themecore.theme, and corrected widget package homes (header widgets now in core.identity) across the v2-layered guides, cv/v2/AUTHORS.md, which-template-system, api-stability, recipes, overview, CONTRIBUTING.
  • coverletter package-info: the reused renderer is core.text.RichParagraphRenderer.
  • Historical records (ADRs, CHANGELOG, migration guides) are left untouched as point-in-time records.

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.

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.
@DemchaAV DemchaAV merged commit 9f61fe2 into 2.0-dev Jun 28, 2026
11 checks passed
@DemchaAV DemchaAV deleted the docs/templates-core-refresh branch June 28, 2026 17:40
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