docs(templates): fix engine source links after the v2-suffix drop#284
Merged
Conversation
The four per-family suffix drops moved templates.<fam>.v2.* up to templates.<fam>.*, leaving the how-to docs pointing at source paths and imports that no longer exist. Repoint the engine source links, file paths, and import snippets in the v2-layered guides, the themes recipe, and the test-your-document guide to the unsuffixed locations. Example-source links (examples/templates/<fam>/v2/, whose directories are unchanged) are left as-is. Docs only; the documentation guard tests pass.
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 four per-family suffix drops (#280–#283) moved
templates.<fam>.v2.*up totemplates.<fam>.*, leaving the how-to docs with broken source-path links and imports pointing at packages that no longer exist. First of the 3-13 docs slices — the purely mechanical link/import fixes.What (7 how-to docs)
templates/<fam>/v2/→templates/<fam>/andtemplates.<fam>.v2→templates.<fam>in:v2-layered/{README,quickstart,authoring-presets,contributor-guide,using-templates}.md,recipes/themes.md,operations/test-your-document.md.examples/templates/<fam>/v2/— those directories are deliberately unchanged).Out of scope (later 3-13 slices)
The conceptual/ledger docs (
which-template-system.md,api-stability.md§3/§4), the BusinessTheme README rework, and the CHANGELOG v2.0.0 entry get a narrative pass separately.Tests
Docs-only.
DocumentationExamplesTest+CanonicalSurfaceGuardTest+DocumentationCoverageTest+PackageMapGuardTest+VersionConsistencyGuardTest— 34 tests, 0 failures.Follow-up
Two example dir-links in
quickstart.md/README.mduse../../examples/(resolves todocs/examples/) — a pre-existing../-depth typo, unrelated to this rename; fold into the later docs pass.