Skip to content

Conversation

@Santhosh-testsigma
Copy link
Contributor

@Santhosh-testsigma Santhosh-testsigma commented Oct 17, 2025

Summary by CodeRabbit

  • Documentation
    • Updated documentation across many areas with new and replaced visuals (screenshots replacing GIFs), improved inline images, and refreshed image paths.
    • Reordered and reflowed step-by-step procedures for clearer sequencing and navigation.
    • Added more granular, image-rich steps and improved notes (including expanded runtime variable guidance).
    • Streamlined some lists into visual references for clarity.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 17, 2025

Walkthrough

This PR updates 16+ documentation files across multiple feature areas by replacing image asset references, restructuring procedural steps with enhanced visuals, and reorganizing content presentation. Changes maintain original procedural logic while modernizing visual documentation with new PNG assets and improved step-by-step layouts.

Changes

Cohort / File(s) Summary
Image Asset URL Updates
src/pages/docs/runs/adhoc-runs.md, src/pages/docs/runs/test-plan-executions.md, src/pages/docs/salesforce-testing/special-nlps.md
Replaced multiple inline image references across documentation sections with updated asset paths (GIF → PNG conversions, run-specific and NLP image replacements).
Test Data Documentation Assets
src/pages/docs/test-data/types/raw.md, src/pages/docs/test-data/types/environment.md, src/pages/docs/test-data/types/runtime.md, src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md, src/pages/docs/test-data/data-generators/namefunctions-function-type.md
Updated image asset references to point to test_data paths; replaced GIFs with PNGs; adjusted step ordering and notes (runtime variable note extended).
Test Step & Test Case Documentation
src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md, src/pages/docs/visual-testing/configure-test-steps.md
Replaced animated GIFs with static PNGs; added Step Settings image; updated Global Timeouts explanation and reflowed visual references for overlay actions.
Multi-Step Procedure Restructuring
src/pages/docs/addons/update.md, src/pages/docs/configuration/api-keys.md, src/pages/docs/desired-capabilities/network-logs.md, src/pages/docs/elements/dynamic-elements/with-parameter-test-data.md
Expanded single steps into granular multi-step sequences, added inline images for each step, renumbered steps and adjusted surrounding text/indentation.
Configuration & Planning Documentation
src/pages/docs/test-plans/email-configuration.md, src/pages/docs/test-suites/overview.md
Added multiple inline images and restructured step sequences; removed explicit notification bullet list in favor of image references; updated UI wording (e.g., "left-side navigation bar").

Sequence Diagram(s)

sequenceDiagram
  participant User
  participant DocsUI as "Docs UI"
  participant Addons as "Addons Page"
  participant MyAddons as "My Addons"
  participant Upload as "Upload Code"
  participant Publish as "Publish Flow"

  User->>DocsUI: open documentation
  DocsUI->>Addons: navigate to Addons section
  Addons->>MyAddons: click My Addons (new explicit step)
  MyAddons->>Upload: choose "Upload Code" (new step + image)
  Upload->>Publish: upload and follow Publish steps (reordered, image-rich)
  Publish-->>User: updated addon published
  Note over Upload,Publish: Steps reorganized into granular, image-supported sequence
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Suggested reviewers

  • bharathk08

Poem

🥕 New images hop into view today,
Steps unfurled in a clearer display,
PNGs snug where GIFs once played,
Reflowed and numbered—no step delayed,
A rabbit cheers: docs polished all the way!

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The pull request title "Replaced GIFs with screenshots" accurately reflects a significant and consistent theme across the changeset. The raw summaries show that replacing GIF image references with PNG/static image assets is a primary change applied across virtually all 20+ modified documentation files. While the PR also includes step restructuring, renumbering, and content reorganization (evident in files like "addons/update.md" and "configuration/api-keys.md"), the image asset replacement is the unifying theme that connects all changes. The title is concise, clear, and specific enough for a teammate to understand the focus, even if it doesn't capture every aspect of the modifications.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch DOC-354-1

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/pages/docs/desired-capabilities/network-logs.md (1)

83-83: GIF at line 83 should be replaced with PNG screenshot per PR's stated objective.

