Skip to content

Commit a8b8d1e

Browse files
committed
For User Documentation of RCA, Custom Request Headers and smartui maestro
1 parent d085205 commit a8b8d1e

File tree

10 files changed

+24
-18
lines changed

10 files changed

+24
-18
lines changed
-4.66 KB
Loading
-4.15 KB
Loading
-4.38 KB
Loading
-16.3 KB
Loading
-22.6 KB
Loading
-8.78 KB
Loading

docs/hyperexecute-smart-ui-sdk-maestro.md renamed to docs/hyperexecute-smart-ui-maestro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ In your Maestro test YAML files (e.g., `maestro-test/test.yaml`), add the `takeS
130130
131131
#### 4.3. Set Up Environment Variables
132132
133-
Now, you need to export your environment variables *LT_USERNAME* and *LT_ACCESS_KEY* that are available in the [LambdaTest Profile page](https://accounts.lambdatest.com/detail/profile).
133+
Now, you need to export your environment variables *LT_USERNAME* and *LT_ACCESS_KEY* that are available in the [LambdaTest Username and Access Key Page](https://accounts.lambdatest.com/security/username-accesskey).
134134
135135
Run the below mentioned commands in your terminal to setup the CLI and the environment variables.
136136

docs/smartui-custom-request-headers.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ Below is an example of how to configure custom headers in your `smartui.json` fi
8181
* **Key**: The name of the HTTP header (e.g., `Authorization`, `X-Custom-Header-1`).
8282
* **Value**: The corresponding value for the header (e.g., `Bearer your-access-token`, `custom-value-1`).
8383

84-
## Steps to Implement
84+
### Steps to Implement
8585

8686
1. **Locate Your Configuration File**: Open your `smartui.json` file, which should be in the root directory of your project.
8787
2. **Add the `requestHeaders` Array**: If the array does not already exist, add it to the JSON structure.
@@ -93,6 +93,4 @@ Below is an example of how to configure custom headers in your `smartui.json` fi
9393
* You can define multiple headers by adding more objects to the `requestHeaders` array.
9494
* The headers defined in this configuration will be sent with every page load and asset request made by the SmartUI CLI during the test.
9595
* This feature is particularly useful for testing web applications in staging or development environments that are protected from public access.
96-
:::
97-
98-
<!-- end list -->
96+
:::

docs/smartui-root-cause-analysis.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
id: smartui-root-cause-analysis
3-
title: Smart Root Cause Analysis in SmartUI
3+
title: Root Cause Analysis in SmartUI
44
hide_title: false
5-
sidebar_label: Smart Root Cause Analysis (RCA)
6-
description: Learn how to use SmartUI's Root Cause Analysis (RCA) to debug visual regressions by inspecting the exact DOM and CSS changes behind them.
5+
sidebar_label: Smart RCA
6+
description: Learn how to use SmartUI's RCA to debug visual regressions by inspecting the exact DOM and CSS changes behind them.
77
keywords:
88
- smartui
99
- root cause analysis
@@ -51,14 +51,15 @@ SmartUI’s **Root Cause Analysis (RCA)** provides a deep inspection into *why*
5151
## What Problems Does Smart RCA Solve?
5252

5353
Visual testing often tells you that something is wrong but not what caused it. Smart RCA eliminates the guesswork and manual debugging by providing immediate, actionable insights.
54-
54+
<p align="center">
5555
| Problem | Smart RCA Solution |
5656
|---|---|
5757
| The UI looks broken, but you don’t know why. | Click to inspect the exact HTML, CSS, and Text changes. |
5858
| The visual diff isn't providing enough detail. | RCA shows an in-depth DOM comparison. |
5959
| The team wastes time on manual debugging. | RCA provides an instant root cause, saving time. |
6060
| The layout shifted because of a small style change. | RCA pinpoints the exact CSS properties that changed. |
6161
| Invisible elements are affecting the layout. | RCA highlights changes to all elements, even invisible ones. |
62+
</p>
6263

6364
---
6465

@@ -67,36 +68,42 @@ Visual testing often tells you that something is wrong but not what caused it. S
6768
### Prerequisites
6869

6970
:::info
70-
Before you begin, please ensure the following:
71-
* The build was generated using a **LambdaTest CLI (exec)** project.
71+
Before you begin, please ensure the build was generated using a **LambdaTest CLI (exec)** command.
7272
:::
7373

7474
### Step 1: Activate RCA Mode
7575

7676
1. Open a visual build from your [SmartUI dashboard](https://smartui.lambdatest.com/).
7777
2. In the comparison toolbar, click the **RCA** icon.
78-
78+
<p align="center">
7979
<img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAicon.png').default} alt="RCA Icon in Toolbar" width="200" height="200" className="doc_img"/>
80+
</p>
8081

8182
When RCA is activated, DOM diff boxes are automatically enabled. There's nothing manual to configure—you're ready to investigate immediately.
8283

8384
### Step 2: Investigate DOM Differences Visually
8485

8586
As soon as RCA mode is on, you can interact with the highlighted differences to see the underlying code changes. The selection is visually precise, with overlays that follow the true element boundaries, not just approximate pixel areas.
8687

87-
<img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAmain.png').default} alt="RCA Icon in Toolbar" width="400" height="800" className="doc_img"/>
88-
8988
| User Interaction | Visual Feedback & Result |
9089
|---|---|
91-
| **Default View** <img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAdefault.png').default} alt="RCA Icon in Toolbar" width="200" height="200" className="doc_img"/> | A dark blue highlight box appears by default, pinpointing the exact DOM element where the primary issue is detected. |
92-
| **Hover** on a diff region <img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAhover.png').default} alt="RCA Icon in Toolbar" width="200" height="200" className="doc_img"/> | A yellow bounding box appears, indicating the element is ready for selection. |
93-
| **Click** a diff region <img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAselected.png').default} alt="RCA Icon in Toolbar" width="200" height="200" className="doc_img"/> | A red box locks onto the selected DOM region, and the RCA panel opens on the right. |
94-
| **Hover** while selected <img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAhighlight.png').default} alt="RCA Icon in Toolbar" width="200" height="200" className="doc_img"/> | A blue highlight box appears over the element, helping to transition focus between the screenshot and the RCA panel. |
90+
| **Default View** <br /> <img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAdefault.png').default} alt="RCA Icon in Toolbar" width="200" height="200" className="doc_img"/> | A dark blue highlight box appears by default, pinpointing the exact DOM element where the primary issue is detected. |
91+
| **Hover** on a diff region <br /> <img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAhover.png').default} alt="RCA Icon in Toolbar" width="200" height="200" className="doc_img"/> | A yellow bounding box appears, indicating the element is ready for selection. |
92+
| **Click** a diff region <br /> <img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAselected.png').default} alt="RCA Icon in Toolbar" width="200" height="200" className="doc_img"/> | A red box locks onto the selected DOM region, and the RCA panel opens on the right. |
93+
| **Hover** while selected <br /> <img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAhighlight.png').default} alt="RCA Icon in Toolbar" width="200" height="200" className="doc_img"/> | A blue highlight box appears over the element, helping to transition focus between the screenshot and the RCA panel. |
94+
95+
9596

9697
### Step 3: Understand Detailed Changes in the RCA Panel
9798

9899
Once an element is selected, the RCA panel opens on the right sidebar. It displays structured diff breakdowns across several categories:
99100

101+
102+
<p align="center">
103+
<img loading="lazy" src={require('../assets/images/smart-visual-testing/RCA/RCAmain.png').default} alt="RCA Icon in Toolbar" width="200" height="400" className="doc_img"/>
104+
</p>
105+
106+
100107
| Category | What You'll See |
101108
|---|---|
102109
| **DOM Path** | The full XPath for the element in both the baseline and captured screenshot. |

package-lock.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)