Skip to content

fix(docs): resolve broken anchors and links in versioned docs#759

Open
VishalPainjane wants to merge 5 commits intokeploy:mainfrom
VishalPainjane:fix/broken-anchors-3649
Open

fix(docs): resolve broken anchors and links in versioned docs#759
VishalPainjane wants to merge 5 commits intokeploy:mainfrom
VishalPainjane:fix/broken-anchors-3649

Conversation

@VishalPainjane
Copy link

@VishalPainjane VishalPainjane commented Jan 26, 2026

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:

  1. Updated incorrect relative paths (swapping ../../ to ../) in quickstart guides, platform requirements, and installation docs to correctly point to server/installation.md.
  2. Added explicit anchors {#capturing-testcases} to server/installation.md in both v2.0.0 and v3.0.0 docs to ensure deep linking works reliably.
  3. Fixed platform specific pages (mac-linux.md, windows-wsl.md) to point to the correct installation headers.

This PR Resolves #3649 issue in keploy repo

Type of change

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

I ran npm run build locally to verify that all broken link errors are resolved.

Build Output:
swappy-20260126_185135

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

github-actions[bot]
github-actions bot reviewed Jan 26, 2026
View reviewed changes
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you and congratulations 🎉 for opening your very first pull request in keploy

@VishalPainjane VishalPainjane force-pushed the fix/broken-anchors-3649 branch from 5625675 to d5ecfce Compare January 26, 2026 13:28
@VishalPainjane VishalPainjane mentioned this pull request Jan 26, 2026
Open
1 task
Achanandhi-M
Achanandhi-M requested changes Jan 27, 2026
View reviewed changes
Copy link
Member

@Achanandhi-M Achanandhi-M left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Screenshot 2026-01-27 at 2 26 30 PM

@VishalPainjane VishalPainjane force-pushed the fix/broken-anchors-3649 branch 2 times, most recently from d301906 to dad7cdd Compare January 27, 2026 09:37
@VishalPainjane
Copy link
Author

VishalPainjane commented Jan 27, 2026

I have made the following updates:

  • Fixed Docusaurus Config: Resolved the deprecation warning by migrating onBrokenMarkdownLinks to the markdown.hooks object in docusaurus.config.js.

Screenshot:
swappy-20260127_151516

Achanandhi-M
Achanandhi-M requested changes Jan 27, 2026
View reviewed changes
Copy link
Member

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@VishalPainjane
fix: resolve broken anchors and update docusaurus config
59d8c5f 
Signed-off-by: Vishal Painjane <painjanevishal2204@gmail.com>
@VishalPainjane VishalPainjane force-pushed the fix/broken-anchors-3649 branch from d742565 to 59d8c5f Compare January 27, 2026 10:22
@VishalPainjane
Merge branch 'main' into fix/broken-anchors-3649
edd18ee 
Signed-off-by: Vishal Painjane <138028102+VishalPainjane@users.noreply.github.com>
@VishalPainjane
Copy link
Author

VishalPainjane commented Jan 27, 2026

@Achanandhi-M, please review it now. Thanks

Achanandhi-M
Achanandhi-M requested changes Jan 28, 2026
View reviewed changes
Copy link
Member

@Achanandhi-M Achanandhi-M left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

VishalPainjane and others added 2 commits January 28, 2026 12:42
@VishalPainjane
Copy link
Author

VishalPainjane commented Jan 28, 2026

Hi @Achanandhi-M, I have updated the PR to include the fixes for Version 4.0.0 as requested.

Changes:

  • Synced with the latest main branch to include version 4 files.
  • Updated headers and anchors in versioned_docs/version-4.0.0/server/installation.md to match the fixes in other versions (Capturing Testcases → Capturing Test Cases).

I ran npm run build and npm start locally to verify that the build is successful and the dev server starts without issues.

Screenshots (Build & Start):
image
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@Achanandhi-M Achanandhi-M Awaiting requested review from Achanandhi-M

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@VishalPainjane @Achanandhi-M