Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VishalPainjane wants to merge 5 commits into
base: main
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
59d8c5f
fix: resolve broken anchors and update docusaurus config
VishalPainjane Jan 26, 2026
edd18ee
Merge branch 'main' into fix/broken-anchors-3649
VishalPainjane Jan 27, 2026
d162c27
fix: resolve broken anchors in version 4.0.0
VishalPainjane Jan 28, 2026
a2659a3
Merge branch 'main' into fix/broken-anchors-3649
VishalPainjane Jan 28, 2026
5f5ad21
Merge branch 'main' into fix/broken-anchors-3649
Achanandhi-M Feb 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ module.exports = {
url: "https://keploy.io",
baseUrl: "/docs/",
onBrokenLinks: "throw",
markdown: {
hooks: {
onBrokenMarkdownLinks: "warn",
},
},
trailingSlash: true,
favicon: "img/favicon.png",
organizationName: "keploy", // Usually your GitHub org/user name.
Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-2.0.0/concepts/platform-requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Linux:

| Operating System | Without Docker | Docker Installation | Prerequisites |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="https://www.pngplay.com/wp-content/uploads/3/Apple-Logo-Transparent-Images.png" width="15" height="15" alt="MacOS" /> **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](/server/installation/) | - Docker Desktop version must be 4.25.2 or above<br/> |
| <img src="https://www.pngplay.com/wp-content/uploads/3/Apple-Logo-Transparent-Images.png" width="15" height="15" alt="MacOS" /> **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](../server/installation.md#other-installation-methods) | - Docker Desktop version must be 4.25.2 or above<br/> |
| <img src="https://upload.wikimedia.org/wikipedia/commons/5/5f/Windows_logo_-_2012.svg" width="15" height="15" alt="Windows" /> **Windows** | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install` <br/> - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 |
| <img src="https://th.bing.com/th/id/R.7802b52b7916c00014450891496fe04a?rik=r8GZM4o2Ch1tHQ&riu=http%3a%2f%2f1000logos.net%2fwp-content%2fuploads%2f2017%2f03%2fLINUX-LOGO.png&ehk=5m0lBvAd%2bzhvGg%2fu4i3%2f4EEHhF4N0PuzR%2fBmC1lFzfw%3d&risl=&pid=ImgRaw&r=0" width="10" height="10" alt="Linux" /> **Linux** | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | Linux kernel 5.15 or higher |

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-2.0.0/keploy-explained/mac-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ Congratulations! You've successfully set up Keploy natively on MacOS.

## What's Next?

### 🎬 [Start Capturing Testcases](/docs/server/installation/)
### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases)

Begin recording your API calls and generating test cases with Keploy.

#### [Back to Installation Guide](/docs/server/installation/)
#### [Back to Installation Guide](../server/installation.md)
4 changes: 2 additions & 2 deletions versioned_docs/version-2.0.0/server/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import InstallationGuide from '../concepts/installation.md'

<InstallationGuide/>

## 🎬 Capturing Testcases
## 🎬 Capturing Test Cases {#capturing-test-cases}

To initiate the recording of API calls, execute this command in your terminal:

Expand All @@ -41,7 +41,7 @@ For example, if you're using a simple Golang program, the **CMD_TO_RUN_APP** wou
keploy record -c "go run main.go"
```

## 🏃 Running Testcases
## 🏃 Running Test Cases

To run the testcases and see if there are any regressions introduced, use this terminal command:

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-3.0.0/concepts/platform-requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ Linux:

| Operating System | Without Docker | Docker Installation | Prerequisites |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <img src="https://www.pngplay.com/wp-content/uploads/3/Apple-Logo-Transparent-Images.png" width="15" height="15" alt="MacOS" /> **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](/server/installation/) | - Docker Desktop version must be 4.25.2 or above <br/> - Ensure that Lima is installed on your machine if you prefer to try without Docker. |
| <img src="https://upload.wikimedia.org/wikipedia/commons/5/5f/Windows_logo_-_2012.svg" width="15" height="15" alt="Windows" /> **Windows** | [Guide](/keploy-explained/windows-wsl.md) | [Guide](/server/installation/) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install` <br/> - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 <br/> - Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide |
| <img src="https://www.pngplay.com/wp-content/uploads/3/Apple-Logo-Transparent-Images.png" width="15" height="15" alt="MacOS" /> **MacOS** | [Guide](/keploy-explained/mac-linux.md) | [Guide](../server/installation.md#other-installation-methods) | - Docker Desktop version must be 4.25.2 or above <br/> - Ensure that Lima is installed on your machine if you prefer to try without Docker. |
| <img src="https://upload.wikimedia.org/wikipedia/commons/5/5f/Windows_logo_-_2012.svg" width="15" height="15" alt="Windows" /> **Windows** | [Guide](/keploy-explained/windows-wsl.md) | [Guide](../server/installation.md#other-installation-methods) | - Use [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) `wsl --install` <br/> - Windows 10 version 2004 and higher (Build 19041 and higher) or Windows 11 <br/> - Ensure that Docker Desktop version 4.25.2 or above is installed if you are following the Docker installation guide |
| <img src="https://th.bing.com/th/id/R.7802b52b7916c00014450891496fe04a?rik=r8GZM4o2Ch1tHQ&riu=http%3a%2f%2f1000logos.net%2fwp-content%2fuploads%2f2017%2f03%2fLINUX-LOGO.png&ehk=5m0lBvAd%2bzhvGg%2fu4i3%2f4EEHhF4N0PuzR%2fBmC1lFzfw%3d&risl=&pid=ImgRaw&r=0" width="10" height="10" alt="Linux" /> **Linux** | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | <img src="https://upload.wikimedia.org/wikipedia/commons/e/e5/Green_tick_pointed.svg" width="20" height="20" alt="Supported" /> | Linux kernel 5.15 or higher |

On MacOS and Windows, additional tools are required for Keploy due to the lack of native eBPF support.
2 changes: 1 addition & 1 deletion versioned_docs/version-3.0.0/installation/linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ You’ve successfully installed **Keploy on Linux**.

## What's Next?

### 🎬 [Start Capturing Test Cases](/docs/server/installation/)
### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases)

Begin recording your API calls and automatically generate test cases with Keploy.
2 changes: 1 addition & 1 deletion versioned_docs/version-3.0.0/installation/macos.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ Keploy uses eBPF to intercept API calls on network layer and generates test case

## What's Next?

### 🎬 [Start Capturing Test Cases](/docs/server/installation/)
### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases)

Begin recording your API calls and automatically generate test cases with Keploy.

Expand Down
2 changes: 1 addition & 1 deletion versioned_docs/version-3.0.0/installation/windows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ If you already have WSL, Go to Step 2.

## What's Next?

### 🎬 [Start Capturing Test Cases](/docs/server/installation/)
### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases)

Begin recording your API calls and automatically generate test cases with Keploy.

Expand Down
4 changes: 2 additions & 2 deletions versioned_docs/version-3.0.0/keploy-explained/mac-linux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ Congratulations! You've successfully set up Keploy natively on MacOS.

## What's Next?

### 🎬 [Start Capturing Testcases](/docs/server/installation/)
### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases)

Begin recording your API calls and generating test cases with Keploy.

#### [Back to Installation Guide](/docs/server/installation/)
#### [Back to Installation Guide](../server/installation.md)
4 changes: 2 additions & 2 deletions versioned_docs/version-3.0.0/keploy-explained/windows-wsl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ Congratulations! You've successfully set up Keploy natively on Windows.

## What's Next?

### 🎬 [Start Capturing Testcases](/docs/server/installation/)
### 🎬 [Start Capturing Test Cases](../server/installation.md#capturing-test-cases)

Begin recording your API calls and generating test cases with Keploy.

#### [Back to Installation Guide](/docs/server/installation/)
#### [Back to Installation Guide](../server/installation.md)
4 changes: 2 additions & 2 deletions versioned_docs/version-3.0.0/server/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ import InstallationGuide from '../concepts/installation.md'

<InstallationGuide/>

## 🎬 Capturing Testcases
## 🎬 Capturing Test Cases {#capturing-test-cases}

To initiate the recording of API calls, execute this command in your terminal:

Expand All @@ -41,7 +41,7 @@ For example, if you're using a simple Golang program, the **CMD_TO_RUN_APP** wou
keploy record -c "go run main.go"
```

## 🏃 Running Testcases
## 🏃 Running Test Cases

To run the testcases and see if there are any regressions introduced, use this terminal command:

Expand Down
1 change: 1 addition & 0 deletions versioned_docs/version-3.0.0/server/installation_tabs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -352,6 +352,7 @@ Add the directory containing the Keploy binary to your system user’s `PATH` en

Use "keploy [command] --help" for more information about a command.
```

## 🎉 Congratulations!

You’ve successfully installed **Keploy on Windows**.
Expand Down