Skip to content

Replaced GIFs with screenshots #816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Replaced GIFs with screenshots #816

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68227cc
Replaced GIFs with screenshots
Nandhini4501 Oct 9, 2025
7f6c203
Merge branch 'dev' into DOC-354-1
Santhosh-testsigma Oct 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions src/pages/docs/addons/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,18 @@ Updating an addon in Testsigma keeps your tools up-to-date and functional. First
## **Updating Addon**

1. Modify the addon’s code to fix issues, add features, or adjust settings. Compress the file into **Zipped** Format.
2. In Testsigma Application, Click on the **Addons** icon from the left navigation bar. Go to the **My Addons** page in Testsigma and select the addon you want to update.
3. Select **Update** from the dropdown and 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/applications/update_addon.gif)
4. After uploading the code, click on **Publish** from the dropdown menu. Then, choose your publish options:
2. In Testsigma Application, click on the **Addons** icon from the left navigation bar.
![Addons](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addon/Addon_1.png)
3. Go to the **My Addons** page in Testsigma and select the addon you want to update.
![My Addons](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addon/Addon_2.png)
4. Select **Upload Code** from the dropdown.
![Upload Code](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addon/Addon_3.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)
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.
5. An automatic security check will be done. If it passes, the addon will be published. If it fails, you will get an email notification. ![publish addon](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/publish_addon_ts.gif)
![Publish](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/addon/Addon_5.png)
7. An automatic security check will be done. If it passes, the addon will be published. If it fails, you will get an email notification.

---

Expand Down
8 changes: 7 additions & 1 deletion src/pages/docs/configuration/api-keys.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,18 @@ You can access and control it programmatically once you generate the API key. Te
Follow the below steps to generate an API key in Testsigma:

1. Navigate to **Settings** > **API Keys** in the left-side navbar.
![API Keys](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/API_key_1.png)

2. Click the **Generate new API Key** button in the top right corner of the screen on the **API Keys** page, and a **Generate API Key** pop-up overlay will appear.
![Generate new API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/API_key_2.png)

3. In the pop-up overlay for **Generate API Key**, you can enter a **Name** for your **API Key** and specify the **number of parallel test** executions for this key. The overlay provides a toggle for restricting parallel test execution for this key.
![Generate API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/API_key_3.png)

4. After entering a name and configuring parallel settings, click the **Generate Key** button. 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/applications/generate_apikey.gif)
4. After entering a name and configuring parallel settings, click the **Generate Key** button.
![Generate Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/API_key_4.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. ![Generate API Key](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/configuration/API_key_5.png)

[[info | **NOTE**:]]
| Only users with **Admin** or **Super Admin** roles can generate API keys in Testsigma.
Expand Down
16 changes: 14 additions & 2 deletions src/pages/docs/desired-capabilities/network-logs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,27 @@ This documentation will guide you on how to enable the network log in Test Case
## **Enable Network Logs in Test Case**

1. Click **Run** in the top right corner of the screen on the Test Case details page.
2. Select **BrowserStack** as a Test Lab on the **Ad-hoc Ru**n page on the right side of the screen, enable the **Network Log** toggle, and click **Run Now** to start Test Execution. ![Enable Network Log in Test Case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/networklogs_adhoc.gif)
![Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/Logs_1.png)

2. Select **BrowserStack** as a Test Lab on the **Ad-hoc Run** overlay.
![BrowserStack](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/Logs_2.png)

3. Enable the **Network Log** toggle, and click **Run Now** to start test execution.
![BrowserStack](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/Logs_3.png)

---

## **Enable Network Logs in Test Plan**

1. Navigate to the **Add Test Suites & Link Machine Profiles** tab on the **Create** or **Edit Test Plan** page.
![Edit Test Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/Logs_4.png)

2. Click the **Test Machine Settings** icon, and the **Adding** or **Editing Test Machine/Device Profiles** overlay will appear.
3. On the **Add** or **Edit Machine/Device Profile** overlay, select Test Lab Type as **BrowserStack**, enable the **Network Log** toggle, and click **Create/Update**. ![Enable Network Logs in Test Plan](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/networklogs_testplan.gif)
![Test Machine Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/Logs_5.png)

3. On the **Add** or **Edit Machine/Device Profile** overlay, select Test Lab Type as **BrowserStack**, enable the **Network Log** toggle, and click **Create/Update**.
![BrowserStack](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/desired_capabilities/Logs_6.png)


---

Expand Down
49 changes: 38 additions & 11 deletions src/pages/docs/elements/dynamic-elements/with-parameter-test-data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,16 @@ Dynamic locators are necessary for data-driven testing because they help adjust
We are using the Simply Travel Flight website as an example and sorting the city names and the variable part of the element's ID attribute in the test data profile.

1. Navigate to the website containing the elements you want to copy the **XPath**.
2. **Right-click** on the desired and select **Inspect** to open **Chrome Developer Tools**.
3. Use the **Select Element** icon to locate and inspect the element, then right-click the HTML tag and copy the **XPath**.
4. 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. ![Copy Xpath for storing](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/copy_xpath.gif)

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)

