Skip to content

Dev#18

Merged
Santhosh-testsigma merged 2 commits into
mainfrom
dev
May 7, 2025
Merged

Dev#18
Santhosh-testsigma merged 2 commits into
mainfrom
dev

Conversation

@Santhosh-testsigma
Copy link
Copy Markdown
Contributor

@Santhosh-testsigma Santhosh-testsigma commented May 7, 2025

Summary by CodeRabbit

  • New Features

    • Added "Interactive Demo" sections with embedded Storylane demos to several documentation pages, allowing users to explore features interactively.
    • Updated navigation cards to focus on Test Management topics, including a new entry for "Atto (Agentic AI ✨)".
  • Improvements

    • Changed the navigation label to "Atto (Beta)" and made it a clickable link to relevant documentation.
    • Updated the banner heading and subtitle on the Test Management documentation landing page for improved clarity.
    • Enhanced contextual navigation in documentation with new links to demo sections.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 7, 2025

Walkthrough

This update revises navigation elements and documentation to focus on "Atto" and Test Management. It replaces the "ATOM" label with an "Atto (Beta)" link, condenses navigation cards to Test Management topics, updates the main documentation banner, and adds interactive demo sections to several Atto generator agent documentation pages.

Changes

File(s) Change Summary
src/components/header.jsx Replaced static "ATOM" navigation div with an interactive "Atto (Beta)" anchor link pointing to Atto documentation, updated styling classes.
src/components/navcards.jsx Removed 28 broad navigation cards, replaced with 10 focused Test Management cards, including a new "Atto (Agentic AI ✨)" entry; all paths now under "/docs/test-management/".
src/pages/docs/test-management/index.jsx Updated banner heading from "Testsigma's Documentation Support" to "Test Management Documentation Support" and changed subtitle to "SETUP
src/pages/docs/test-management/atto/generator-agent/generate-tests-from-figma.md Added "Interactive Demo" section with embedded Storylane iframe and corresponding contextual navigation link.
src/pages/docs/test-management/atto/generator-agent/generate-tests-from-images.md Added "Interactive Demo" section with embedded Storylane iframe, styled container, and contextual navigation link.
src/pages/docs/test-management/atto/generator-agent/generate-tests-from-jira.md Added "Interactive Demo" link to contextual navigation; no other content changes.
src/pages/docs/test-management/atto/generator-agent/generate-tests-from-recording.md Added "Interactive Demo" section with embedded Storylane iframe and corresponding contextual navigation link.
src/pages/docs/test-management/atto/generator-agent/generate-tests-with-prompts.md Added "Interactive Demo" section with embedded Storylane iframe and corresponding contextual navigation link.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Header
    participant NavCards
    participant DocsPage

    User->>Header: Views navigation bar
    Header-->>User: Shows "Atto (Beta)" link
    User->>NavCards: Views navigation cards
    NavCards-->>User: Displays Test Management-focused cards incl. Atto
    User->>DocsPage: Opens Atto generator agent doc
    DocsPage-->>User: Shows "Interactive Demo" section with embedded demo
Loading

Possibly related PRs

  • Card changes #17: Makes identical changes to navigation and documentation structure, indicating direct relation.
  • Added few more docs #13: Renames and restructures navigation and documentation paths from "atom-in-action" to "atto" and adds Atto-related entries, closely related to this update.

Poem

🐇
A hop, a skip, a shiny new link,
"Atto (Beta)"—what do you think?
Cards condensed, the docs refined,
Interactive demos for all to find.
With every jump, the docs grow bright—
Atto leads us into the light!

✨ Finishing Touches
  • 📝 Generate Docstrings

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
src/pages/docs/test-management/atto/generator-agent/generate-tests-from-recording.md (1)

15-17: Well-implemented Interactive Demo enhances documentation

The new Interactive Demo section with a Storylane iframe effectively demonstrates the test generation from recording feature. The navigation and embedding are properly implemented.

Consider standardizing the use of markdown separators (---) across documentation files. There's an extra separator at line 44 that creates additional spacing.

  </div>
</div>

---
-
## **Generate Test Cases from Video Recording**
+## **Generate Test Cases from Video Recording**

