docs: repoint moved-module links and refresh the source-tree map#308
Merged
Conversation
The module split relocated the built-in templates to graph-compose-templates and the PDF backend to graph-compose-render-pdf, which left doc links pointing at the old core src/main paths. Repoint those links to the new module paths (templates/src/main and render-pdf/src/main), and update the CONTRIBUTING repository map and the architecture overview so the render backends and templates are attributed to their modules (FontShowcase now lives in the core document.showcase package). Also fix a stale reference-template link in the v1 authoring guide (the removed InvoiceTemplateV2 / ProposalTemplateV2 point at the current ModernInvoice / ModernProposal presets) and note the batteries-included bundle now carries templates and emoji.
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 module split relocated the built-in templates to
graph-compose-templatesand thePDF backend to
graph-compose-render-pdf, but a batch of doc links still pointed at theold core
src/main/...paths — so they 404 on GitHub — and the CONTRIBUTING repositorymap and architecture overview still described those packages as part of the core module.
What
templates/src/main/...for thetemplates,
render-pdf/src/main/...for the PDF backend / ECS tree. Verified: all 16repointed links resolve.
built-in templates are now attributed to their modules;
FontShowcaseis called out inits core
document.showcasehome.are noted as separate opt-in artifacts over
graph-compose-core.InvoiceTemplateV2/ProposalTemplateV2were removed → point atModernInvoice/ModernProposal), andnote the batteries-included bundle now carries templates and emoji.
Scope note: this fixes the links the module moves broke. A separate batch of
pre-existing doc-link rot (wrong
../depth incontributing/extension-guide.md, links torelocated test scaffolding, and refs to
package-map.mdwhich the migration-docs PRintroduces) is left for a dedicated follow-up.
Tests
CanonicalSurfaceGuardTest,DocumentationCoverageTest,PackageMapGuardTest,VersionConsistencyGuardTest) — 24 tests, 0 failures. A relativelink-checker over every changed file confirms zero links with the new module prefixes are broken.