The PR commit message indicates a comprehensive GIF-to-PNG replacement effort. However, the git diff confirms that while networklogs_adhoc.gif and networklogs_testplan.gif were replaced with Logs_1.png through Logs_6.png, the view_networklogs.gif reference at line 83 remains unchanged. This creates an inconsistency within the same file where earlier GIFs were replaced but this one was not.

Confirm: Should view_networklogs.gif be replaced? If yes, provide the correct PNG asset filename.

🧹 Nitpick comments (10)
src/pages/docs/configuration/api-keys.md (1)

39-39: Fix image caption and formatting consistency.

The image caption on line 39 is "Generate API Key", but this step describes displaying and copying the key, not generating it. Additionally, the image is placed inline within the step text, whereas images in steps 1–4 are on separate lines. Align the formatting and correct the caption.

-5. The API key will be displayed on the screen. Click the **Copy API Key** button to copy it to your clipboard for use in your applications or scripts. ![Generate API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/API_key_5.png)
+5. The API key will be displayed on the screen. Click the **Copy API Key** button to copy it to your clipboard for use in your applications or scripts.
+   ![Copy API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/API_key_5.png)
src/pages/docs/runs/test-plan-executions.md (1)

73-73: Consider rephrasing to improve readability.

The phrase "according to how you want to select" echoes similar phrasing in nearby sentences (line 65-66). Consider varying the wording for better flow.

For example, you could rephrase to: "On the Partial Test Plan Run overlay, configure the options to specify which test cases to execute:"

src/pages/docs/addons/update.md (1)

39-50: Standardize image placement for consistency.

Images are placed inconsistently across the steps:

  • Lines 40, 42, 44: Images on separate indented lines
  • Line 45: Image inline at end of step text
  • Line 49: Image below bullet points

Reformat to place all step images on their own indented line immediately after the step text for visual consistency and readability.

Apply this diff:

-5. In **Upload Zip File** Overlay, Browse and select the zipped file, then click **Update**. ![update addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addon/Addon_4.1.png)
+5. In **Upload Zip File** Overlay, Browse and select the zipped file, then click **Update**.
+   ![update addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addon/Addon_4.1.png)

And for lines 46–49:

 6. After uploading the code, click on **Publish** from the dropdown menu. Then, choose your publish options:
     - **Public**: Make the addon available to the entire Testsigma community.
     - **Private**: Restrict availability to users within your organization.
-     ![Publish](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addon/Addon_5.png)
+   ![Publish](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addon/Addon_5.png)
src/pages/docs/test-suites/overview.md (2)

47-47: Standardize navigation terminology across the document.

Navigation references use both "left-side navbar" (lines 47, 60) and "left-side navigation bar" (lines 103, 128). Choose one consistent term and apply it throughout.

Apply this diff to standardize on "left-side navigation bar":

- Navigate to **Test Suites** in the left-side navbar.
+ Navigate to **Test Suites** in the left-side navigation bar.

Replace at lines 47 and 60 to match lines 103 and 128.

Also applies to: 60-60, 103-103, 128-128


108-108: Clarify step transition after inline bullet methods.

After the two bullet-point methods under step 2 (lines 107–108), the next statement "You can view Test Cases..." should be explicitly numbered as step 3 to avoid ambiguity about whether it's a sub-step or a new step. Consider adding a clear line break or explicit numbering.

This would improve readability for users scanning the procedural steps.

src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md (1)

70-70: Move image to new line for consistent list formatting.

The image at line 70 is placed inline with the list item text. For consistency with lines 67 and 69, move the image reference to a new line after the step text.

- 4. Select **MailboxAliasFunctions** from the **Function Type** dropdown list. ![select mailboxaliasfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/test_data/Mailbox_3.png)
+ 4. Select **MailboxAliasFunctions** from the **Function Type** dropdown list.
+    ![select mailboxaliasfunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/test_data/Mailbox_3.png)
src/pages/docs/test-data/data-generators/namefunctions-function-type.md (1)

45-45: Move image to new line for consistent list formatting.

The image at line 45 is placed inline with the list item text. For consistency with lines 42 and 44, move the image reference to a new line after the step text.

