docs: fix broken relative links in docs site pages#5585
Open
ZayanKhan-12 wants to merge 1 commit into
Open
Conversation
docs/docs/index.md is adapted from the root README.md, but several links were left written relative to the repo root, so they resolve to nonexistent paths from the file's actual location. Rewrite the Dispatcher API links to ./api/Dispatcher.md, matching how sibling pages link to API docs, and point targets that live outside the docs site root (CONTRIBUTING.md, docs/examples) at their canonical GitHub URLs. Also fix docs/README.md links to site.json and type-map.json, which live in docs/docs/, and the /examples/ link in getting-started.md. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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.
What
Fixes 16 broken relative links across three docs files:
docs/docs/index.md(adapted from the rootREADME.md) — several links were left written relative to the repo root, so they resolve to nonexistent paths from the file's location:./docs/docs/api/Dispatcher.md#…→./api/Dispatcher.md#…(matches how sibling pages likebest-practices/*.mdlink to API docs)./CONTRIBUTING.mdand./docs/examples/README.md→ canonical GitHub URLs, since those files live outside the docs site root./docs/→ GitHub URL for the docs directorydocs/README.md— links to./site.jsonand./type-map.json, but both files live indocs/docs/→./docs/site.json,./docs/type-map.jsondocs/docs/getting-started.md—[Examples](/examples/)→ GitHub URL fordocs/examples(the absolute path resolves nowhere on GitHub, and the examples directory is not part of the built site)Verification
Ran a link checker over every markdown file in the repo that resolves each relative link target against the filesystem: 16 broken before, 0 after. No prose changes — link targets only.
🤖 Generated with Claude Code