Skip to content

Conversation

@SaketV8
Copy link

@SaketV8 SaketV8 commented Jan 26, 2026

What has changed?

This PR fixes the multiple broken anchors warning that appears when running npm run build

This PR specifically fixes the build warning by replacing /docs/server/... with /server/...

It also resolves issues by replacing /route with /route.md
(for example, /server/installation/ --> /server/installation.md).

It also fixes the [WARNING] siteConfig.onBrokenMarkdownLinks config option is deprecated

This PR Resolves #3649

Type of change

Please delete options that are not relevant.

  • 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 have run npm run build, and it build successfully without any errors or warning.

Before

Screenshot 2026-01-26 213645

After

Screenshot 2026-01-26 214052

Checklist:

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

Copilot AI review requested due to automatic review settings January 26, 2026 16:12
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

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR addresses broken anchor warnings that appear during npm run build by fixing internal documentation links and updating the deprecated onBrokenMarkdownLinks configuration option.

Changes:

  • Replaced /docs/server/ path prefix with /server/ in internal links across multiple documentation files
  • Changed directory-style links to explicit .md file links (e.g., /server/installation//server/installation.md)
  • Updated onBrokenMarkdownLinks configuration in docusaurus.config.js to use a nested structure under markdown.hooks

Reviewed changes

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md Fixed two broken anchor links by updating path prefix and adding .md extension
versioned_docs/version-3.0.0/keploy-explained/mac-linux.md Fixed two broken anchor links by updating path prefix and adding .md extension
versioned_docs/version-3.0.0/installation/windows.md Fixed broken anchor link by updating path prefix and adding .md extension
versioned_docs/version-3.0.0/installation/macos.md Fixed broken anchor link by updating path prefix and adding .md extension
versioned_docs/version-3.0.0/installation/linux.md Fixed broken anchor link by updating path prefix and adding .md extension
versioned_docs/version-3.0.0/concepts/platform-requirements.md Fixed two broken anchor links in table by updating path prefix and adding .md extension
versioned_docs/version-2.0.0/keploy-explained/mac-linux.md Fixed two broken anchor links by updating path prefix and adding .md extension
versioned_docs/version-2.0.0/concepts/platform-requirements.md Fixed broken anchor link in table by updating path prefix and adding .md extension
docusaurus.config.js Updated deprecated onBrokenMarkdownLinks configuration to use nested structure

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

onBrokenMarkdownLinks: 'warn',
},
},
// onBrokenMarkdownLinks: "warn",
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

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

The commented-out code on this line should be removed since it's no longer needed. Keeping commented-out configuration can cause confusion for future maintainers.

Suggested change
// onBrokenMarkdownLinks: "warn",

Copilot uses AI. Check for mistakes.
Copy link
Author

Choose a reason for hiding this comment

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

Acknowledged, this is intentional for now and will be cleaned up later.

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 @SaketV8, 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 47 06 PM

@SaketV8
Copy link
Author

SaketV8 commented Jan 27, 2026

Hi @Achanandhi-M, I have run the command locally and it worked successfully. I also removed some duplicate values from the config file, so it should now work without any errors.

I’ve attached the screenshots and recording for the build..

Screenrecording

npm start

(loading gif...)

keploy-fix

Screeenshot

npm start

npm start

npm run build

build ss

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 @SaketV8 but stills i am facing the same issue

Image

@SaketV8
Copy link
Author

SaketV8 commented Jan 27, 2026

Hi @Achanandhi-M, in your error log its showing Docusaurus version: 3.8.1 but in both the fix-broken-anchor and main branch the version is 3.7.0

Even the current main branch of this repository is using Docusaurus version: 3.7.0

here's the link

"@docusaurus/core": "^3.7.0",

Could you please get the latest changes for the fix-broken-anchor re run the command

docu

@Achanandhi-M
Copy link
Member

Hey @SaketV8, that’s not the issue. As you suggested, I checked my package.json, and the version is already 3.7.0. Could you please take another look?

Screenshot 2026-01-27 at 4 04 21 PM

@SaketV8
Copy link
Author

SaketV8 commented Jan 27, 2026

Hi @Achanandhi-M , could you please reinstall all dependency of this repository.
as in package.json it is showing 3.7.0 but in error is showing 3.8.1

reinstalling the dependency

  • delete these node_modules & package-lock.json and then
  • npm cache clean --force

after that install using npm i

@Achanandhi-M
Copy link
Member

Hey @SaketV8, thanks for the recommendation. There was an issue on my machine related to a dependency, but it’s working fine now.

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 @SaketV8, 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?

@SaketV8
Copy link
Author

SaketV8 commented Jan 27, 2026

Hi @Achanandhi-M , Sure, I’ll check this and update the version 4 as well shortly

Signed-off-by: Saket Maurya <mauryapriyadarshi2004@gmail.com>
…ce with v4 based onBrokenMarkdownLinks

Signed-off-by: Saket Maurya <mauryapriyadarshi2004@gmail.com>
Signed-off-by: Saket Maurya <mauryapriyadarshi2004@gmail.com>
@SaketV8
Copy link
Author

SaketV8 commented Jan 27, 2026

Hi @Achanandhi-M I have added the latest changes from main to fix-broken-anchor which included version 4

Screen recording

(loading GIF...)

keploy 444

@Achanandhi-M
Copy link
Member

Hey @SaketV8 but in the files changes i didn't see any changes in the version 4 files??

@SaketV8
Copy link
Author

SaketV8 commented Jan 27, 2026

Hi @Achanandhi-M , actually I have to rebase my branch so there is no new changes as all changes for version 4 are in main already and I have just rebased my branch on top of the latest main

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs]: fix broken anchors in the doc website

2 participants