- 4. Select **NameFunctions** from the **Function Type** dropdown list. ![select namefunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/test_data/Name_function_3.png)
+ 4. Select **NameFunctions** from the **Function Type** dropdown list.
+    ![select namefunctions function type from data generators](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/test_data/Name_function_3.png)
src/pages/docs/test-plans/email-configuration.md (1)

44-44: Minor: Reduce writing style repetition for clarity.

Both lines 44 and 48 use the phrase "If you want to," which repeats unnecessarily. Consider varying the phrasing to improve readability. For example, line 48 could use "Prefer to receive notifications via chat?" or similar alternative phrasing.

Also applies to: 48-48

src/pages/docs/visual-testing/configure-test-steps.md (2)

96-96: Fix sentence structure or punctuation after image reference.

Line 96 reads: "Re-Run the test case to enable visual testing and see any visual differences. Rerun Test Case"

The sentence structure appears awkward with the image caption placed inline. Consider either moving the image to a new line or rephrasing the sentence for better flow. As written, it reads as incomplete after the image reference.


101-101: Clarify formatting for options list.

Line 101 introduces "In Visual Difference overlay, you can perform the following options:" followed immediately by bullet points. Verify that the colon and formatting are properly rendered. This may require a line break or markdown adjustment for clarity depending on the rendering engine.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 542af5a and 68227cc.

📒 Files selected for processing (16)
  • src/pages/docs/addons/update.md (1 hunks)
  • src/pages/docs/configuration/api-keys.md (1 hunks)
  • src/pages/docs/desired-capabilities/network-logs.md (1 hunks)
  • src/pages/docs/elements/dynamic-elements/with-parameter-test-data.md (2 hunks)
  • src/pages/docs/runs/adhoc-runs.md (8 hunks)
  • src/pages/docs/runs/test-plan-executions.md (4 hunks)
  • src/pages/docs/salesforce-testing/special-nlps.md (19 hunks)
  • src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md (3 hunks)
  • src/pages/docs/test-data/data-generators/mailboxaliasfunctions-function-type.md (1 hunks)
  • src/pages/docs/test-data/data-generators/namefunctions-function-type.md (1 hunks)
  • src/pages/docs/test-data/types/environment.md (4 hunks)
  • src/pages/docs/test-data/types/raw.md (2 hunks)
  • src/pages/docs/test-data/types/runtime.md (2 hunks)
  • src/pages/docs/test-plans/email-configuration.md (1 hunks)
  • src/pages/docs/test-suites/overview.md (2 hunks)
  • src/pages/docs/visual-testing/configure-test-steps.md (6 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/docs/test-data/types/environment.md

[grammar] ~96-~96: Ensure spelling is correct
Context: ...data/Environment_5.png) 2. Click Add Varibale. This will open the **Add Environment...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~102-~102: There might be a mistake here.
Context: ...Environment_7.png) [[info | NOTE:]] | Variable names should be unique an...

(QB_NEW_EN)


[style] ~103-~103: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...Variable names should be unique and can not be changed once added. 4. Once the **...

(CAN_NOT_PREMIUM)


[grammar] ~144-~144: There might be a mistake here.
Context: ...nt Parameter Name** to add the filters. use environment variables to select test data values 6. When you run the test case, it will exec...

(QB_NEW_EN)

src/pages/docs/test-suites/overview.md

[grammar] ~60-~60: There might be a mistake here.
Context: ...ht corner of the Test Suites List page. ![Create Test Cases](https://s3.amazonaw...

(QB_NEW_EN)


[grammar] ~106-~106: There might be a mistake here.
Context: ...case using any of the following methods: - Click on the ellipsis icon for the *...

(QB_NEW_EN)


[style] ~108-~108: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...png) - Click the Test Suite you want to edit and open the Test Suite Details Pa...

(REP_WANT_TO_VB)


[grammar] ~108-~108: There might be a mistake here.
Context: ...it and open the Test Suite Details Page. 3. You can view Test Cases and **Test P...

(QB_NEW_EN)


[grammar] ~118-~118: There might be a mistake here.
Context: ...ere and view information about the Test Suite's creation and last update. ![Test Sui...

(QB_NEW_EN)