Comment on lines +54 to +56
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 17, 2025

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.

3. **Right-click** on the desired and select **Inspect** to open **Chrome Developer Tools**.
![Inspect](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_2.png)

4. Use the **Select Element** icon to locate and inspect the element, then right-click the HTML tag and copy the **XPath**.
![XPath](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_3.png)

5. The table below explains how the city names and their corresponding XPath for an element.
<table>
<tr>
Expand All @@ -78,37 +85,57 @@ We are using the Simply Travel Flight website as an example and sorting the city
</table>

6. In the provided XPath examples, the IDs of the cities have a common portion, **city-**, followed by a variable digit from **1** to **4**. We will parameterise this by storing the city and the variable portion using a Test Data profile.
7. Navigate to **Test Data** > **Test Data Profile**. Click on **Create Test Data Profile**. ![Create TDP for storing element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/create_tdp_parameter.png)
8. Below is the created Test Data profile for storing element ID attributes: ![Sample TDP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sample_tdp_dynamic.png)
7. Navigate to **Test Data** > **Test Data Profile**. Click on **Create Test Data Profile**.
![Create Test Data Profile](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_4.png)

8. Below is the created Test Data profile for storing element ID attributes:
![Attributes](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_5.png)

---

## **Creating Dynamic Elements using Parameter**

1. Use NLP to create a new step in the Test Case and include a placeholder for the element. ![Select Create Element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/select_create_element_dp.png)
1. Use NLP to create a new step in the Test Case and include a placeholder for the element.
![NLP](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_6.png)

[[info | Example:]]
| Utilise NLP "Click on **Element**" to click an element with a given UI Identifier.

2. Click on the **Element**, then select **Create Element** from the dropdown list.
![Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_7.png)

3. Manually enter the **Element Name**, **Screen Name**, and **Element Type** in the **Create Element** overlay screen.
![Element Name](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_8.png)

4. Provide the dynamic element value **//*[@id="@|cities|"]/div[2]/span[1]**, where **cities** is the parameter name containing dynamic data.
5. Click **Create Element** to complete element creation and then **Create Step**. ![Create Dynamic ELement using Parameter](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/create_element_usingparameter.gif)
![XPath Value](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_9.png)

5. Click **Create Element** to complete element creation and then **Create Step**.
![Create Element](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_10.png)

---

## **Configuring Test Data Profile in Test Case**

1. In Test Case details page, click **Test Case Settings** in the right-side navbar.
![Test Case Setings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_11.png)

2. Choose the associated **Test Data Profile**.
3. Enable the **Data-Driven** toggle and select **Filter Type**, **Comparison Metric**, and **Data Iteration**. ![Config TDP in test case](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/config_tdp_dynamic.gif)
![Test Data Profile](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_12.png)

3. Enable the **Data-Driven** toggle and select **Filter Type**, **Comparison Metric**, and **Data Iteration**.
![Data-Driven](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_13.png)

---

## **Run Results for Dynamic Elements using Parameter**

1. Once the test step created with the dynamic Element, execute the Test Case.
2. Wait until the Test Case execution is completed.
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. ![Results for Dynamic Elements](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/results_dynamicparameter.gif)
![Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_14.png)

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

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.
Comment on lines +137 to +138
Copy link
Contributor

@coderabbitai coderabbitai bot Oct 17, 2025

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.

![Test Data Sets](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/elements/Dynamic_15.png)

---
20 changes: 10 additions & 10 deletions src/pages/docs/runs/adhoc-runs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ This documentation will guide you through setting up Test Labs and Test Machines
![Configuration name](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_3.png)
5. Click on **Saved Configs** at the top of the screen to reuse the saved configuration, and a drop-down list will appear. Select the Saved Config from this list. ![Save Config of Ad-Hoc](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_4.png)
6. The Ad-hoc Run overlay will be automatically pre-filled with the saved configuration for your next runs when selected.
7. In the **Test Case Details** page, click **Ad-Hoc Runs** in the right Navigation Bar to open the right sidebar. This will enable you to view the history and details of Ad-Hoc Run results for the Test Case. ![View History of Ad-Hoc Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/view_adhocrundetails.png)
7. In the **Test Case Details** page, click **Ad-Hoc Runs** in the right Navigation Bar to open the right sidebar. This will enable you to view the history and details of Ad-Hoc Run results for the Test Case. ![View History of Ad-Hoc Run](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_1.1.png)


