fix(docs): remove /docs/ prefix from internal server installation links#855
Open
tmchow wants to merge 1 commit intokeploy:mainfrom
Open
fix(docs): remove /docs/ prefix from internal server installation links#855tmchow wants to merge 1 commit intokeploy:mainfrom
tmchow wants to merge 1 commit intokeploy:mainfrom
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates versioned documentation links so internal installation-guide links no longer include an extra /docs/ prefix, aligning them with the repo’s Docusaurus routing setup for docs pages.
Changes:
- Replaces
/docs/server/installation/with/server/installation/in versioned docs for v2.0.0, v3.0.0, and v4.0.0. - Updates both “What’s Next?” and “Back to Installation Guide” links in the affected installation/native setup pages.
- Includes a small formatting-only blank-line cleanup in
versioned_docs/version-3.0.0/installation/windows.md.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
versioned_docs/version-4.0.0/keploy-explained/windows-wsl.md |
Fixes internal follow-up links after the Windows WSL setup guide. |
versioned_docs/version-4.0.0/keploy-explained/mac-linux.md |
Fixes internal follow-up links after the macOS/Linux VM setup guide. |
versioned_docs/version-4.0.0/installation/windows.md |
Fixes the “Start Capturing Test Cases” link in the Windows install doc. |
versioned_docs/version-4.0.0/installation/macos.md |
Fixes the “Start Capturing Test Cases” link in the macOS install doc. |
versioned_docs/version-4.0.0/installation/linux.md |
Fixes the “Start Capturing Test Cases” link in the Linux install doc. |
versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md |
Fixes internal follow-up links after the Windows WSL setup guide for v3 docs. |
versioned_docs/version-3.0.0/keploy-explained/mac-linux.md |
Fixes internal follow-up links after the macOS/Linux VM setup guide for v3 docs. |
versioned_docs/version-3.0.0/installation/windows.md |
Fixes the install-guide link and includes a formatting-only blank-line removal. |
versioned_docs/version-3.0.0/installation/macos.md |
Fixes the “Start Capturing Test Cases” link in the macOS install doc for v3. |
versioned_docs/version-3.0.0/installation/linux.md |
Fixes the “Start Capturing Test Cases” link in the Linux install doc for v3. |
versioned_docs/version-2.0.0/keploy-explained/mac-linux.md |
Fixes internal follow-up links after the macOS/Linux VM setup guide for v2 docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Refs keploy/keploy#3649. Docusaurus internal links inside versioned docs route via /<route>, not /docs/<route>. The 16 internal links to /docs/server/installation/ break when Docusaurus resolves them, which surfaces as the broken-anchor warnings reported in the issue. Replacing with /server/installation/ makes the links resolve to the correct page in each version namespace. External keploy.io URLs that legitimately include /docs/ in the path are left alone. Signed-off-by: Trevin Chow <trevin@trevinchow.com>
tmchow
force-pushed
the
fix/3649-broken-anchors-server-prefix
branch
from
0b1fd65 to
164d5d3
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
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 has changed?
Replaces
/docs/server/installation/with/server/installation/in 16 internal Markdown links acrossversioned_docs/version-2.0.0/,version-3.0.0/, andversion-4.0.0/. Inside Docusaurus versioned docs, internal links resolve through the active version's namespace, so the/docs/prefix is wrong and surfaces as broken-anchor warnings duringnpm run build.External links to
https://keploy.io/docs/server/...are intentionally left alone because those resolve against the deployed site, where the/docs/segment is part of the public URL.Refs keploy/keploy#3649 (the issue lives in keploy/keploy because keploy/docs does not use issues; #3649 below is the keploy/keploy issue number, not a keploy/docs reference).
Refs #3649
Type of change
How Has This Been Tested?
grep -rn '](\/docs\/server\/' versioned_docs --include='*.md'returns no matches after the change, where it returned 16 before. The 4 remaining/docs/server/references are allhttps://keploy.io/...external URLs and are unchanged.prettier --checkagainst the touched files passes; the version-3.0.0/installation/windows.md hunk includes a single blank-line removal that prettier auto-applied while writing my edits, which keeps the file in compliance with the project's prettier config rather than fighting it.I have not been able to run a full
npm run buildhere because the dev server install pulls a large dependency tree, but the file-level link rewrite is mechanical and covers exactly the broken-anchor pattern listed in the issue.Checklist: