docs: fix wrong-depth doc links and complete the sealed-type list#289
Merged
Conversation
Two accuracy fixes left over from the 2.0 docs pass: - The contributing implementation guide linked every source file with a `./../src/...` prefix that resolves one directory too high; correct it to `../../src/...` (40 links), point the one dead `ButtonBuilder` example at the real `CircleBuilder`, and repoint the two recipes-index links that dropped their `contributing/` and `roadmaps/` path segment. - The api-stability sealed-hierarchy list named only three of the public sealed types; add the five it omitted — `ChartSize`, `ChartSpec`, `DocumentLinkTarget`, `DocumentPaint`, `DocumentPathSegment` — so the list matches the actual public sealed surface. 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
Two accuracy leftovers from the 2.0 docs pass, both caught by a link/reference sweep.
What
docs/contributing/implementation-guide.mdlinked every source file with a./../src/...prefix that resolves one directory too high (to the repo parent). Correct all 40 to../../src/..., point the one deadButtonBuilderexample at the real siblingCircleBuilder, and repoint the twodocs/recipes.mdindex links that had dropped theircontributing/androadmaps/path segment.docs/api-stability.md§2 named onlyCvSection,InlineRun,ShapeOutlinewhile five other public sealed types exist. AddChartSize,ChartSpec,DocumentLinkTarget,DocumentPaint,DocumentPathSegmentso the list matches the real public sealed surface (verified complete — no non-@Internalpublic sealed type is now missing).Tests
Docs only. All 100 relative links in the three touched files verified to resolve. Documentation guards (
DocumentationCoverageTest,CanonicalSurfaceGuardTest,VersionConsistencyGuardTest,PackageMapGuardTest,DocumentationExamplesTest) — 34 tests, 0 failures.