[grammar] ~121-~121: There might be a mistake here.
Context: ...d view the History and Comments of test suite. ![Activity](https://s3....

(QB_NEW_EN)


[style] ~133-~133: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...png) - Click the Test Suite you want to delete and open the Test Suite Details ...

(REP_WANT_TO_VB)


[grammar] ~133-~133: There might be a mistake here.
Context: ...Button in the screen's top right corner. [[info | NOTE:]] | Note: If you attempt ...

(QB_NEW_EN)


[grammar] ~134-~134: There might be a mistake here.
Context: ...een's top right corner. [[info | NOTE:]] | Note: If you attempt to delete a Test ...

(QB_NEW_EN)


[grammar] ~135-~135: There might be a mistake here.
Context: ... Plans before trying to delete it again. 3. A Delete Confirmation pop-up will ap...

(QB_NEW_EN)

src/pages/docs/visual-testing/configure-test-steps.md

[grammar] ~96-~96: There might be a mistake here.
Context: ...testing and see any visual differences. Rerun Test Case 3. After executing a test case for visual t...

(QB_NEW_EN)


[grammar] ~101-~101: There might be a mistake here.
Context: ..., you can perform the following options: - Highlight Differences: Highlight varia...

(QB_NEW_EN)

src/pages/docs/runs/test-plan-executions.md

[style] ~73-~73: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...figure the options according to how you want to select the test cases for your partial ...

(REP_WANT_TO_VB)


[grammar] ~117-~117: There might be a mistake here.
Context: ... 2. By default, you’ll see the results at test suite level. ![Results at Test...

(QB_NEW_EN)

src/pages/docs/elements/dynamic-elements/with-parameter-test-data.md

[grammar] ~101-~101: There might be a mistake here.
Context: ...s/Dynamic_6.png) [[info | Example:]] | Utilise NLP "Click on Element" to ...

(QB_NEW_EN)

src/pages/docs/test-plans/email-configuration.md

[style] ~44-~44: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...an/Email_configuration_4.png) 5. If you want to use your Testsigma-registered email add...

(REP_WANT_TO_VB)


[style] ~48-~48: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...) 7. Select the chat channels where you want to receive the notifications, such as **Go...

(REP_WANT_TO_VB)

src/pages/docs/addons/update.md

[grammar] ~46-~46: There might be a mistake here.
Context: ...menu. Then, choose your publish options: - Public: Make the addon available to th...

(QB_NEW_EN)


[grammar] ~47-~47: Ensure spelling is correct
Context: ...ish options: - Public: Make the addon available to the entire Testsigma commu...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)


[grammar] ~47-~47: There might be a mistake here.
Context: ...lable to the entire Testsigma community. - Private: Restrict availability to user...

(QB_NEW_EN)


[grammar] ~50-~50: Ensure spelling is correct
Context: ...y check will be done. If it passes, the addon will be published. If it fails, you wil...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md

