Skip to content

Conversation

@pratik-mahalle
Copy link
Contributor

Fix: Corrected broken link in glossary
This pull request resolves an issue with a broken link within the documentation's glossary section.

Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
Copilot AI review requested due to automatic review settings July 15, 2025 09:03
@keploy
Copy link

keploy bot commented Jul 15, 2025

To generate Unit Tests for this PR, please click here.

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 fixes broken image links in the glossary documentation by replacing relative paths and a malformed HTML tag with correct markdown image links.

  • Updated white-box-testing.md and black-box-testing.md in v2.0.0 and v3.0.0 to use absolute S3 URLs instead of relative paths.
  • Replaced an incorrect <img scr=""> tag with a markdown image link in code-coverage.md.

Reviewed Changes

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

File Description
versioned_docs/version-3.0.0/concepts/reference/glossary/white-box-testing.md Switched relative image link to external S3 URL.
versioned_docs/version-2.0.0/concepts/reference/glossary/white-box-testing.md Switched relative image link to external S3 URL.
versioned_docs/version-2.0.0/concepts/reference/glossary/code-coverage.md Corrected scr typo and converted to markdown image syntax.
versioned_docs/version-2.0.0/concepts/reference/glossary/black-box-testing.md Switched relative image link to external S3 URL.
Comments suppressed due to low confidence (1)

versioned_docs/version-2.0.0/concepts/reference/glossary/code-coverage.md:44

  • Confirm that the GIF URL resolves correctly—without the ?raw=true query parameter it may still return 404. If needed, append ?raw=true or ensure the asset is hosted in a publicly accessible location.
![Keploy Test Replay](https://keploy.io/docs/gif/replay-tc.gif)

Keploy has native integrations with your unit-testing libraries like go-test, jUnit, jest, pyTest. Keploy gives combined test-coverage and can also be integrated in existing CI pipelines easily within go-test, jUnit, jest, pyTest workflows.

<img scr="https://keploy.io/docs/gif/replay-tc.gif?raw=true"/>
![Keploy Test Replay](https://keploy.io/docs/gif/replay-tc.gif)
Copy link

Copilot AI Jul 15, 2025

Choose a reason for hiding this comment

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

[nitpick] The alt text "Keploy Test Replay" is quite generic; consider using a more descriptive phrase (e.g., "Animated replay of a Keploy test case execution") to improve accessibility and clarity.

Suggested change
![Keploy Test Replay](https://keploy.io/docs/gif/replay-tc.gif)
![Animated replay of a Keploy test case execution](https://keploy.io/docs/gif/replay-tc.gif)

Copilot uses AI. Check for mistakes.
Copy link
Member

@amaan-bhati amaan-bhati left a comment

Choose a reason for hiding this comment

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

I've addressed the changes, instead of using images in png/svg/jpg/jpegs try using webp format images since it helps us improve the performance and reduce the loading time of the webpage. Also, compress these images a little either by using cwebp or https://squoosh.app/
you can also use the following command to compress and convert images: cwebp -q 50 -lossless path/to/the/image.jpeg -o path/to/the/image.webp

The primary goal of white box testing is to validate the software's internal operations, ensuring that it functions correctly and efficiently. This involves checking all pathways and conditions, optimizing code for speed and performance, and ensuring that there are no hidden errors.

![types of testing](../../../../../static/img/glossary/types-of-testing.jpeg)
![Types of Testing](https://keploy-devrel.s3.us-west-2.amazonaws.com/types-of-testing.jpeg)
Copy link
Member

Choose a reason for hiding this comment

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

Try using a image in webp format instead of jpeg, try compressing it a little as well, the smaller the size, the lesser time it takes to load. This wil help us imporve the performance of the page, also keep in mind when you compress the images, it shouldn't be overcompressed in a way that it compromises with the quality.

The primary goal of white box testing is to validate the software's internal operations, ensuring that it functions correctly and efficiently. This involves checking all pathways and conditions, optimizing code for speed and performance, and ensuring that there are no hidden errors.

![types of testing](../../../../../static/img/glossary/types-of-testing.jpeg)
![Types of Testing](https://keploy-devrel.s3.us-west-2.amazonaws.com/types-of-testing.jpeg)
Copy link
Member

Choose a reason for hiding this comment

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

Try using a compressed webp format image here instead of the jpeg

The focus lies solely on examining the software's external behavior, inputs, outputs, and responses to different user actions or system interactions.

![types of testing](../../../../../static/img/glossary/types-of-testing.jpeg)
![Types of Testing](https://keploy-devrel.s3.us-west-2.amazonaws.com/types-of-testing.jpeg)
Copy link
Member

Choose a reason for hiding this comment

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

Add a webp format compressed image here too.

Signed-off-by: Pratik Mahalle <mahallepratik683@gmail.com>
Copy link
Member

@amaan-bhati amaan-bhati left a comment

Choose a reason for hiding this comment

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

looks good to me

Copy link
Contributor

@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.

LGTM

@Achanandhi-M Achanandhi-M merged commit c3a3860 into keploy:main Jul 21, 2025
3 of 6 checks passed
Achanandhi-M added a commit that referenced this pull request Jul 21, 2025
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.

3 participants