Skip to content

Updated the Atto docs#850

Merged
bharathk08 merged 1 commit intodevfrom
fix/DOC-452-1
Nov 27, 2025
Merged

Updated the Atto docs#850
bharathk08 merged 1 commit intodevfrom
fix/DOC-452-1

Conversation

@Nandhini4501
Copy link
Contributor

@Nandhini4501 Nandhini4501 commented Nov 27, 2025

Updated the Atto docs as per the ticket https://testsigma.atlassian.net/browse/DOC-452

image

Summary by CodeRabbit

  • Documentation
    • Updated test case generation documentation with reorganized workflow and simplified prerequisites.
    • Enhanced guidance on managing updated test cases, including comparison features and change tracking.
    • Streamlined documentation structure for improved clarity and user experience.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 27, 2025

Walkthrough

Atto test case generation documentation is reorganized and consolidated. One file is extensively revised with updated navigation, rewritten procedural steps reflecting a new user workflow (Prompt entry → AI generation → selection → editing → refinement → automated step generation → acceptance), refreshed image references, and a new "Manage Updated Test Cases" section. A second file is removed.

Changes

Cohort / File(s) Summary
Atto test case generation documentation
src/pages/docs/atto/generative-ai/generate-tests/automate-test-cases.md
Major revision: metadesc updated, page order resequenced, contextual navigation links reorganized, introduction reworded, section header renamed to "Steps to Generate Automated Test Cases," step-by-step workflow rewritten (now focusing on prompt entry, AI generation, case selection, editing, refinement, automated step generation, and acceptance), image references updated to new assets, and new "Manage Updated Test Cases" section added with UI guidance.
Removed documentation file
src/pages/docs/atto/generative-ai/generate-tests/automated-test-cases.md
File deleted. Previously contained page metadata, contextual navigation, prerequisites, and detailed sections on generating automated test cases (nine procedural steps with images) and managing updated test cases.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Atto as Atto Platform
    participant AI
    participant Explorer as Test Case Explorer

    User->>Atto: Enter prompt describing test scenario
    Atto->>AI: Generate initial test cases
    AI-->>Atto: Return generated test cases
    Atto-->>User: Display generated test cases
    
    User->>Atto: Review and select test cases
    User->>Atto: Edit and refine selected cases
    User->>Atto: Request "Generate Automated Steps"
    
    Atto->>AI: Convert steps to NLP-based automated steps
    AI-->>Atto: Return automated steps
    
    User->>Atto: Accept/confirm results
    Atto-->>Explorer: Store updated test cases with "Update" tag
    Explorer-->>User: Viewable in Test Case Explorer
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • Review focuses on documentation accuracy and content coherence rather than code logic
  • Changes are primarily text rewrites, reorganization, and link updates
  • File deletion is straightforward; verify removal is intentional and not needed elsewhere
  • Confirm image asset paths and references are correct and all links resolve properly

Possibly related PRs

  • Updated the docs under the "Atto" section #846: Modifies the same Atto generative test-case documentation files with similar step reordering, image path updates, and refinement of the "Generate Automated Steps" workflow.
  • Updated the Atto docs #849: Directly edits the same documentation path (src/pages/docs/atto/generative-ai/generate-tests/) affecting automate-test-cases.md and automated-test-cases.md with overlapping navigation and content changes.

Suggested reviewers

  • bharathk08
  • Santhosh-testsigma

Poem

🐰 A doc-hunter's delight,
Prompts dance into automated light,
Steps refined, workflows bright,
Test cases spring into sight—
Atto's magic takes flight!

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Updated the Atto docs' is vague and generic, using non-descriptive language that doesn't convey specific information about what changed in the documentation. Replace with a more specific title that describes the primary change, such as 'Refactor Atto test case generation documentation' or 'Update Atto automated test case generation workflow docs.'
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch fix/DOC-452-1

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ddee186 and 6439994.

📒 Files selected for processing (2)
  • src/pages/docs/atto/generative-ai/generate-tests/automate-test-cases.md (2 hunks)
  • src/pages/docs/atto/generative-ai/generate-tests/automated-test-cases.md (0 hunks)
💤 Files with no reviewable changes (1)
  • src/pages/docs/atto/generative-ai/generate-tests/automated-test-cases.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: CI
🔇 Additional comments (4)
src/pages/docs/atto/generative-ai/generate-tests/automate-test-cases.md (4)

1-21: Metadata updates look good.

The file metadata is properly updated with accurate descriptions and navigation links for the new section. The order change (4.7422) appears reasonable for the documentation hierarchy.


63-80: All image URLs in the "Manage Updated Test Cases" section are accessible and valid.

Verification confirms all three S3 images referenced in lines 63–80 are accessible (HTTP 200):

  • updated_test_cases_1.png
  • updated_test_cases_2.png
  • updated_test_cases_3.png

The section content is accurate and the images will display correctly for users.


29-31: External documentation link is valid and accessible.

Verification confirms that the prerequisites link (https://testsigma.com/docs/atto/generative-ai/generate-tests/requirements/) returns HTTP 200 status. The external documentation is reachable and users can access the prerequisite guidance referenced in the file.


34-60: All image URLs are accessible and working correctly.

Verification confirms that all 7 S3 image URLs referenced in the workflow steps (next_steps_req_1.png through next_steps_req_7.png) return HTTP 200 and are properly accessible. The documentation has the necessary visual assets to support the workflow steps without any broken links or missing images.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@bharathk08 bharathk08 merged commit 8ea06c7 into dev Nov 27, 2025
3 of 4 checks passed
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.

2 participants