fix(docs): resolve broken anchors and links in versioned docs#759
fix(docs): resolve broken anchors and links in versioned docs#759VishalPainjane wants to merge 5 commits intokeploy:mainfrom
Conversation
5625675 to
d5ecfce
Compare
There was a problem hiding this comment.
Hey @VishalPainjane , the changes look good overall, but I noticed a few issues while running it. Could you please check this once? Also, please add the necessary screenshots or a short video demonstrating your changes. Thanks!
d301906 to
dad7cdd
Compare
Achanandhi-M
left a comment
There was a problem hiding this comment.
Hey @VishalPainjane, I noticed that around 52 files were changed in this PR. I don’t think all of these changes are necessary—could you please review and limit the changes to what’s required? Thanks!
Signed-off-by: Vishal Painjane <painjanevishal2204@gmail.com>
d742565 to
59d8c5f
Compare
Signed-off-by: Vishal Painjane <138028102+VishalPainjane@users.noreply.github.com>
|
@Achanandhi-M, please review it now. Thanks |
Achanandhi-M
left a comment
There was a problem hiding this comment.
Hey @VishalPainjane , one more change—we’ve added version 4 as well, but the updates aren’t reflected in the version 4 files yet. Could you please take a look and update those files too?
Signed-off-by: Vishal Painjane <painjanevishal2204@gmail.com>
|
Hi @Achanandhi-M, I have updated the PR to include the fixes for Version 4.0.0 as requested. Changes:
I ran |
amaan-bhati
left a comment
There was a problem hiding this comment.
This is a solid and well-executed fix for a real, impactful bug. The systematic conversion from absolute to relative paths with explicit anchors is the correct approach, and migrating the deprecated Docusaurus config option is a nice cleanup as well.
A few things to confirm before merging:
Issues Found
1. Anchor slug renames may break existing links
The heading standardization from "Testcases" to "Test Cases" changes the auto-generated anchor slugs. Please search the codebase for any references to the old slugs such as #start-capturing-testcases and #running-testcases to ensure nothing else breaks after this is merged.
2. Version coverage
Please confirm whether version-1.0.0 docs need the same anchor fixes or are explicitly out of scope for this PR.
Once the above are confirmed this PR is in good shape and recommended for merge. Please also rebase against main before merging as there are merge conflicts with other open PRs touching docusaurus.config.js.



What has changed?
This PR fixes multiple broken internal links and anchors in the versioned documentation (v2 and v3) that were causing build failures.
Specifically, it addresses:
../../to../) in quickstart guides, platform requirements, and installation docs to correctly point toserver/installation.md.{#capturing-testcases}toserver/installation.mdin both v2.0.0 and v3.0.0 docs to ensure deep linking works reliably.mac-linux.md,windows-wsl.md) to point to the correct installation headers.This PR Resolves #3649 issue in keploy repo
Type of change
How Has This Been Tested?
I ran
npm run buildlocally to verify that all broken link errors are resolved.Build Output:

Checklist: