Conversation
40e35d5 to
b26c5c9
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR adds new documentation pages for reviewing, improving, and sharing Keploy AI-generated API test suites, and updates the sidebar to surface these new guides under a "Test Operations" category.
- Introduce Review & Improve AI-Generated API Tests guide
- Introduce Share Test Suite With Your Team guide
- Update sidebars JSON to include new "Test Operations" category
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| versioned_sidebars/version-3.0.0-sidebars.json | Added new "Test Operations" category under running-keploy |
| versioned_docs/version-3.0.0/running-keploy/share-tests.md | New doc explaining how to share test suites |
| versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md | New doc for reviewing and editing AI-generated tests |
Comments suppressed due to low confidence (6)
versioned_docs/version-3.0.0/running-keploy/share-tests.md:5
- The frontmatter description still refers to generating tests rather than sharing them. Update it to reflect sharing test suites with team members.
description: Learn how to use Keploy’s API Test Generator to generate high-quality API test suites using AI from OpenAPI, curl, Postman, or traffic.
versioned_docs/version-3.0.0/running-keploy/share-tests.md:26
- The bullet overflows across two lines. Combine "An email" and "with a direct link to the suite" into a single list item for better readability.
- An email
versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md:12
- [nitpick] Consider rephrasing for clarity, e.g., "Select an application to view its generated test suite."
Based on the app that is selected, you can view the test suite for that app
versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md:24
- Use the conventional abbreviation "e.g.," instead of "eg:".
You can **combine these filters** with the search bar—for example, view only failed `DELETE` calls on eg: `/employees`—making it painless to triage huge test suites.
versioned_sidebars/version-3.0.0-sidebars.json:17
- The JSON indentation and comma placement around the new category objects is inconsistent and may break parsing. Align braces and commas with existing entries and remove extra blank lines for clarity.
},
versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md:55
- There are two spaces after
##; reduce to one for consistent heading formatting.
## Edit or Delete a Test Suite
* docs: adding atg public docs for installation and explanation Signed-off-by: Neha Gupta <gneha21@yahoo.in> * docs: adding atg public docs for fix with ai Signed-off-by: Neha Gupta <gneha21@yahoo.in> * chore: atg operations (#587) * chore: atg operations (#587) * docs: adding atg public docs for fix with ai Signed-off-by: Neha Gupta <gneha21@yahoo.in> --------- Signed-off-by: Neha Gupta <gneha21@yahoo.in> Co-authored-by: Tvisha <tvisha.raji@keploy.io>
Signed-off-by: Lawrence Sharma <che3zcake@gmail.com>
* docs: adding atg public docs for installation and explanation Signed-off-by: Neha Gupta <gneha21@yahoo.in> * docs: adding atg public docs for fix with ai Signed-off-by: Neha Gupta <gneha21@yahoo.in> * chore: atg operations (keploy#587) * chore: atg operations (keploy#587) * docs: adding atg public docs for fix with ai Signed-off-by: Neha Gupta <gneha21@yahoo.in> --------- Signed-off-by: Neha Gupta <gneha21@yahoo.in> Co-authored-by: Tvisha <tvisha.raji@keploy.io> Signed-off-by: Lawrence Sharma <che3zcake@gmail.com>
This pull request introduces new documentation for Keploy's API test suite features, including reviewing, improving, and sharing AI-generated tests, along with updates to the sidebar structure to accommodate these additions.
New Documentation:
versioned_docs/version-3.0.0/running-keploy/review-and-improve-ai-generated-tests.md: Added a detailed guide on how to review, edit, and enhance AI-generated API test suites, including filtering, editing requests and assertions, and managing test suites.versioned_docs/version-3.0.0/running-keploy/share-tests.md: Added a guide on sharing test suites with team members, covering the share dialog, inviting users, and notification process.Sidebar Updates:
versioned_sidebars/version-3.0.0-sidebars.json: Updated the sidebar structure to include a new "Test Operations" category, which links to the new documentation for reviewing and sharing test suites.## What has changed?Please include a summary of the change.
This PR Resolves #(issue)
Type of change
Please delete options that are not relevant.
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: