docs: fix broken links in docsify sidebar#5065
Merged
mcollina merged 1 commit intonodejs:mainfrom Apr 19, 2026
Merged
Conversation
The sidebar links pointed to /docs/api/... which works on the deployed docsify site but 404s in GitHub blob view because the actual files live at /docs/docs/api/.... The custom renderer in docs/index.html added by PR nodejs#3807 already de-duplicates /docs/docs/ to /docs/ for the live site, so switching sidebar links to repo-relative form (/docs/docs/api/...) keeps the live site working and fixes GitHub blob view. Also corrects two pre-existing broken sidebar entries: /examples/ now points to /docs/examples/ where the directory actually lives, and the Socks5Agent entry was renamed to Socks5ProxyAgent.md to match the actual exported class and filename. Fixes: nodejs#4326 Refs: nodejs#3322
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
2 participants
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.
This relates to...
Fixes #4326. Refs #3322.
Rationale
The sidebar links in
docs/docsify/sidebar.mduse/docs/api/...paths, which work on the deployed docsify site but produce 404s in GitHub blob view because the actual files live atdocs/docs/api/.... The custom marked renderer added indocs/index.html(PR #3807) already de-duplicates/docs/docs/to/docs/for the live site, so switching the sidebar to repo-relative form keeps both views working.Changes
Bug Fixes
docs/docsify/sidebar.mdto repo-relative paths (/docs/docs/api/...)./examples/->/docs/examples/(the directory actually lives atdocs/examples/).Socks5Agententry toSocks5ProxyAgent.mdto match the actual exported class.Status