docs: fix broken relative links across the docs tree#321
Merged
Conversation
Repoint or remove the relative markdown links that stopped resolving after the 2.0 module split and the removal of the legacy ECS test harness. - move engine/backend test links to the render-pdf/ and qa/ modules and example links to examples/features/*; add the missing ../ on the roadmaps' adr/ and recipes/ links and on the cv/v2 example directory - v1-classic authoring: link the hand-built theme to examples/.../support/theme/BusinessTheme.java and the invoice end-to-end reference to InvoiceV2VisualParityTest - implementation guide: remove the "low-level test harness builders" and "test-support ComponentBuilder" sections and the scattered engine-assembly builder links (that harness was deleted); reframe the table section around the surviving engine contract - CONTRIBUTING: drop the deleted ECS-dispatch guard/checklist entries and repoint the pagination bullet to PaginationEdgeCaseTest Link scan over docs/**, CONTRIBUTING.md, README.md: 0 broken. CanonicalSurfaceGuardTest passes.
DemchaAV
force-pushed
the
docs/fix-broken-relative-links
branch
from
0c57f6c to
6c71e4f
Compare
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 docs carried ~50 relative markdown links that no longer resolved. Two causes: the 2.0 module split moved tests into the
render-pdf/andqa/modules and examples intoexamples/features/*, and #316 deleted the legacy ECS test harness (com.demcha.compose.testsupport.engine.assembly.*) that a cluster of contributor-doc links pointed at. A few older links were also missing a../segment. Pre-existing link rot, not a side effect of the ECS-render-tree removal.What changed
Repointed moved targets:
render-pdf/andqa/modules (PdfBackendExtensibilityTest,PdfShapeAlphaTest,ListBuilderNestedTest,TableCellComposedContentTest,CanvasLayerBuilderTest,ShapeContainerLayoutSnapshotTest,LayoutSnapshotPublicApiDogfoodTest,CvV2VisualParityTest,TimelineDemoTest)examples/features/*(CanvasLayerExample,InlineShapesExample,LayoutSnapshotRegressionExample,TableAdvancedExample)../on the roadmaps'adr/andrecipes/links, the@Internallink, and thecv/v2example directory linkexamples/.../support/theme/BusinessTheme.java; invoice end-to-end →InvoiceV2VisualParityTestRemoved dead references (no surviving target):
implementation-guide.md: the "Low-level test harness builders" and "test-support ComponentBuilder" sections plus the scattered engine-assembly builder example links — the harness they documented was deleted. Reframed the Case 2.5 table lead-in around the surviving engine contract (TableRow/TableCellBox/TableResolvedCell) and kept the still-valid engine/template links.CONTRIBUTING.md: the deleted ECS-dispatch guard and the two deleted test-harness/dispatch checklist bullets; repointed the pagination checklist bullet toPaginationEdgeCaseTest.Docs-only; no code or example sources touched.
Verification
docs/**,CONTRIBUTING.md,README.md: 629 links checked, 0 broken (was 52)../mvnw test -Dtest=CanonicalSurfaceGuardTest -pl .passes.Out of scope
The recipe Cases 1–4 in
implementation-guide.mdstill describe object authoring in the old engine-builder vocabulary (ContainerBuilder<T>, "builder base class"). That wording refresh is a separate change, not part of this link cleanup.