New sections to docs

[TvisharajiK]

This pull request adds comprehensive documentation for advanced API testing features in Keploy, focusing on test suite management, assertion capabilities, test debugging, and workflow visualization. The new docs provide step-by-step guides and best practices for using features such as adding new test suites, bulk and custom assertions, schema validation, assertion trees, and debugging buggy test suites.

New and Enhanced Documentation:

• Test Suite Management:

  • Added a guide for creating new test suites, including manual entry and cURL import, to help users organize and initiate API test collections.

• Assertion Capabilities:

  • Introduced documentation for bulk assertions and schema validation, covering how to apply validations across multiple endpoints, filter tests, and enforce response structure and data types. Includes practical use cases and best practices.
  • Added a detailed guide on custom assertions, including using selected fields and custom JavaScript functions for advanced validation logic, with real-world examples and recommendations.

• Test Workflow Visualization:

  • Documented the Assertion Tree feature, enabling users to visualize, inspect, and modify test workflows in a hierarchical tree format. Explains interactive capabilities, use cases, and best practices for managing complex test flows.

• Debugging and Troubleshooting:

  • Added a comprehensive guide for identifying and fixing buggy test suites, with explanations for common failure reasons, assertion failures, debugging actions, and best practices for maintaining test quality.

[kilo-code-bot]

Code Review Summary

Status: 12 Issues Found | Recommendation: Address before merge

Overview

Severity	Count
CRITICAL	1
WARNING	8
SUGGESTION	3

Issue Details (click to expand)

CRITICAL

File	Line	Issue
versioned_docs/version-4.0.0/running-keploy/api-testing-add-suite.md	57	Malformed JSON - extra closing brace }} makes the example invalid

WARNING

File	Line	Issue
versioned_docs/version-4.0.0/running-keploy/api-testing-add-suite.md	4	Front-matter id (api-testing-add-suite) doesn't match filename pattern
versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md	67	Placeholder link (#) will render as broken link
versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md	79	"refer here" text with no actual link provided
versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md	16	Keywords (PreExecute, PostExecute) don't match document content
versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md	18	Tags include webhook/integration which don't match document topic
versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md	N/A	Missing ProductTier component import and usage
versioned_docs/version-4.0.0/running-keploy/api-testing-local-agent.md	N/A	"Keplr" typo should be "Keploy" (appears multiple times)
versioned_sidebars/version-4.0.0-sidebars.json	N/A	Sidebar doesn't include all newly added documentation files

SUGGESTION

File	Line	Issue
versioned_docs/version-4.0.0/running-keploy/api-testing-buggy-suites.md	N/A	Typo: "esclamation" should be "exclamation"
versioned_docs/version-4.0.0/running-keploy/api-testing-edit-assertions.md	N/A	Naming conventions section mixes camelCase and snake_case inconsistently
versioned_docs/version-4.0.0/running-keploy/api-testing-local-agent.md	N/A	"test sheets" appears to be inconsistent terminology

Files Reviewed (27 files)

• src/css/custom.css - 0 issues (CSS styling changes)
• src/theme/Heading/styles.module.css - 0 issues (CSS styling changes)
• tailwind.config.js - 0 issues (Tailwind config updates)
• versioned_docs/version-3.0.0/running-keploy/generate-api-tests-using-ai.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-add-suite.md - 2 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-adding-labels.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-assertion-tree.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-auth-setup.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-buggy-suites.md - 1 issue
• versioned_docs/version-4.0.0/running-keploy/api-testing-bulk-assertions.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-custom-assertions.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-edit-assertions.md - 1 issue
• versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md - 4 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-filter-suites.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-functions.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-generation-history.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-local-agent.md - 2 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-mark-unbuggy.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-run-report.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-running-selective.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-schema-coverage.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-sharing-reports.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-suite-settings.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/api-testing-variables.md - 1 issue
• versioned_docs/version-4.0.0/running-keploy/self-healing-ai-api-tests.md - 0 issues
• versioned_docs/version-4.0.0/running-keploy/share-tests.md - 0 issues
• versioned_sidebars/version-4.0.0-sidebars.json - 1 issue
• Binary image files (7 files) - Not reviewed

---

Fix these issues in Kilo Cloud

[Copilot]

Pull request overview

This PR expands the Keploy v4.0.0 documentation set for advanced API testing workflows, covering suite management, assertions, debugging, reporting, and visualization, and wires the new pages into the v4 sidebar navigation.

Changes:

• Added multiple new running-keploy docs for API testing workflows (suite actions, selective runs, labeling, reports, schema coverage, debugging, etc.).
• Updated the v4.0.0 sidebar to include the new API testing documentation pages.
• Introduced “Fix with AI” documentation (currently not linked from the sidebar).

Reviewed changes

Copilot reviewed 19 out of 19 changed files in this pull request and generated 10 comments.

Show a summary per file

File	Description
versioned_sidebars/version-4.0.0-sidebars.json	Adds many new API Testing doc entries to the v4 sidebar (but currently misses “Fix with AI”).
versioned_docs/version-4.0.0/running-keploy/api-testing-suite-settings.md	New guide for suite panel settings/actions (share/run/bulk edits/variables/functions/CI).
versioned_docs/version-4.0.0/running-keploy/api-testing-sharing-reports.md	New guide for sharing run reports within a workspace.
versioned_docs/version-4.0.0/running-keploy/api-testing-schema-coverage.md	New guide for schema coverage analysis and generating tests for missing coverage.
versioned_docs/version-4.0.0/running-keploy/api-testing-running-selective.md	New guide for selectively running suites via checkbox/bulk actions.
versioned_docs/version-4.0.0/running-keploy/api-testing-run-report.md	New guide for understanding and filtering run reports.
versioned_docs/version-4.0.0/running-keploy/api-testing-mark-unbuggy.md	New guide for marking suites as unbuggy after fixes.
versioned_docs/version-4.0.0/running-keploy/api-testing-local-agent.md	New guide for using the local agent for private/local endpoints.
versioned_docs/version-4.0.0/running-keploy/api-testing-generation-history.md	New guide for viewing and using test generation job history.
versioned_docs/version-4.0.0/running-keploy/api-testing-fixing-ai.md	New “Fix with AI” doc explaining AI-assisted repair/normalization of failing suites.
versioned_docs/version-4.0.0/running-keploy/api-testing-filter-suites.md	New guide for filtering suites by endpoint/method/status/etc.
versioned_docs/version-4.0.0/running-keploy/api-testing-edit-suites.md	New guide for editing suites/steps/assertions (contains placeholder/incomplete references + metadata issues).
versioned_docs/version-4.0.0/running-keploy/api-testing-edit-assertions.md	New detailed doc for variables + custom assertions/functions (includes conflicting naming guidance).
versioned_docs/version-4.0.0/running-keploy/api-testing-custom-assertions.md	New overview doc for assertion types and advanced custom function use.
versioned_docs/version-4.0.0/running-keploy/api-testing-bulk-assertions.md	New guide for bulk assertions and schema validation across many tests.
versioned_docs/version-4.0.0/running-keploy/api-testing-buggy-suites.md	New guide for diagnosing and fixing buggy suites (contains a typo).
versioned_docs/version-4.0.0/running-keploy/api-testing-assertion-tree.md	New guide for visualizing workflows via the Assertion Tree.
versioned_docs/version-4.0.0/running-keploy/api-testing-adding-labels.md	New guide for labeling suites (individual + bulk).
versioned_docs/version-4.0.0/running-keploy/api-testing-add-suite.md	New guide for adding a suite (front-matter id currently mismatches the sidebar entry).

---

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