docs(contributing): repair stale links in the contributor guides#312
Merged
Conversation
The module split and test relocations left broken links in the contributor docs. Repoint them to real locations: fix wrong ../ depth, prefix the moved-module paths (the PDF backend and the render-pdf / testing test scaffolding), and point relocated suites at their qa homes. Drop the two references to a boundary test that no longer exists, and repoint the preset test links to the current CvV2 / CoverLetterV2 parity tests and the per-preset smoke tests.
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 and earlier test relocations left ~33 broken links across the contributor
guides (
CONTRIBUTING.md,contributing/extension-guide.md,contributing/implementation-guide.md) —wrong
../depth, source/test files that moved to the render-pdf / testing / qa modules,and a few links to tests that were renamed or removed. None were caught by CI (no markdown
link-checker runs).
What
../src/...→../../src/...fromdocs/contributing/).testsupport/engine/assemblyscaffolding →
render-pdf/,LayoutSnapshotAssertions→testing/, relocated engine /template test suites →
qa/.recipes.md,getting-started.md,package-map.md,lifecycle.md,overview.md,adr/0001-...).legacy substrate), and repoint the preset-test links to the current
CvV2VisualParityTest/CoverLetterV2VisualParityTestplus the per-preset smoke tests.Tests
CanonicalSurfaceGuardTest,DocumentationCoverageTest,PackageMapGuardTest,VersionConsistencyGuardTest) — 24 tests, 0 failures.