Skip to content

Commit 933dccd

Browse files
authored
Merge pull request LambdaTest#1172 from amanchopra1905/stage
smartui - guided walkthrough
2 parents 3035401 + 7fa0c7a commit 933dccd

File tree

5 files changed

+36
-12
lines changed

5 files changed

+36
-12
lines changed
103 KB
Loading
101 KB
Loading

docs/smartui-guided-walkthrough.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,30 @@ slug: smartui-guided-walkthrough/
3636
}]
3737
})
3838
}}
39-
></script>
39+
></script>
40+
This page gives you a guided walkthrough of all the things on the HyperExecute Dashboard and how you can get the most out of the platform once you have successfully [run your first sample project](/support/docs/smartui-running-your-first-project/).
41+
42+
## Projects Page
43+
All the tests on SmartUI gets executed as a Project. All the Projects can be found on our Projects page. Each Project has a Approver, Tags, Platform, and a Sort By section followed by the details of the number of builds and who initiated the Project.
44+
45+
<img loading="lazy" src={require('../assets/images/smart-visual-testing/guided-walkthrough/1.png').default} alt="Image" className="doc_img"/>
46+
47+
## Projects Dashboard Details
48+
The SmartUI dashboard presents a comparison between the baseline and the captured screenshots for visual regression testing. It provides essential insights to detect any UI anomalies.
49+
50+
### Key Sections
51+
- **Baseline View :** Displays the previously captured UI state for comparison. It serves as the reference point for regression testing.
52+
- **Captured View :** Shows the latest UI version to compare against the baseline. Differences are highlighted for easy identification.
53+
54+
### Diff Controls
55+
Located at the center of the top menu, the Diff Controls allow testers to customize how visual differences are displayed, offering multiple options to refine the comparison process. The available modes are:
56+
57+
- **Captured Diffs :** Highlights the differences detected in the current captured screenshots when compared to the baseline. Ideal for spotting changes introduced in the latest version.
58+
- **Baseline Diffs :** Displays the differences by focusing on the baseline's unique elements. Helps identify elements missing or changed in the new capture. Annotations : Allows users to add notes or highlight specific regions of interest on the screenshots. Useful for documenting findings or collaborating with team members.
59+
- **Strict Mode :** Highlights exact pixel mismatches between the baseline and captured screenshots. Best suited for detailed visual inspections where high precision is required.
60+
- **Smart Ignore :** Automatically ignores minor, non-critical differences (e.g., anti-aliasing, rendering variations). Useful for reducing noise in tests, allowing the focus to remain on significant UI changes.
61+
62+
### Variants
63+
The top menu includes browser variants, which allow cross-browser testing. Variants visible in the screenshot include: Chrome, Firefox, Edge, Playwright WebKit (Pw-Webkit). Each variant shows the same test across different browsers and resolutions, helping identify browser-specific visual issues.
64+
65+
<img loading="lazy" src={require('../assets/images/smart-visual-testing/guided-walkthrough/2.png').default} alt="Image" className="doc_img"/>

docs/smartui-running-your-first-test.md renamed to docs/smartui-running-your-first-project.md

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
2-
id: smartui-running-your-first-test
3-
title: Running Your First Test on SmartUI
2+
id: smartui-running-your-first-project
3+
title: Running Your First Project on SmartUI
44
hide_title: false
55
sidebar_label: Running Your First Test
6-
description: Learn how to run your first test on smartui step by step guide for the first time users to help them understand how the platform works
6+
description: Learn how to run your first project on smartui step by step guide for the first time users to help them understand how the platform works
77
keywords:
88
- smart visual testing in lambdatest
99
- visual ui testing,image to image comparison
@@ -15,9 +15,9 @@ keywords:
1515
- test on samsung a7 online
1616
- test on mac 10.11 el capitan online
1717
- apple mac el capitan virtual machine
18-
url: https://www.lambdatest.com/support/docs/smartui-running-your-first-test/
18+
url: https://www.lambdatest.com/support/docs/smartui-running-your-first-project/
1919
site_name: LambdaTest
20-
slug: smartui-running-your-first-test/
20+
slug: smartui-running-your-first-project/
2121
---
2222

2323
import Tabs from '@theme/Tabs';
@@ -43,12 +43,11 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
4343
"@type": "ListItem",
4444
"position": 3,
4545
"name": "Smart Visual Testing",
46-
"item": "https://www.lambdatest.com/support/docs/smartui-running-your-first-test/"
46+
"item": "https://www.lambdatest.com/support/docs/smartui-running-your-first-project/"
4747
}]
4848
})
4949
}}
5050
></script>
51-
5251
This guide will walk you through the process of running your first visual regression test using SmartUI, a powerful feature of LambdaTest that ensures your web applications look flawless across all browsers and devices.
5352
## Prerequisites
5453

@@ -72,7 +71,7 @@ Now select your desired framework and click on the **Configure** button. For the
7271
You can use your own project to configure and test it. For demo purposes, we are using the sample repository.
7372

7473
:::tip Sample repo
75-
Download or Clone the code sample code repository from the LambdaTest GitHub repository to run the tests on the SmartUI.
74+
Download or Clone the code sample code repository from the LambdaTest GitHub repository to run the project on the SmartUI.
7675

7776
<a href="https://github.com/LambdaTest/smartui-java-testng-sample" target="_blank" className="github__anchor"><img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub</a>
7877
:::
@@ -130,7 +129,6 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`}
130129
{`$Env:LT_USERNAME="${YOUR_LAMBDATEST_USERNAME()}"
131130
$Env:LT_ACCESS_KEY="${YOUR_LAMBDATEST_ACCESS_KEY()}"
132131
$Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`}
133-
134132
</CodeBlock>
135133
</div>
136134
</TabItem>
@@ -140,7 +138,7 @@ $Env:PROJECT_TOKEN="123456#1234abcd-****-****-****-************"`}
140138
<img loading="lazy" src={require('../assets/images/smart-visual-testing/running-first-test/1.png').default} alt="cmd" width="768" height="373" className="doc_img"/>
141139

142140
## Step 4: Create and Configure SmartUI Config
143-
You can now configure your project configurations on using various available options to run your tests with the SmartUI integration. To generate the configuration file, please execute the following command:
141+
You can now configure your project configurations on using various available options to run your project with the SmartUI integration. To generate the configuration file, please execute the following command:
144142

145143
```bash
146144
npx smartui config:create .smartui.json

sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2681,7 +2681,7 @@ module.exports = {
26812681
type: "doc",
26822682
id: "smart-visual-regression-testing",
26832683
},
2684-
items: ["smartui-running-your-first-test", "smartui-guided-walkthrough", "smartui-cli-git-branching-strategy", "smartui-cli-env-variables"],
2684+
items: ["smartui-running-your-first-project", "smartui-guided-walkthrough", "smartui-cli-git-branching-strategy", "smartui-cli-env-variables"],
26852685
},
26862686
{
26872687
type: "category",

0 commit comments

Comments
 (0)