Skip to content

Updated Step Groups doc with Global Step Group Update#853

Merged
bharathk08 merged 1 commit intodevfrom
DOC-496
Nov 28, 2025
Merged

Updated Step Groups doc with Global Step Group Update#853
bharathk08 merged 1 commit intodevfrom
DOC-496

Conversation

@bharathk08
Copy link
Contributor

@bharathk08 bharathk08 commented Nov 28, 2025

Updated Step Groups doc with a section 'Use a Step Group Between Projects'
image

Summary by CodeRabbit

  • Documentation
    • Restructured and updated Step Group documentation with clearer, more concise instructions and improved organization.
    • Added new comprehensive guidance for reusing Step Groups across multiple projects and applications.
    • Refreshed all examples, screenshots, UI references, and navigation links throughout the documentation.
    • Applied consistent terminology and formatting improvements across all sections.

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

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 28, 2025

Walkthrough

Documentation updates to the step-group guidance page including front matter modification, new contextual navigation links, expanded cross-project reuse instructions, image URL updates, and content rewording for consistency and clarity.

Changes

Cohort / File(s) Change Summary
Documentation Update
src/pages/docs/test-cases/step-types/step-group.md
Updated front matter page_id from "Test step type: Step groups" to "test-step-type-step-groups"; added contextual navigation link for cross-project step group usage; rewrote sections for consistency; updated image URLs to reflect new asset structure; expanded content with new steps for creating and reusing step groups between projects; standardized UI label references and terminology throughout.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5–10 minutes

  • Single documentation file with content and formatting updates
  • No code logic or functional changes
  • Consistent pattern of rewording and structural adjustments throughout

Possibly related PRs

Suggested reviewers

  • Santhosh-testsigma

Poem

🐰 With words rearranged and links made new,
Step groups now guide what users should do,
From project to project, the flow is clear,
Documentation hops forward, with cheer! 📚✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Title check ❓ Inconclusive The title mentions 'Global Step Group Update' but the PR primarily updates documentation with rewording, image replacements, and a new section on reusing step groups between projects, not a global feature update. Clarify the title to better reflect the actual changes, such as 'Update Step Groups documentation with cross-project reuse section' or similar.
✅ 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 DOC-496

Tip

📝 Customizable high-level summaries are now available in beta!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

  • Provide your own instructions using the high_level_summary_instructions setting.
  • Format the summary however you like (bullet lists, tables, multi-section layouts, contributor stats, etc.).
  • Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example instruction:

"Divide the high-level summary into five sections:

  1. 📝 Description — Summarize the main change in 50–60 words, explaining what was done.
  2. 📓 References — List relevant issues, discussions, documentation, or related PRs.
  3. 📦 Dependencies & Requirements — Mention any new/updated dependencies, environment variable changes, or configuration updates.
  4. 📊 Contributor Summary — Include a Markdown table showing contributions:
    | Contributor | Lines Added | Lines Removed | Files Changed |
  5. ✔️ Additional Notes — Add any extra reviewer context.
    Keep each section concise (under 200 words) and use bullet or numbered lists for clarity."

Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later.


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.

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: 2

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ed32181 and b0ea464.

📒 Files selected for processing (1)
  • src/pages/docs/test-cases/step-types/step-group.md (4 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/docs/test-cases/step-types/step-group.md

[grammar] ~52-~52: Ensure spelling is correct
Context: ...te a New Step Group** 1. From the left navigatio bar, go to **Create Tests > Step Groups...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~66-~66: Use a hyphen to join words.
Context: ...NOTE:]] | You can also create a data driven step group by associating a test ...

(QB_NEW_EN_HYPHEN)