[style] ~81-~81: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ar to open a popup window where you can make changes to the settings. ![Update Step Settings](h...

(MAKE_CHANGES)

🔇 Additional comments (14)
src/pages/docs/configuration/api-keys.md (1)

28-39: Content restructuring is clear and well-organized.

The addition of step-by-step screenshots and the split of the original step 4 into distinct steps 4 and 5 improves clarity and follows best practices for procedural documentation. The image URLs are properly formatted and follow the established naming convention.

src/pages/docs/runs/test-plan-executions.md (3)

55-56: Image reference updated correctly for Run Now step.

The step numbering and image reference have been appropriately updated. The sequential flow (steps 1→2→3→4) is maintained.


70-70: Image references updated consistently in Partial Test Runs section.

All three image URLs in this section follow the new run-specific naming convention and are formatted consistently with the rest of the documentation updates.

Also applies to: 74-74, 83-83


115-115: Image references updated consistently in Test Plan Run Results section.

Both image URLs follow the new run-specific naming convention and maintain consistency with other section updates.

Also applies to: 118-118

src/pages/docs/addons/update.md (1)

36-50: Procedural restructuring aligns well with PR objectives.

The expansion of the "Updating Addon" section from condensed steps into 7 explicit steps with corresponding visual assets improves clarity and walkthrough usability. The logical flow (navigate Addons → select addon → upload code → publish → security check) is intuitive and well-sequenced. Image URLs follow a consistent pattern and all markdown syntax is valid.

src/pages/docs/elements/dynamic-elements/with-parameter-test-data.md (2)

101-102: Address callout box formatting.

The static analysis tool flagged a potential formatting issue with the [[info | Example:]] syntax. Confirm this custom markdown syntax is properly supported by your documentation framework; if not, align with your standard callout block syntax.


48-140: Overall documentation structure and visual enhancement look strong.

The restructuring maintains the original procedural logic while significantly improving clarity through sequenced steps and integrated screenshots. Image references are properly formatted with descriptive alt text, step numbering is logical and progressive, and the content flows well across all sections. The table explanation (lines 63–86) and parameterized XPath examples (line 110) provide excellent concrete guidance.

src/pages/docs/test-data/types/raw.md (1)

33-33: Image asset paths updated correctly. All references migrated to test_data PNG assets with consistent S3 path and naming conventions. The GIF reference at line 54 is appropriately retained.

Also applies to: 42-42, 45-45, 48-48

src/pages/docs/salesforce-testing/special-nlps.md (1)

137-137: 19 GIF-to-PNG asset updates executed consistently. All NLP sections now reference sequential salesforce_testing PNG assets (NLP_19_1.png through NLP_19_19.png) with correct S3 paths and appropriate alt text.

Also applies to: 153-153, 165-165, 178-178, 192-192, 206-206, 218-218, 232-232, 246-246, 260-260, 274-274, 286-286, 298-298, 310-310, 322-322, 334-334, 346-346, 375-375, 385-385

src/pages/docs/runs/adhoc-runs.md (1)

65-65: Ad-hoc Run documentation asset migration complete. All image references updated to runs-domain PNG assets with consistent naming (Adhoc_run_X.png) and S3 paths across Web, Mobile Web, Android, iOS, Desktop, REST API, and Prerequisites sections.

Also applies to: 96-96, 116-116, 138-138, 161-161, 173-173, 183-183, 192-192, 195-195, 198-198

src/pages/docs/test-data/types/runtime.md (1)

48-48: Image assets and runtime variable documentation updated appropriately. New NOTE section at lines 53–62 clearly explains the difference between evaluated ($|runtimeVariable|) and plain text runtime variable references, with helpful examples. Image updates follow test_data PNG conventions.

Also applies to: 71-71, 53-62

src/pages/docs/test-data/types/environment.md (1)

59-59: Environment Test Data asset migration complete. All image references updated to test_data PNG assets (Environment_1.png through Environment_20.png) with consistent S3 paths across all sections and steps.

Also applies to: 60-60, 66-66, 73-73, 94-94, 97-97, 100-100, 106-106, 109-109, 112-112, 116-116, 119-119, 122-122, 125-125, 128-128, 139-139, 142-142, 144-144, 159-159

src/pages/docs/test-cases/create-test-steps/actions-and-options-manual/step-settings.md (2)

44-44: Test Step Settings asset updates applied correctly. Image references migrated to test_case PNG assets (Test_step_settings_1.png through Test_step_settings_3.png) across all sections.

Also applies to: 60-60, 81-81


62-76: Global Timeouts section enhances documentation clarity. The new section with interaction table (lines 66–72) effectively explains how Test Step Timeout and Global Step Timeout settings interact across four scenarios, providing users with clear guidance on expected behavior.

Comment on lines +54 to +56
2. We will use the Simply Travel Flight website as an example of the above test steps. Click **Select from Cities** and copy the **XPath** values for the cities.
![Website](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_1.png)

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

Clarify reference to prior steps.

Line 54 states "example of the above test steps" but no procedural steps precede this statement—only a general introduction. Revise for clarity.

-2. We will use the Simply Travel Flight website as an example of the above test steps. Click **Select from Cities** and copy the **XPath** values for the cities.
+2. Using the Simply Travel Flight website as an example, click **Select from Cities** and copy the **XPath** values for the cities.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
2. We will use the Simply Travel Flight website as an example of the above test steps. Click **Select from Cities** and copy the **XPath** values for the cities.
![Website](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_1.png)
2. Using the Simply Travel Flight website as an example, click **Select from Cities** and copy the **XPath** values for the cities.
![Website](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_1.png)
🤖 Prompt for AI Agents
In src/pages/docs/elements/dynamic-elements/with-parameter-test-data.md around
lines 54-56, the phrase "example of the above test steps" is ambiguous because
no procedural steps precede it; replace that phrase with a clear reference such
as "example of the following test steps" or "example of the test steps in this
section" (or add a direct pointer like "see Steps 1–X below" if specific step
numbers exist) so the sentence unambiguously points to the procedure the
screenshot illustrates.