[[info | **NOTE**:]]
Expand All @@ -93,7 +93,7 @@ In the Ad-hoc run layover, provide the following configuration settings for a we
3. **Page Timeout**: Duration for which the test should wait for the page to load.
4. **Element Timeout**: Duration for which the test should wait for the element to load.
5. **Desired Capabilities**: Provide **Key**, **Data Type** and **Value** under Desired Capabilities.
6. Click on **Run Now**. ![Ad-hoc screen for Web Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/webappliaction_adhocrun.png)
6. Click on **Run Now**. ![Ad-hoc screen for Web Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_1.2.png)

---

Expand All @@ -113,7 +113,7 @@ In the Ad-hoc run layover, provide the following configuration settings for a mo
4. **Camera Image Injection**: Click the toggle button for **Camera Image Injection** to enable camera image injection for a test case.
5. **Network Logs**: Click the toggle button for **Network Logs** to enable network logs for a test case.
6. **Desired Capabilities**: Provide **Key**, **Data Type** and **Value** under Desired Capabilities.
7. Click on **Run Now**. ![Ad-hoc screen for Mobile Web Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_6.png)
7. Click on **Run Now**. ![Ad-hoc screen for Mobile Web Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_1.3.png)

---

Expand All @@ -135,7 +135,7 @@ In the Ad-hoc run layover, provide the following configuration settings for an A
5. **Camera Image Injection**: Click the toggle button for **Camera Image Injection** to enable camera image injection for a test case.
6. **Network Logs**: Click the toggle button for **Network Logs** to enable network logs for a test case.
7. **Desired Capabilities**: Provide **Key**, **Data Type** and **Value** under Desired Capabilities.
8. Click on **Run Now**. ![Ad-hoc screen for Android Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_7.png)
8. Click on **Run Now**. ![Ad-hoc screen for Android Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_1.4.png)

---

Expand All @@ -158,7 +158,7 @@ In the Ad-hoc run layover, provide the following configuration settings for an i
5. **Camera Image Injection**: Click the toggle button for **Camera Image Injection** to enable camera image injection for a test case.
6. **Network Logs**: Click the toggle button for **Network Logs** to enable network logs for a test case.
7. **Desired Capabilities**: Provide **Key**, **Data Type** and **Value** under Desired Capabilities.
8. Click on **Run Now**. ![Ad-hoc screen for iOS Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_8.png)
8. Click on **Run Now**. ![Ad-hoc screen for iOS Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_1.5.png)

---

Expand All @@ -170,7 +170,7 @@ In the Ad-hoc run layover, provide the following configuration settings for a De
3. **Desktop App Location**: Provide the Local URL for the application path.
4. **Environment**: Select the test environment.
5. **Desired Capabilities**: Provide **Key**, **Data Type** and **Value** under Desired Capabilities.
6. Click on **Run Now**. ![Ad-hoc screen for Desktop Windows](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/dekstopwindows_adhocrun.png)
6. Click on **Run Now**. ![Ad-hoc screen for Desktop Windows](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_1.6.png)

---

Expand All @@ -180,7 +180,7 @@ In the Ad-hoc run layover, provide the following configuration settings for a Re
1. **Test Lab**: Select the test lab, either **Testsigma Cloud Lab** or **Local Devices**, to run the test case.
2. **Environment**: Select the test environment.
3. **Desired Capabilities**: Provide **Key**, **Data Type** and **Value** under Desired Capabilities.
4. Click on **Run Now**. ![Rest API Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/restapiapp_adhocrun.png)
4. Click on **Run Now**. ![Rest API Application](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_run_1.7.png)

---

Expand All @@ -189,10 +189,10 @@ In the Ad-hoc run layover, provide the following configuration settings for a Re
You can add a prerequisite test case for any test case while executing the test case as dry runs. Follow the steps below to add a prerequisite test case for dry runs.

1. Navigate to **Create Tests > Test Cases**, select a test case for which you want to add prerequisites and click on **Test Case Settings**.
![Test Case Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/tcsfapr.png)
![Test Case Settings](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_1.png)

2. Select the prerequisite test case from the dropdown.
![Prereq TC](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/sprtcitcs.png)
![Prereq TC](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_2.png)

3. For **Dry Runs**, the test case will be executed after the prerequisite test case. You can check the **Execution sequence** on the test case results page.
![Dry Runs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/applications/vprtcie.png)
![Dry Runs](https://s3.amazonaws.com/static-docs.testsigma.com/new_images/projects/runs/Adhoc_3.png)
Loading