Skip to content

docs: adding atg public docs for installation and explanation#585

Merged
nehagup merged 1 commit intomainfrom
atg
Jun 22, 2025
Merged

docs: adding atg public docs for installation and explanation#585
nehagup merged 1 commit intomainfrom
atg

Conversation

@nehagup
Copy link
Member

@nehagup nehagup commented Jun 22, 2025

This pull request includes updates to navigation links, UI components, and support documentation to improve user experience and clarify support options.

Navigation Updates:

  • Updated the "API Testing" navigation link in docusaurus.config.js to point to /running-keploy/api-test-generator instead of /running-keploy/about-api-testing.

UI Enhancements:

  • Refactored the KeployCloud component in src/components/KeployCloud.js to replace the SVG logo with a styled text section. The new section provides links to join the Slack community and book a demo for enterprise use cases.

Support Documentation Updates:

  • Updated the support section in versioned_docs/version-3.0.0/concepts/support.md to replace the GitHub Discussions badge with a GitHub Issues badge, linking directly to the issue tracker for better support visibility.## What has changed?

Please include a summary of the change.

This PR Resolves #(issue)

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?

Please run npm run build and npm run serve to check if the changes are working as expected. Please include screenshots of the output of both the commands. Add screenshots/gif of the changes if possible.

Checklist:

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

Signed-off-by: Neha Gupta <gneha21@yahoo.in>
Copilot AI review requested due to automatic review settings June 22, 2025 17:50
@nehagup nehagup merged commit 02759a9 into main Jun 22, 2025
4 of 6 checks passed
@nehagup nehagup deleted the atg branch June 22, 2025 17:51
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 enhances documentation and navigation for Keploy’s API Test Generator, updates support resources, and refactors a UI component for clearer support links.

  • Swaps and updates sidebar categories for API and Unit Testing
  • Adds new AI-based API test generation guide and overview doc
  • Replaces SVG logo in KeployCloud with styled support/demo links and updates support badge

Reviewed Changes

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

Show a summary per file
File Description
versioned_sidebars/version-3.0.0-sidebars.json Swapped sidebar labels and updated items to reflect API Testing and Unit Testing sections
versioned_docs/version-3.0.0/running-keploy/generate-api-tests-using-ai.md Added new guide for generating API tests via AI
versioned_docs/version-3.0.0/running-keploy/api-testing-tool-ai-powered.md Introduced the API Test Generator overview doc
versioned_docs/version-3.0.0/concepts/support.md Replaced GitHub Discussions badge with an Issues badge for direct issue tracking
src/components/KeployCloud.js Replaced SVG with a text block linking to Slack community and demo booking
docusaurus.config.js Updated the "API Testing" nav link to the new API Test Generator doc
Comments suppressed due to low confidence (3)

versioned_docs/version-3.0.0/concepts/support.md:14

  • Prefix the GitHub Issue badge line with '- ' to maintain proper list formatting alongside other support options.
[![GitHub Issue](https://img.shields.io/badge/GitHub-%23FFFF.svg?style=for-the-badge&logo=GitHub&logoColor=black)](https://github.com/keploy/keploy)

versioned_docs/version-3.0.0/running-keploy/generate-api-tests-using-ai.md:38

  • [nitpick] The casing is inconsistent—prefer 'Best Practices for Test Output' for clarity and style consistency.
## BEST Practices for BEST Test Output

y2="100.010525%"
id="linearGradient-1"
<div className="max-w-3xl mx-auto prose prose-orange">
<h1> Question? 🤔💭</h1>
Copy link

Copilot AI Jun 22, 2025

Choose a reason for hiding this comment

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

[nitpick] Using an

inside a section component may conflict with the page’s main heading; consider using

or a lower-level heading.

Suggested change
<h1> Question? 🤔💭</h1>
<h2> Question? 🤔💭</h2>

Copilot uses AI. Check for mistakes.
che3zcake pushed a commit to che3zcake/keploy-docs that referenced this pull request Jun 23, 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.

1 participant