Comment on lines +137 to +138

3. The Test Case will iterate as many times as there are **Test Data Sets (rows)** in the Test Data Profile, resulting in four iterations based on the provided example.
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

Remove unnecessary indentation on blank line.

Line 137 contains trailing whitespace. Clean it up for consistency.

-2. Wait until the Test Case execution is completed.
-   
+2. Wait until the Test Case execution is completed.
+

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents
In src/pages/docs/elements/dynamic-elements/with-parameter-test-data.md around
lines 137 to 138 there is a blank line containing trailing
whitespace/indentation; remove the trailing spaces so the line is a clean empty
line (no spaces or tabs) to ensure consistency and prevent lint/whitespace
errors.


2. Enter the **Variable** name and **Value** and click **Add**.
![Add Variables](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/Variable_and_Value.png)
2. Click **Add Varibale**. This will open the **Add Environment Variable** prompt.
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 typo: "Varibale" → "Variable".

- 2. Click **Add Varibale**. This will open the **Add Environment Variable** prompt.
+ 2. Click **Add Variable**. This will open the **Add Environment Variable** prompt.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
2. Click **Add Varibale**. This will open the **Add Environment Variable** prompt.
2. Click **Add Variable**. This will open the **Add Environment Variable** prompt.
🧰 Tools
🪛 LanguageTool

[grammar] ~96-~96: Ensure spelling is correct
Context: ...data/Environment_5.png) 2. Click Add Varibale. This will open the **Add Environment...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
In src/pages/docs/test-data/types/environment.md at line 96, there's a typo "Add
Varibale"; change it to "Add Variable" so the sentence reads: "Click **Add
Variable**. This will open the **Add Environment Variable** prompt." Make only
that spelling correction and keep formatting/markdown intact.

![Create](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/test_data/Environment_7.png)

[[info | **NOTE**:]]
| **Variable** names should be unique and can not be changed once added.
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

Replace "can not" with "cannot".

- | **Variable** names should be unique and can not be changed once added.
+ | **Variable** names should be unique and cannot be changed once added.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| **Variable** names should be unique and can not be changed once added.
| **Variable** names should be unique and cannot be changed once added.
🧰 Tools
🪛 LanguageTool

[style] ~103-~103: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...Variable names should be unique and can not be changed once added. 4. Once the **...

(CAN_NOT_PREMIUM)

🤖 Prompt for AI Agents
In src/pages/docs/test-data/types/environment.md around line 103, the phrase
uses "can not" which is incorrect; replace "can not" with the single-word form
"cannot" so the sentence reads: "Variable names should be unique and cannot be
changed once added." Ensure spacing and punctuation remain unchanged.

1. Navigate to **Test Suites** in the left-side navigation bar.
![Test Suites](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/test_suites/Edit_test_suite_1.png)

2. You can edit the test case using any of the following methods:
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 subject-verb mismatch in step description.

Line 106 refers to "test case" but should reference "test suite" (the subject of this section).

- You can edit the test case using any of the following methods:
+ You can edit the test suite using any of the following methods:
🧰 Tools
🪛 LanguageTool

[grammar] ~106-~106: There might be a mistake here.
Context: ...case using any of the following methods: - Click on the ellipsis icon for the *...

(QB_NEW_EN)