Also applies to: 35-44

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1798bc8 and 4763fb0.

📒 Files selected for processing (8)
  • src/components/header.jsx (1 hunks)
  • src/components/navcards.jsx (2 hunks)
  • src/pages/docs/test-management/atto/generator-agent/generate-tests-from-figma.md (2 hunks)
  • src/pages/docs/test-management/atto/generator-agent/generate-tests-from-images.md (2 hunks)
  • src/pages/docs/test-management/atto/generator-agent/generate-tests-from-jira.md (1 hunks)
  • src/pages/docs/test-management/atto/generator-agent/generate-tests-from-recording.md (2 hunks)
  • src/pages/docs/test-management/atto/generator-agent/generate-tests-with-prompts.md (2 hunks)
  • src/pages/docs/test-management/index.jsx (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: CI
  • GitHub Check: StagingDeploy
🔇 Additional comments (12)
src/components/header.jsx (1)

47-52: Navigation improvement: "Atto (Beta)" is now properly linked

Converting the static "ATOM" label to a clickable "Atto (Beta)" link improves navigation and discoverability of the Atto documentation. The Beta indicator appropriately communicates the feature's development status to users.

src/pages/docs/test-management/atto/generator-agent/generate-tests-with-prompts.md (1)

15-17: Well-implemented Interactive Demo enhances documentation

The new Interactive Demo section with a Storylane iframe provides users with a hands-on way to understand the test generation feature. The navigation and embedding are properly implemented.

Also applies to: 35-42

src/pages/docs/test-management/atto/generator-agent/generate-tests-from-figma.md (2)

15-17: Navigation link added properly

The contextual link to the new Interactive Demo section has been added correctly in the table of contents.


35-42: Well-structured iframe implementation for the interactive demo

The interactive demo implementation looks good with appropriate iframe attributes and styling. The iframe includes necessary properties like loading="lazy" for performance and proper styling for responsiveness.

src/pages/docs/test-management/index.jsx (2)

19-19: Updated page title to reflect Test Management focus

The heading has been appropriately updated from "Testsigma's Documentation Support" to "Test Management Documentation Support" to align with the documentation's focus.


23-23: Updated workflow phases in the documentation banner

The workflow steps have been revised to include "GENERATE" and "EXECUTE" instead of "RUN" and "MAINTAIN", which better aligns with the Atto AI generation capabilities being highlighted in this update.

src/pages/docs/test-management/atto/generator-agent/generate-tests-from-images.md (2)

15-17: Navigation link added properly

The contextual link to the new Interactive Demo section has been correctly added to the table of contents.


35-42: Well-structured iframe implementation for the interactive demo

The interactive demo iframe implementation is properly configured with the necessary attributes and responsive styling. The embedded Storylane demo enhances the documentation with interactive content.

src/components/navcards.jsx (4)

7-12: Updated Introduction card to focus on Test Management

The card title and description have been appropriately updated to focus on Test Management, with the correct path to the relevant documentation.


14-18: Updated navigation cards for core Test Management features

The navigation cards have been properly updated with clear, descriptive titles and concise explanations of each Test Management feature. All paths correctly point to the /docs/test-management/ directory.

Also applies to: 19-24, 25-30, 31-36, 37-42, 43-48


55-60: Updated supporting feature cards with proper descriptions

The Integrations, Account Settings, and Manage Users cards have been updated with appropriate descriptions and correct paths.

Also applies to: 61-66, 67-72


73-78: Added new Atto AI card with clear description

The new "Atto (Agentic AI ✨)" card has been added with a descriptive explanation of its capabilities and the correct path to its documentation. This addition aligns with the PR's focus on highlighting Atto features.

Comment on lines +16 to +18
- type: link
name: "Interactive Demo"
url: "#interactive-demo"
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue

Missing Interactive Demo section creates broken navigation

The contextual link for "Interactive Demo" has been added, but the corresponding section with id "interactive-demo" does not exist in the document. When users click this link, they will encounter a broken navigation experience.

Either add the missing Interactive Demo section with the Storylane iframe (as done in other Atto documentation pages), or remove this navigation link.

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