Skip to content

Updated Atto docs as per feedback.#705

Merged
bharathk08 merged 1 commit intodevfrom
fix/IDEA-2379
Jul 1, 2025
Merged

Updated Atto docs as per feedback.#705
bharathk08 merged 1 commit intodevfrom
fix/IDEA-2379

Conversation

@bharathk08
Copy link
Contributor

@bharathk08 bharathk08 commented Jul 1, 2025

Updated Atto docs as per the feedback

Summary by CodeRabbit

  • Documentation
    • Updated terminology from "Data Generator" to "Test Data Generator" across navigation and documentation for improved clarity.
    • Revised section names and notes for better guidance in test case generation and live editor usage.
    • Added an informational note with a link to "Terminal FAQs" in the Live Editor documentation.
    • Improved grammar and clarity in instructions for generating mobile test cases.

Updated Atto docs as per the feedback
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jul 1, 2025

Walkthrough

This update standardizes terminology across documentation by renaming "Data Generator" to "Test Data Generator" in navigation and content. Section headers and contextual links are clarified, and minor grammatical corrections are made. An informational note with troubleshooting resources is added to the Live Editor documentation.

Changes

Files/Paths Change Summary
src/left-nav-title.json Renamed navigation key, path, and title from "data-generator" to "test-data-generator".
src/pages/docs/atto/ai-agents/generator.md Updated section/link names and clarified note on test case acceptance.
src/pages/docs/atto/ai-agents/test-data-generator.md Changed all occurrences of "Data Generator" to "Test Data Generator".
src/pages/docs/atto/generative-ai/copilot/live-editor.md Added informational note linking to Terminal FAQs at the end of a section.
src/pages/docs/atto/generative-ai/generate-tests/mobile.md Fixed minor grammatical issues and adjusted step formatting.

Suggested reviewers

  • divesmehta11

Poem

In the warren of docs, we hop and we scurry,
Renaming our carrots—no need to hurry!
"Test Data Generator" now leads the parade,
With notes and corrections, improvements are made.
A link to FAQs, and grammar made neat—
This bunny’s documentation is tidy and sweet!
🐇✨


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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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
Contributor

@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: 0

🔭 Outside diff range comments (2)
src/pages/docs/atto/ai-agents/test-data-generator.md (1)

2-8: page_id is now inconsistent with the new slug

You renamed everything to “test-data-generator” but kept the legacy page_id: "data-generator".
This breaks deep-linking, anchor generation, and the new left-nav mapping.

-page_id: "data-generator"
+page_id: "test-data-generator"
src/left-nav-title.json (1)

728-735: Duplicate key live-editor overrides previous entry

JSON objects cannot have duplicate keys; the earlier mapping to /docs/live-editor/ is silently lost by the later one for Atto Copilot.
Rename one of them (example: copilot-live-editor) and adjust inbound links.

-"live-editor": {"/docs/atto/generative-ai/copilot/live-editor/": "In Live Editor"},
+"copilot-live-editor": {"/docs/atto/generative-ai/copilot/live-editor/": "In Live Editor"},
🧹 Nitpick comments (5)
src/pages/docs/atto/generative-ai/copilot/live-editor.md (1)

61-63: Prefer relative paths for internal documentation links

Hard-coding the full https://testsigma.com/docs/... URL makes local previews, forked deployments, or future domain moves brittle. Use a root-relative link instead:

-> For troubleshooting details and frequently asked questions, see [Terminal FAQs](https://testsigma.com/docs/live-editor/faqs-on-testsigma-terminal/).
+> For troubleshooting details and frequently asked questions, see [Terminal FAQs](/docs/live-editor/faqs-on-testsigma-terminal/).
src/pages/docs/atto/ai-agents/test-data-generator.md (2)

22-22: Minor grammar – missing definite article

“This article discusses using Test Data Generator …”

Insert “the” for smoother reading.

-This article discusses using Test Data Generator to create
+This article discusses using the Test Data Generator to create

49-50: Passive wording – tighten the sentence

“Wait for the Test Data Generator to create data for the selected fields.”
Currently fine but consider “Generate” rather than “Wait” to keep instructions action-oriented.

src/pages/docs/atto/generative-ai/generate-tests/mobile.md (1)

68-68: Verb duplication—remove trailing fragment

to generate multiple test cases based on the selected inputs is enough; “…are generated” is redundant.

-Wait for **Generator Agent** to generate multiple test cases based on the selected inputs.
+Wait for **Generator Agent** to generate multiple test cases based on the selected inputs.
src/pages/docs/atto/ai-agents/generator.md (1)

64-65: Grammar: double verb in sentence

“Wait for Generator Agent to generate multiple test cases are generated…”

Remove the trailing clause:

-Wait for Generator Agent to generate multiple test cases are generated based on the selected inputs. 
+Wait for the Generator Agent to generate multiple test cases based on the selected inputs. 
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5249cc2 and 8894a4f.

📒 Files selected for processing (5)
  • src/left-nav-title.json (1 hunks)
  • src/pages/docs/atto/ai-agents/generator.md (3 hunks)
  • src/pages/docs/atto/ai-agents/test-data-generator.md (3 hunks)
  • src/pages/docs/atto/generative-ai/copilot/live-editor.md (1 hunks)
  • src/pages/docs/atto/generative-ai/generate-tests/mobile.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/docs/atto/ai-agents/test-data-generator.md

[uncategorized] ~22-~22: You might be missing the article “the” here.
Context: ...ata entry. This article discusses using Test Data Generator to create and customize ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: CI
🔇 Additional comments (4)
src/pages/docs/atto/generative-ai/generate-tests/mobile.md (1)

74-74: Heading demotion removed step number—align list numbering

Removing the number is fine, but update the preceding ordered list so that Markdown doesn’t restart numbering at 1 in rendered HTML. A simple <!-- --> comment or explicit 8. keeps the sequence intact.

src/left-nav-title.json (1)

734-735: New test-data-generator entry looks good

Path and title align with the renamed page.

src/pages/docs/atto/ai-agents/generator.md (2)

16-20: Contextual-link text updated—good catch

The new phrasing is clearer and matches the header anchor.


98-100: Clarified acceptance note—nice improvement

The conditional guidance is clearer and more actionable.

@bharathk08 bharathk08 merged commit e1f2acb into dev Jul 1, 2025
3 of 4 checks passed
@bharathk08 bharathk08 deleted the fix/IDEA-2379 branch July 1, 2025 06:39
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