[grammar] ~79-~79: Ensure spelling is correct
Context: ...Edit a Step Group 1. From the left navigatio bar, go to **Create Tests > Step Groups...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[style] ~90-~90: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...k kebab menu next to the step group you want to delete and click Delete. ![Delet...

(REP_WANT_TO_VB)


[grammar] ~109-~109: Ensure spelling is correct
Context: ... Specific Test Case** 1. From the left navigatio bar, go to *Create Tests > Test Cases...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~128-~128: Ensure spelling is correct
Context: ...up From a Test Case** 1. From the left navigatio bar, go to *Create Tests > Test Cases...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~151-~151: Ensure spelling is correct
Context: ...roup in a Test Case** 1. From the left navigatio bar, go to *Create Tests > Test Cases...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[style] ~153-~153: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...se or open a Test Case in which you want to add a step group. 3. On the test case...

(REP_WANT_TO_VB)


[style] ~158-~158: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...list overlay, select the step group you want to add. ![Step Group Overlay](https://...

(REP_WANT_TO_VB)


[grammar] ~166-~166: Use a hyphen to join words.
Context: ... | NOTE:]] | You can also add a data driven step group to a data driven test ...

(QB_NEW_EN_HYPHEN)


[grammar] ~166-~166: Use a hyphen to join words.
Context: ...o add a data driven step group to a data driven test case. This allows iterating ...

(QB_NEW_EN_HYPHEN)


[style] ~174-~174: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...natively, open a test case in which you want to add a step group. 3. On the test case ...

(REP_WANT_TO_VB)

⏰ 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 (3)
src/pages/docs/test-cases/step-types/step-group.md (3)

6-6: ✓ Page ID normalization looks good.

The front-matter change from "Test step type: Step groups" to a URL-friendly format follows documentation best practices.


29-31: ✓ Navigation link addition is appropriate.

The new contextual link for "Use a Step Group Between Projects" aligns with the expanded content added in the new section.


170-193: ✓ New section on cross-project step group reuse is comprehensive and well-structured.

The new "Use a Step Group Between Projects" section provides clear step-by-step instructions with supporting screenshots. The inclusion of the project/application/version selection flow and the note about supported platforms (Web, Android, iOS) is helpful for users.

Please verify that all image URLs referenced in this section (lines 179, 184, 187) are accessible and point to valid documentation assets.


1. Enter **Name** and create steps manually by clicking on **Add new step**.
![Name & New Step](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sgnameastep.png)
1. From the left navigatio bar, go to **Create Tests > Step Groups**, click **Create Step Group**.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Fix spelling: "navigatio" → "navigation".

The phrase "From the left navigatio bar" appears on multiple lines (52, 79, 109, 128, 151). This is a typo that should be corrected to "navigation".

Apply this fix across all occurrences:

- From the left navigatio bar, go to
+ From the left navigation bar, go to

Also applies to: 79-79, 109-109, 128-128, 151-151

🧰 Tools
🪛 LanguageTool

[grammar] ~52-~52: Ensure spelling is correct
Context: ...te a New Step Group** 1. From the left navigatio bar, go to **Create Tests > Step Groups...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
In src/pages/docs/test-cases/step-types/step-group.md around lines 52, 79, 109,
128, and 151, the word "navigatio" is misspelled; replace every occurrence of
"navigatio bar" with "navigation bar" so the sentence reads "From the left
navigation bar, go to **Create Tests > Step Groups**, click **Create Step
Group**." Ensure all five listed lines are updated consistently.



[[info | **NOTE**:]]
| You can also create a data driven step group by associating a test data profile from the step group settings. Follow the steps below to associate a test data profile.
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Use hyphenated "data-driven" for consistency with standard terminology.

Lines 66 and 166 use "data driven" (two words). Technical documentation typically hyphenates compound adjectives: "data-driven".

Apply this fix on both lines:

- You can also create a data driven step group
+ You can also create a data-driven step group
- You can also add a data driven step group to a data driven test case
+ You can also add a data-driven step group to a data-driven test case

Also applies to: 166-166

🧰 Tools
🪛 LanguageTool

[grammar] ~66-~66: Use a hyphen to join words.
Context: ...NOTE:]] | You can also create a data driven step group by associating a test ...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
In src/pages/docs/test-cases/step-types/step-group.md at lines 66 and 166, the
phrase "data driven" is used but should be hyphenated as "data-driven"; update
both occurrences to use the hyphenated compound adjective "data-driven" to match
standard terminology and maintain consistency across the document.

@bharathk08 bharathk08 merged commit fec2498 into dev Nov 28, 2025
3 of 4 checks passed
@bharathk08 bharathk08 deleted the DOC-496 branch November 28, 2025 13:27
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