🤖 Prompt for AI Agents
In src/pages/docs/test-suites/overview.md around line 106, the step text uses
"test case" but the section is about "test suite"; update the sentence to
replace "test case" with "test suite" so the subject matches the section (e.g.,
change "You can edit the test case using any of the following methods:" to "You
can edit the test suite using any of the following methods:").

7. Click **Activity** in the right-side navbar and view the **History** and **Comments** of test suite. ![Edit Test Suite](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/edit_a_testsuite.gif)
![Test Suite Info](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/test_suites/Edit_test_suite_6.1.png)

7. Click **Activity** in the right-side navbar and view the **History** and **Comments** of test suite.
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

Add missing article for grammatical correctness.

Line 121 reads "of test suite" but should include the article.

- 7. Click **Activity** in the right-side navbar and view the **History** and **Comments** of test suite.
+ 7. Click **Activity** in the right-side navbar and view the **History** and **Comments** of the test suite.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
7. Click **Activity** in the right-side navbar and view the **History** and **Comments** of test suite.
7. Click **Activity** in the right-side navbar and view the **History** and **Comments** of the test suite.
🧰 Tools
🪛 LanguageTool

[grammar] ~121-~121: There might be a mistake here.
Context: ...d view the History and Comments of test suite. ![Activity](https://s3....

(QB_NEW_EN)

🤖 Prompt for AI Agents
In src/pages/docs/test-suites/overview.md around line 121, the phrase "of test
suite" is missing an article; update the sentence to read "of the test suite"
(e.g., "Click **Activity** in the right-side navbar and view the **History** and
**Comments** of the test suite.") so the grammar is corrected.

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

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
src/pages/docs/test-data/types/raw.md (1)

53-54: Update line 54 to use PNG screenshot from test_data path to complete GIF-to-PNG replacement.

Line 54 contains the only unreplaced GIF reference in the file. All other image references (lines 33, 42, 45, 48) have been updated to use the /test_data/ path with PNG format (Plain_text_1.png through Plain_text_4.png). Line 54 still references the old /applications/ path with PlainTextWF.gif.

Update line 54 to reference an appropriate PNG file in the test_data path (e.g., Plain_text_5.png or similar), and update line 53 text from "Here's a quick GIF" to "Here's a quick screenshot" to align with the asset change.

🧹 Nitpick comments (2)
src/pages/docs/runs/test-plan-executions.md (2)

73-73: Minor: Reduce word repetition for clarity.

The phrase "according to how you want to select" repeats the concept of selection from the preceding sentence. Consider rephrasing to improve readability: e.g., "configure the options to specify which test cases to include in your partial test run."


117-117: Minor: Clarify phrasing for consistency.

The phrasing "By default, you'll see the results at test suite level" could be tightened for clarity. Consider: "Results are displayed at test suite level by default."

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 68227cc and 7f6c203.

📒 Files selected for processing (3)
  • src/pages/docs/runs/test-plan-executions.md (4 hunks)
  • src/pages/docs/test-data/types/raw.md (2 hunks)
  • src/pages/docs/test-data/types/runtime.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/pages/docs/test-data/types/runtime.md
🧰 Additional context used
🪛 LanguageTool
src/pages/docs/runs/test-plan-executions.md

[style] ~73-~73: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...figure the options according to how you want to select the test cases for your partial ...

(REP_WANT_TO_VB)


[grammar] ~117-~117: There might be a mistake here.
Context: ... 2. By default, you’ll see the results at test suite level. ![Results at Test...

(QB_NEW_EN)

⏰ 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/runs/test-plan-executions.md (3)

55-56: Verify new Run Now image asset exists.

The image URL has been updated to point to a new run-specific asset. Before merging, confirm that the asset exists at the S3 path and displays correctly in the rendered documentation.


70-70: Verify Partial Run image assets exist.

Image URLs in the Partial Test Runs section have been updated to use new run-specific assets. Ensure all three assets (Partial Run, Partial Test Run overlay, and Test Case Filters) exist at the specified S3 paths and render correctly.

Also applies to: 74-74, 83-83


115-115: Verify Test Plan Run Results image assets exist.

Image URLs in the Test Plan Run Results section have been updated to new assets. Confirm both assets (Test Suites and Results at Test Suite Level) exist at the specified S3 paths and render without issues.

Also applies to: 118-118

src/pages/docs/test-data/types/raw.md (1)

33-33: Image asset updates align with new test_data path structure.

The updated references correctly point to the new test_data asset paths with PNG format.

Also applies to: 42-42, 45-45, 48-48

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.

3 participants