diff --git a/docs/accessibility-automation-test.md b/docs/accessibility-automation-test.md index 400e431fd..abcbd0ebd 100644 --- a/docs/accessibility-automation-test.md +++ b/docs/accessibility-automation-test.md @@ -1,6 +1,6 @@ --- id: accessibility-automation-test -title: Automation Tests with Accessibility Tool using Selenium +title: Accessibility Testing on HyperExecute using Selenium sidebar_label: Selenium description: Use LambdaTest Accessibility DevTools to detect and report accessibility issues with automation, following WCAG guidelines. keywords: diff --git a/docs/analytics-modules-accessibility-widgets.md b/docs/analytics-modules-accessibility-widgets.md index eace08182..5222bfa4f 100644 --- a/docs/analytics-modules-accessibility-widgets.md +++ b/docs/analytics-modules-accessibility-widgets.md @@ -1,6 +1,6 @@ --- id: analytics-modules-accessibility-widgets -title: Analytics Modules - Overview +title: Accessibility Dashboard Widgets sidebar_label: Accessibility description: Discover LambdaTest's Accessibility Dashboard widgets for comprehensive accessibility testing insights. Optimize your accessibility testing efforts today. keywords: @@ -13,9 +13,10 @@ keywords: url: https://www.lambdatest.com/support/docs/analytics-modules-accessibility-widgets/ site_name: LambdaTest slug: analytics-modules-accessibility-widgets/ - --- +import NewTag from '../src/component/newTag'; + ---- - -import NewTag from '../src/component/newTag'; - -# Accessibility Dashboard Widgets - LambdaTest Accessibility Dashboard widgets provide comprehensive insights into your accessibility testing efforts. These widgets help you optimize your accessibility testing efforts by providing detailed insights into your accessibility testing scans, Top 10 URLs Issue Criticality, and more. diff --git a/docs/analytics-modules-automation-test-overview.md b/docs/analytics-modules-automation-test-overview.md index 7be2b6c30..f09c3e7d8 100644 --- a/docs/analytics-modules-automation-test-overview.md +++ b/docs/analytics-modules-automation-test-overview.md @@ -1,6 +1,6 @@ --- id: analytics-modules-automation-test-overview -title: Analytics Modules - Test Overview +title: Web & App Automation Modules sidebar_label: Web & App Automation description: A detailed guide to understanding the test health and trends module. Explore widgets for Test Status, Browser, OS Distribution, and more. keywords: @@ -38,11 +38,6 @@ slug: analytics-modules-automation-test-overview/ }) }} > - ---- - -# Understanding Your Test Performance with the Test Overview Module - The Test Overview module in LambdaTest Analytics is a powerful tool that provides you with a comprehensive view of your test performance across various dimensions. By leveraging this module, you can gain valuable insights into test flakiness, total tests run, and test categorization by status and platform. ## Test Health Snapshot diff --git a/docs/analytics-modules-error-insights.md b/docs/analytics-modules-error-insights.md index dec8db4d5..5ea6b4f25 100644 --- a/docs/analytics-modules-error-insights.md +++ b/docs/analytics-modules-error-insights.md @@ -1,6 +1,6 @@ --- id: analytics-modules-error-insights -title: Analytics Modules +title: Error Insights sidebar_label: Session Errors description: Analytics Modules - Error Insights keywords: @@ -33,11 +33,6 @@ slug: analytics-modules-error-insights/ }) }} > - ---- - -# Error Insights - The `Error Insights` module enables the users to get all the insights into the test errors on LambdaTest in one place. The user can easily find information about the count, and type of the test errors through the highly customizable widgets. ## Error Stats diff --git a/docs/analytics-modules-manual-test-overview.md b/docs/analytics-modules-manual-test-overview.md index 09d66f9bd..88515d5ca 100644 --- a/docs/analytics-modules-manual-test-overview.md +++ b/docs/analytics-modules-manual-test-overview.md @@ -1,9 +1,8 @@ --- id: analytics-modules-manual-test-overview -title: Analytics Modules - Test Overview +title: Realtime & Real-Device Modules sidebar_label: Realtime & Real-Device description: A complete guide to understanding LambdaTest Analytics! Optimize your testing process with widgets for Browser & App Testing - OS, Browser, Device, and Trends. - keywords: - analytics - test overview @@ -40,11 +39,6 @@ slug: analytics-modules-manual-test-overview/ }) }} > - ---- - -# Understanding Your Test Performance with the Test Overview Module - The Test Overview module in LambdaTest Analytics is a powerful tool that provides you with a comprehensive view of your test performance across various dimensions. By leveraging this module, you can gain valuable insights into test flakiness, total tests run, and test categorization by status and platform. ## Browser Testing Summary diff --git a/docs/analytics-modules-resource-utilization.md b/docs/analytics-modules-resource-utilization.md index 808080189..4ff5d67c0 100644 --- a/docs/analytics-modules-resource-utilization.md +++ b/docs/analytics-modules-resource-utilization.md @@ -1,6 +1,6 @@ --- id: analytics-modules-resource-utilization -title: Analytics Modules +title: Resource Utilization sidebar_label: Concurrency Usage Insights description: Optimize resource use with LambdaTest's Resource Utilization module. Monitor concurrency trends to manage parallel test sessions, reduce queuing times, and enhance efficiency. keywords: @@ -34,10 +34,6 @@ slug: analytics-modules-resource-utilization/ }} > ---- - -# Resource Utilization - The `Resource Utilization` module enables the QA Managers to get an overview of the LambdaTest resources being utilized by their teams. diff --git a/docs/analytics-modules-smartui.md b/docs/analytics-modules-smartui.md index 94ae01cd6..21c9cef12 100644 --- a/docs/analytics-modules-smartui.md +++ b/docs/analytics-modules-smartui.md @@ -1,6 +1,6 @@ --- id: analytics-modules-smartui-analytics -title: Analytics Modules - Overview +title: SmartUI Analytics - Visual Regression Testing Insights sidebar_label: SmartUI description: Discover LambdaTest's SmartUI Analytics widgets for comprehensive visual regression testing insights. Optimize your visual testing efforts today. keywords: @@ -12,9 +12,10 @@ keywords: url: https://www.lambdatest.com/support/docs/analytics-modules-smartui-analytics/ site_name: LambdaTest slug: analytics-modules-smartui-analytics/ - --- +import NewTag from '../src/component/newTag'; + - ---- - - -import NewTag from '../src/component/newTag'; - -# SmartUI Analytics - Visual Regression Testing Insights The SmartUI Analytics module provides a suite of widgets to help you analyze and optimize your visual regression testing efforts on the LambdaTest platform. By leveraging these widgets, you can gain valuable insights into the scale, coverage, and performance of your visual testing initiatives, enabling you to make data-driven decisions and ensure the highest quality of your application's visual integrity. :::note diff --git a/docs/analytics-modules-test-manager-widgets.md b/docs/analytics-modules-test-manager-widgets.md index 93d738fdf..7d6c1c9da 100644 --- a/docs/analytics-modules-test-manager-widgets.md +++ b/docs/analytics-modules-test-manager-widgets.md @@ -1,6 +1,6 @@ --- id: analytics-modules-test-manager-widgets -title: Analytics Modules - Overview +title: Test Manager Dashboard Widgets sidebar_label: Test Manager description: Discover LambdaTest's Test Manager Analytics widgets for comprehensive test cases insights. Optimize your testing efforts today. keywords: @@ -12,9 +12,10 @@ keywords: url: https://www.lambdatest.com/support/docs/analytics-modules-test-manager-widgets/ site_name: LambdaTest slug: analytics-modules-test-manager-widgets/ - --- +import NewTag from '../src/component/newTag'; + - ---- - -import NewTag from '../src/component/newTag'; - -# Test Manager Dashboard Widgets - LambdaTest Test Manager Dashboard widgets provide comprehensive insights into your test automation or manual efforts. These widgets help you optimize your testing efforts by providing detailed insights into your test execution, test case insights, and more. :::note diff --git a/docs/analytics-test-time-insights.md b/docs/analytics-test-time-insights.md index 55054ad00..636a10d5c 100644 --- a/docs/analytics-test-time-insights.md +++ b/docs/analytics-test-time-insights.md @@ -1,6 +1,6 @@ --- id: analytics-test-time-trends -title: Analytics Modules +title: Time Insights sidebar_label: Setup Time Insights description: Monitor and optimize test environment setup times with LambdaTest's Setup Time Insights module. Analyze trends, compare across platforms, and receive AI-driven optimization recommendations keywords: @@ -10,6 +10,8 @@ site_name: LambdaTest slug: analytics-test-time-trends/ --- +import NewTag from '../src/component/newTag'; + - ---- - -import NewTag from '../src/component/newTag'; - - -# Setup Time Insights - cmd ## Understanding The Setup Time Insights Widget diff --git a/docs/app-auto-network-throttling.md b/docs/app-auto-network-throttling.md index 1c37c5917..7efede171 100644 --- a/docs/app-auto-network-throttling.md +++ b/docs/app-auto-network-throttling.md @@ -1,6 +1,6 @@ --- id: app-auto-network-throttling -title: Network Throttling +title: Network Throttling for Appium tests hide_title: false sidebar_label: Network Throttling description: Now validate your mobile applications over low latency networks (2G/3G/LTE) or in offline mode with varying upload and download speeds. LambdaTest empowers you to simulate these mobile network conditions through its desired capabilities, ensuring comprehensive testing of your mobile applications. diff --git a/docs/biometric-authentication-on-real-devices.md b/docs/biometric-authentication-on-real-devices.md index d29b384d8..dcd058a8c 100644 --- a/docs/biometric-authentication-on-real-devices.md +++ b/docs/biometric-authentication-on-real-devices.md @@ -1,6 +1,6 @@ --- id: biometric-authentication-on-real-devices -title: Biometric Authentication +title: Biometric Authentication on Real Devices sidebar_label: Biometric Authentication description: Learn how to test biometric authentication in iOS and Android apps using LambdaTest's real device testing platform. Enhance app security and user experience. keywords: diff --git a/docs/cypress-v10-hyprerexecute-accessibility-tests.md b/docs/cypress-v10-hyprerexecute-accessibility-tests.md index 77df1f1db..b1d505c12 100644 --- a/docs/cypress-v10-hyprerexecute-accessibility-tests.md +++ b/docs/cypress-v10-hyprerexecute-accessibility-tests.md @@ -1,6 +1,6 @@ --- id: cypress-v10-hyprerexecute-accessibility-tests -title: Automation Tests with Accessibility Tool using Cypress v10 +title: Accessibility Testing on HyperExecute using Cypress v10 hide_title: false sidebar_label: Cypress v10 description: Use LambdaTest Accessibility DevTools with HyperExecute to detect and report accessibility issues, adhering to WCAG guidelines, in your cypress tests for version 10 and above diff --git a/docs/cypress-v9-hyprerexecute-accessibility-tests.md b/docs/cypress-v9-hyprerexecute-accessibility-tests.md index e5e79ff6b..f027bab98 100644 --- a/docs/cypress-v9-hyprerexecute-accessibility-tests.md +++ b/docs/cypress-v9-hyprerexecute-accessibility-tests.md @@ -1,6 +1,6 @@ --- id: cypress-v9-hyprerexecute-accessibility-tests -title: Automation Tests with Accessibility Tool using Cypress v9 +title: Accessibility Testing on HyperExecute using Cypress v9 hide_title: false sidebar_label: Cypress v9 description: Use LambdaTest Accessibility DevTools to detect and report accessibility issues with automation, following WCAG guidelines, in your cypress tests for version 9 and below diff --git a/docs/gitlab-integration-with-hyperexecute.md b/docs/gitlab-integration-with-hyperexecute.md index 44a9eb52a..416b16887 100644 --- a/docs/gitlab-integration-with-hyperexecute.md +++ b/docs/gitlab-integration-with-hyperexecute.md @@ -1,6 +1,6 @@ --- id: gitlab-integration-with-hyperexecute -title: GitLab Integration +title: GitLab Integration:HyperExecute hide_title: true sidebar_label: GitLab description: LambdaTest integrates with GitLab Pipeline to boost your go-to market delivery. Perform automated cross browser testing with LambdaTest to ensure your development code renders seamlessly through an online Selenium grid providing 3000+ real browsers running through machines. diff --git a/docs/hyperexecute-azure-test-plan.md b/docs/hyperexecute-azure-test-plan.md index db08b53b0..08ee0f887 100644 --- a/docs/hyperexecute-azure-test-plan.md +++ b/docs/hyperexecute-azure-test-plan.md @@ -1,7 +1,7 @@ --- id: hyperexecute-azure-test-plan -title: Azure Test Plan -hide_title: true +title: Azure Test Plan Integration with HyperExecute +hide_title: false sidebar_label: Azure Test Plan description: Seamless Azure Test Plan integration with HyperExecute for efficient test management and execution. Boost software quality effortlessly. keywords: @@ -38,9 +38,6 @@ slug: hyperexecute-azure-test-plan/ }) }} > - -# Azure Test Plan Integration with HyperExecute - > It is a **Premium** feature of Azure. You will have to buy access to [Azure Test Plans](https://learn.microsoft.com/en-us/azure/devops/organizations/billing/buy-access-tfs-test-hub?view=azure-devops-2022#buy-monthly-access-to-azure-test-plans) In this fast-paced world of software development, ensuring fast and quality testing cycle in not an option anymore, but a necessity. Imagine a scenario where your team is diligently working on a project, but managing test plans, suites, spreadsheets, and cases becomes a maze of complexity. This is where Azure Test Plan comes in as your bestfriend. diff --git a/docs/lambdatest-sso-manage-connection.md b/docs/lambdatest-sso-manage-connection.md index 5cec6f299..38b3164fa 100644 --- a/docs/lambdatest-sso-manage-connection.md +++ b/docs/lambdatest-sso-manage-connection.md @@ -1,6 +1,6 @@ --- id: lambdatest-sso-manage-connection -title: LambdaTest SSO +title: Manage SSO Connection hide_title: true sidebar_label: Manage SSO Connection description: This document will help you set up and manage your LambdaTest SSO connection. @@ -40,10 +40,6 @@ slug: lambdatest-sso-manage-connection/ }) }} > - - -# Manage SSO Connection ---- Navigate to LambdaTest Authentication & SSO settings. setup sso button diff --git a/docs/lambdatest-sso-self-serve.md b/docs/lambdatest-sso-self-serve.md index 30bd2120b..11637196b 100644 --- a/docs/lambdatest-sso-self-serve.md +++ b/docs/lambdatest-sso-self-serve.md @@ -1,6 +1,6 @@ --- id: lambdatest-sso-self-serve -title: LambdaTest SSO +title: Create SSO Connection With LambdaTest hide_title: true sidebar_label: Create SSO Connection description: LambdaTest allows you to integrate an external user directory with your LambdaTest Organization through an IDP so your team could leverage the Single Sign-on setup. This document will help you set up your LambdaTest SSO connection. @@ -37,11 +37,6 @@ slug: lambdatest-sso-self-serve/ }) }} > - -# Create SSO Connection With LambdaTest - -* * * - LambdaTest allows you to integrate an external user directory with your LambdaTest Organization through an IDP so your team could leverage the Single Sign-on setup using SAML. LambdaTest SSO supports the following: diff --git a/docs/list-of-supported-locales.md b/docs/list-of-supported-locales.md index 01c367da6..580b5b04a 100644 --- a/docs/list-of-supported-locales.md +++ b/docs/list-of-supported-locales.md @@ -1,6 +1,6 @@ --- id: list-of-supported-locales -title: Supported Locales And Languages +title: Supported Locales And Languages - Appium hide_title: false sidebar_label: Supported Locales And Languages description: Checkout the list of all supported locales by LambdaTest. diff --git a/docs/project-management-tools-gitlab-integration.md b/docs/project-management-tools-gitlab-integration.md index 2d242fa78..d2b347887 100644 --- a/docs/project-management-tools-gitlab-integration.md +++ b/docs/project-management-tools-gitlab-integration.md @@ -1,6 +1,6 @@ --- id: project-management-tools-gitlab-integration -title: GitLab Integration +title: GitLab Integration:LambdaTest hide_title: true sidebar_label: GitLab description: LambdaTest provides integrations with GitLab to help you log bugs directly from the middle of your test session on LambdaTest to your GitLab repository. diff --git a/docs/real-time-desktop-browser-testing-tools.md b/docs/real-time-desktop-browser-testing-tools.md index d5b4b73d6..ae36f987c 100644 --- a/docs/real-time-desktop-browser-testing-tools.md +++ b/docs/real-time-desktop-browser-testing-tools.md @@ -1,6 +1,6 @@ --- id: real-time-desktop-browser-testing-tools -title: How to use Testing Tools? +title: How to use Testing Tools for Desktop Browsers? hide_title: false sidebar_label: Testing Tools description: Enhance your web testing with LambdaTest's comprehensive tool suite. Capture screenshots, record sessions, manage files, and more. Test across devices, browsers, and locations for optimal results. diff --git a/docs/real-time-mobile-app-testing-tools.md b/docs/real-time-mobile-app-testing-tools.md index 3c04bb606..004e47728 100644 --- a/docs/real-time-mobile-app-testing-tools.md +++ b/docs/real-time-mobile-app-testing-tools.md @@ -1,6 +1,6 @@ --- id: real-time-mobile-app-testing-tools -title: How to use Testing Tools? +title: How to use Testing Tools for Mobile Applications? hide_title: false sidebar_label: Testing Tools description: Enhance mobile app testing with LambdaTest's comprehensive tools. Simulate actions, capture screenshots, record sessions, and more. Test across devices, locations, and network conditions for optimal results. diff --git a/docs/real-time-mobile-browser-testing-tools.md b/docs/real-time-mobile-browser-testing-tools.md index 6069d16bd..10340e0bf 100644 --- a/docs/real-time-mobile-browser-testing-tools.md +++ b/docs/real-time-mobile-browser-testing-tools.md @@ -1,6 +1,6 @@ --- id: real-time-mobile-browser-testing-tools -title: How to use Testing Tools? +title: How to use Testing Tools for Mobile Browsers? hide_title: false sidebar_label: Testing Tools description: Enhance your mobile app testing with LambdaTest's comprehensive tools. Simulate actions, capture screenshots, record sessions, and more. Test across devices, locations, and network conditions for optimal results. diff --git a/docs/regular-expression-appium.md b/docs/regular-expression-appium.md index 4b0f72f7f..6a9976a88 100644 --- a/docs/regular-expression-appium.md +++ b/docs/regular-expression-appium.md @@ -1,6 +1,6 @@ --- id: regular-expression-appium -title: Regular Expression (REGEX) +title: Regular Expression - Appium # hide_title: true sidebar_label: Regular Expression description: If your chosen device for testing on LambdaTest is unavailable, use REGEX to broaden the search request for alternative devices to run the test. diff --git a/docs/regular-expression-espresso.md b/docs/regular-expression-espresso.md index ff0407cba..f14fd32b3 100644 --- a/docs/regular-expression-espresso.md +++ b/docs/regular-expression-espresso.md @@ -1,6 +1,6 @@ --- id: regular-expression-espresso -title: Regular Expression (REGEX) +title: Regular Expression - Espresso # hide_title: true sidebar_label: Regular Expression description: If your chosen device for testing on LambdaTest is unavailable, use REGEX to broaden the search for alternative devices to run espresso test. diff --git a/docs/regular-expression-xcui.md b/docs/regular-expression-xcui.md index ff033c0ff..99e0236c9 100644 --- a/docs/regular-expression-xcui.md +++ b/docs/regular-expression-xcui.md @@ -1,6 +1,6 @@ --- id: regular-expression-xcui -title: Regular Expression (REGEX) +title: Regular Expression - XCUI # hide_title: true sidebar_label: Regular Expression description: There may be instances when the device you chose for a test on LambdaTest is not available. In these scenarios, REGEX will help you widen the search request for devices to run the test on. diff --git a/docs/robot-on-hyperexecute-grid.md b/docs/robot-on-hyperexecute-grid.md index 41339458a..33ef7f844 100644 --- a/docs/robot-on-hyperexecute-grid.md +++ b/docs/robot-on-hyperexecute-grid.md @@ -1,6 +1,6 @@ --- id: robot-on-hyperexecute-grid -title: Robot Framework Selenium:Run Automation Scripts on Selenium Grid Cloud +title: Running Robot Framework Tests on HyperExecute hide_title: true sidebar_label: Robot description: Now you can run your automation scripts using Selenium with Robot on LambdaTest online grid of 2000+ real desktop browsers and real operating systems. @@ -49,8 +49,6 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co }) }} > - -# Running Robot Framework Tests on HyperExecute Robot Framework is a powerful open-source automation framework for Selenium that supports keyword-driven and behavior-driven development. With an easy-to-read syntax and a rich set of libraries, it simplifies the creation and execution of Selenium test scripts. HyperExecute is an AI-powered Test Orchestration Cloud Platform that empowers you to run **end-to-end** tests **quickly** and **efficiently**. It provides Just-in-Time (JIT) testing infrastructure with fast execution **speeds**, **smart orchestration**, and **detailed logs**. diff --git a/docs/robot-with-selenium-running-robot-automation-scripts-on-lambdatest-selenium-grid.md b/docs/robot-with-selenium-running-robot-automation-scripts-on-lambdatest-selenium-grid.md index eff088b01..66fce4944 100644 --- a/docs/robot-with-selenium-running-robot-automation-scripts-on-lambdatest-selenium-grid.md +++ b/docs/robot-with-selenium-running-robot-automation-scripts-on-lambdatest-selenium-grid.md @@ -1,6 +1,6 @@ --- id: robot-with-selenium-running-robot-automation-scripts-on-lambdatest-selenium-grid -title: Robot Framework Selenium:Run Automation Scripts on Selenium Grid Cloud +title: Robot framework:Run automation scripts on LambdaTest-Selenium Grid hide_title: true sidebar_label: Robot description: Now you can run your automation scripts using Selenium with Robot on LambdaTest online grid of 3000+ real desktop browsers and real operating systems. diff --git a/docs/screen-reader-on-real-devices-app.md b/docs/screen-reader-on-real-devices-app.md index e19a57909..898cbbba6 100644 --- a/docs/screen-reader-on-real-devices-app.md +++ b/docs/screen-reader-on-real-devices-app.md @@ -1,6 +1,6 @@ --- id: screen-reader-on-real-devices-app -title: Screen Reader (TalkBack) for Android +title: Screen Reader (TalkBack) for Android Application sidebar_label: Screen Reader description: Test your app's accessibility with LambdaTest's Screen Reader. Navigate through app elements with spoken descriptions on real Android devices, ensuring compliance with WCAG standards. keywords: diff --git a/docs/screen-reader-on-real-devices-browser.md b/docs/screen-reader-on-real-devices-browser.md index 457a9c0da..cf28231df 100644 --- a/docs/screen-reader-on-real-devices-browser.md +++ b/docs/screen-reader-on-real-devices-browser.md @@ -1,6 +1,6 @@ --- id: screen-reader-on-real-devices-browser -title: Screen Reader (TalkBack) for Android +title: Screen Reader (TalkBack) for Android - Web Browser sidebar_label: Screen Reader description: Test the accessibility of your website with the Screen Reader from LambdaTest. Using actual Android devices, navigate through elements with spoken descriptions to make sure they adhere to WCAG standards. keywords: diff --git a/docs/smartui-cli-upload.md b/docs/smartui-cli-upload.md index c29f3ccdb..d6efba119 100644 --- a/docs/smartui-cli-upload.md +++ b/docs/smartui-cli-upload.md @@ -1,6 +1,6 @@ --- id: smartui-cli-upload -title: Getting started with Lambdatest's Smart UI CLI +title: Upload your Screenshots via CLI sidebar_label: Upload through CLI description: In this documentation, learn how to upload and compare images (jpgs, jpegs, pngs) using the SmartUI CLI. keywords: @@ -48,9 +48,6 @@ import NewTag from '../src/component/newTag'; }) }} > - -Welcome to the LambdaTest SmartUI CLI documentation! - With SmartUI CLI, you can seamlessly perform visual regression testing on the LambdaTest platform using your command line, identifying Visual UI Regression bugs effortlessly. This guide will walk you through the process of uploading and comparing images using the SmartUI CLI. ## Prerequisites for running SmartUI CLI @@ -70,10 +67,7 @@ The first step is to create a project with the application in which we will comb 4. Add name of the project, approvers for the changes found, tags for any filter or easy navigation. 5. Click on the **Submit**. -## Steps to run your first test - - -### **Step 1**: Install the Dependencies +## Step 1: Install the Dependencies Install required NPM modules for `LambdaTest Smart UI CLI` in your **Frontend** project. @@ -81,7 +75,7 @@ Install required NPM modules for `LambdaTest Smart UI CLI` in your **Frontend** npm install @lambdatest/smartui-cli ``` -### **Step 2:** Configure your Project Token +## Step 2: Configure your Project Token Setup your project token show in the **SmartUI** app after, creating your project. @@ -104,7 +98,7 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" cmd -### **Step 3:** Upload the required directory of images +## Step 3: Upload the required directory of images ``` npx smartui upload @@ -112,7 +106,7 @@ npx smartui upload The screenshots in the directory name will be uploaded to SmartUI. -#### For ignoring the resolutions of the images +### For ignoring the resolutions of the images By default, SmartUI captures and considers image resolutions. If you prefer to ignore resolutions and compare images solely based on their names, use the following flag: @@ -120,8 +114,7 @@ By default, SmartUI captures and considers image resolutions. If you prefer to i npx smartui upload --ignoreResolutions ``` - -#### SmartUI CLI Upload Options +### SmartUI CLI Upload Options Please read the following table for more information about the options available to upload a directory of static images to SmartUI. @@ -137,7 +130,7 @@ Please read the following table for more information about the options available You may use the `smartui upload --help` command in case you are facing issues during the execution of SmartUI Upload options in the CLI. ::: -### Setup with Continuous Integration (CI) +## Setup with Continuous Integration (CI) If you are using the Continuous Integration (CI) pipeline for your application and want to integrate `SmartUI CLI` execution then the following are the steps needs to be added to your `.yaml` file: @@ -151,7 +144,7 @@ steps: npx smartui upload --removeExtensions ``` -### SmartUI CLI Options and Keys +## SmartUI CLI Options and Keys The following are supported `CLI (Command Line Interface)` options for Visual Regression Testing with SmartUI: @@ -160,29 +153,29 @@ The following are supported `CLI (Command Line Interface)` options for Visual Re | --config | This is the reference configuration file containing the SmartUI Cloud Configuration | Optional | | --help | This will print all help information for the SmartUI CLI options | Optional | -### View SmartUI Results +## View SmartUI Results You can see the Smart UI dashboard to view the results. This will help you identify the Mismatches from the existing `Baseline` build and do the required visual testing. -### Fetch results +## Fetch results You can fetch build results by adding the `--fetch-results` flag to your test execution command. Here are different ways to use this feature: -#### Default Usage +### Default Usage If no filename is specified, results will be stored in `results.json`: ```bash npx smartui upload --fetch-results ``` -#### Custom Filename +### Custom Filename Specify a custom filename for your results: ```bash npx smartui upload --fetch-results custom-results.json ``` -### Adding a custom build name +## Adding a custom build name You can add a custom build name by adding the `--buildName` flag to your test execution command. Here is how you can utilise this feature: Specify a custom build name to group your screenshots in the following way: diff --git a/docs/smartui-cli.md b/docs/smartui-cli.md index 45a1b35e2..58017ac6b 100644 --- a/docs/smartui-cli.md +++ b/docs/smartui-cli.md @@ -1,6 +1,6 @@ --- id: smartui-cli -title: Getting started with Lambdatest's Smart UI CLI +title: Capture Static URLs via CLI sidebar_label: Capture Static URLs description: In this documentation, learn how to perform Visual UI Testing using command line interface on the LambdaTest Automation Cloud across 40+ browser versions. keywords: @@ -75,10 +75,7 @@ The first step is to create a project with the application in which we will comb 4. Add name of the project, approvers for the changes found, tags for any filter or easy navigation. 5. Click on the **Submit**. -## Steps to run your first test - - -### **Step 1**: Install the Dependencies +## Step 1: Install the Dependencies Install required NPM modules for `LambdaTest Smart UI CLI` in your **Frontend** project. @@ -86,7 +83,7 @@ Install required NPM modules for `LambdaTest Smart UI CLI` in your **Frontend** npm install @lambdatest/smartui-cli ``` -### **Step 2:** Create URL file +## Step 2: Create URL file ``` smartui config:create-web-static urls.json @@ -114,7 +111,7 @@ If you are using any async components, you can add wait time for the page to loa ::: -### **Step 3:** Configure your Project Token +## Step 3: Configure your Project Token Setup your project token show in the **SmartUI** app after, creating your project. @@ -137,7 +134,7 @@ set PROJECT_TOKEN="123456#1234abcd-****-****-****-************" cmd -### **Step 4:** Create and Configure SmartUI Config +## Step 4: Create and Configure SmartUI Config You can now configure your project settings on using various available options to run your tests with the SmartUI integration. To generate the configuration file, please execute the following command: @@ -179,7 +176,7 @@ Once, the configuration file will be created, you will be seeing the default con } ``` -#### For capturing viewport screenshots +### For capturing viewport screenshots To capture a screenshot of the content currently visible in your viewport, rather than the entire page, it's important to define the viewport's width and height in your configuration settings. Specify the desired width and height parameters as demonstrated in the following example to ensure that the screenshot encompasses only the viewport area. @@ -204,7 +201,7 @@ To capture a screenshot of the content currently visible in your viewport, rathe You may use the `smartui --help` command in case you are facing issues during the execution of SmartUI commands in the CLI. ::: -#### SmartUI CLI Config Options +### SmartUI CLI Config Options Please read the following table for more information about the configuration file: @@ -214,10 +211,7 @@ Please read the following table for more information about the configuration fil | resolutions | You can add all the supported browser viewpoints here to run your tests for SmartUI
Ex: `[1920, 1080],[width, height] etc..`
| Mandatory | - - - -### **Step 5:** Execute the Tests on SmartUI Cloud using CLI +## **Step 5:** Execute the Tests on SmartUI Cloud using CLI You can now execute tests for `Visual Regression Testing` using the following options:. @@ -225,26 +219,25 @@ You can now execute tests for `Visual Regression Testing` using the following op npx smartui capture urls.json --config .smartui.json ``` - -### Fetch results +## Fetch results You can fetch build results by adding the `--fetch-results` flag to your test execution command. Here are different ways to use this feature: -#### Default Usage +### Default Usage If no filename is specified, results will be stored in `results.json`: ```bash npx smartui capture urls.json --config .smartui.json --fetch-results ``` -#### Custom Filename +### Custom Filename Specify a custom filename for your results: ```bash npx smartui capture urls.json --config .smartui.json --fetch-results custom-results.json ``` -### Adding a custom build name +## Adding a custom build name You can add a custom build name by adding the `--buildName` flag to your test execution command. Here is how you can utilise this feature: Specify a custom build name to group your screenshots in the following way: @@ -259,7 +252,7 @@ npx smartui capture urls.json --buildName "Sample Build Name" --config .smartui. > - Existing screenshots with the same name and configuration in the build will be overwritten during a re-run. -### Setup with Continuous Integration (CI) +## Setup with Continuous Integration (CI) If you are using the Continuous Integration (CI) pipeline for your application and want to integrate `SmartUI CLI` execution then the following are the steps needs to be added to your `.yaml` file: @@ -273,7 +266,7 @@ steps: smartui capture urls.json --config smartui-web.json ``` -### SmartUI CLI Options and Keys +## SmartUI CLI Options and Keys The following are supported `CLI (Command Line Interface)` options for Visual Regression Testing with SmartUI: @@ -288,7 +281,7 @@ You can see the Smart UI dashboard to view the results. This will help you ident cmd -### Parallel execution of static URLs +## Parallel execution of static URLs You can reduce the build time by executing parallel URLs in the following way. @@ -304,7 +297,7 @@ npx smartui capture urls.json --config .smartui.json --parallel npx smartui capture urls.json --config .smartui.json --parallel 3 --fetch-results >``` -#### Determining Optimal Thread Count +### Determining Optimal Thread Count The maximum number of parallel threads is calculated using the formula: log2(N) where N is the total number of URLs. >**For example:** @@ -312,7 +305,7 @@ The maximum number of parallel threads is calculated using the formula: log >- For 50 URLs: Maximum parallel threads = log2(50) = 5 threads >- For 25 URLs: Maximum parallel threads = log2(25) = 4 threads -#### Best Practices for parallel execution +### Best Practices for parallel execution - Start with a lower thread count and gradually increase based on your system's performance - Monitor system resources during execution diff --git a/docs/smartui-playwright-python-sdk.md b/docs/smartui-playwright-python-sdk.md index e3f0f2224..cbc5d2aa3 100644 --- a/docs/smartui-playwright-python-sdk.md +++ b/docs/smartui-playwright-python-sdk.md @@ -1,6 +1,6 @@ --- id: smartui-playwright-python-sdk -title: Integrate SmartUI SDK with Playwright Tests +title: Integrate SmartUI SDK with Playwright-Python sidebar_label: Python description: In this documentation, learn how integrate your Playwright Python automated tests with LambdaTest's SmartUI. keywords: diff --git a/docs/smartui-playwright-sdk.md b/docs/smartui-playwright-sdk.md index cb47b3118..43acb5689 100644 --- a/docs/smartui-playwright-sdk.md +++ b/docs/smartui-playwright-sdk.md @@ -1,7 +1,7 @@ --- id: smartui-playwright-sdk -title: Integrate SmartUI SDK with Playwright Tests -sidebar_label: Javascript +title: Integrate SmartUI SDK with Playwright-JavaScript +sidebar_label: JavaScript description: In this documentation, learn how integrate your Playwright automated tests with LambdaTest's SmartUI. keywords: - Visual Regression diff --git a/docs/smartui-selenium-csharp-sdk.md b/docs/smartui-selenium-csharp-sdk.md index 0424f62e9..35c00bdb7 100644 --- a/docs/smartui-selenium-csharp-sdk.md +++ b/docs/smartui-selenium-csharp-sdk.md @@ -1,6 +1,6 @@ --- id: smartui-selenium-csharp-sdk -title: Integrate SmartUI SDK with Selenium Tests +title: Integrate SmartUI SDK with Selenium-CSharp sidebar_label: C# description: In this documentation, learn how integrate your Selenium C# automated tests with LambdaTest's SmartUI. keywords: diff --git a/docs/smartui-selenium-java-sdk.md b/docs/smartui-selenium-java-sdk.md index 8bb2e9522..5569353f8 100644 --- a/docs/smartui-selenium-java-sdk.md +++ b/docs/smartui-selenium-java-sdk.md @@ -1,6 +1,6 @@ --- id: smartui-selenium-java-sdk -title: Integrate SmartUI SDK with Selenium Tests +title: Integrate SmartUI SDK with Selenium-Java sidebar_label: Java description: In this documentation, learn how integrate your Selenium Java automated tests with LambdaTest's SmartUI. keywords: diff --git a/docs/smartui-selenium-js-sdk.md b/docs/smartui-selenium-js-sdk.md index 23b400164..13a99cdf3 100644 --- a/docs/smartui-selenium-js-sdk.md +++ b/docs/smartui-selenium-js-sdk.md @@ -1,6 +1,6 @@ --- id: smartui-selenium-js-sdk -title: Integrate SmartUI SDK with Selenium Tests +title: Integrate SmartUI SDK with Selenium-JavaScript sidebar_label: Javascript description: In this documentation, learn how integrate your Selenium Javascript automated tests with LambdaTest's SmartUI. keywords: diff --git a/docs/smartui-selenium-python-sdk.md b/docs/smartui-selenium-python-sdk.md index bcb4d2a3d..1b22e0615 100644 --- a/docs/smartui-selenium-python-sdk.md +++ b/docs/smartui-selenium-python-sdk.md @@ -1,6 +1,6 @@ --- id: smartui-selenium-python-sdk -title: Integrate SmartUI SDK with Selenium Tests +title: Integrate SmartUI SDK with Selenium-Python sidebar_label: Python description: In this documentation, learn how integrate your Selenium Python automated tests with LambdaTest's SmartUI. keywords: diff --git a/docs/smartui-selenium-ruby-sdk.md b/docs/smartui-selenium-ruby-sdk.md index 66c655c52..18b31ae37 100644 --- a/docs/smartui-selenium-ruby-sdk.md +++ b/docs/smartui-selenium-ruby-sdk.md @@ -1,6 +1,6 @@ --- id: smartui-selenium-ruby-sdk -title: Integrate SmartUI SDK with Selenium Tests +title: Integrate SmartUI SDK with Selenium-Ruby sidebar_label: Ruby description: In this documentation, learn how integrate your Selenium Ruby automated tests with LambdaTest's SmartUI. keywords: diff --git a/docs/supported-appium-versions-on-emulator-simulator.md b/docs/supported-appium-versions-on-emulator-simulator.md index 2f2d2c568..10f44c305 100644 --- a/docs/supported-appium-versions-on-emulator-simulator.md +++ b/docs/supported-appium-versions-on-emulator-simulator.md @@ -1,6 +1,6 @@ --- id: supported-appium-versions-on-emulator-simulator -title: Supported Appium Versions +title: Supported Appium Versions - Virtual Devices hide_title: false sidebar_label: Supported Appium Versions description: Find detailed information on the compatible Appium versions for testing your Android apps on virtual devices (emulator/simulator) using LambdaTest. diff --git a/docs/supported-appium-versions.md b/docs/supported-appium-versions.md index 84cb3e29e..6b49c1fea 100644 --- a/docs/supported-appium-versions.md +++ b/docs/supported-appium-versions.md @@ -1,6 +1,6 @@ --- id: supported-appium-versions -title: Supported Appium Versions +title: Supported Appium Versions - Real Devices hide_title: false sidebar_label: Supported Appium Versions description: This document provides information about configuring Appium versions for tests on the LambdaTest platform and also provides list of supported versions. diff --git a/docs/supported-locales-espresso.md b/docs/supported-locales-espresso.md index 6cba901b3..a2d80c4d3 100644 --- a/docs/supported-locales-espresso.md +++ b/docs/supported-locales-espresso.md @@ -1,6 +1,6 @@ --- id: supported-locales-espresso -title: Supported Locales And Languages +title: Supported Locales And Languages - Espresso hide_title: false sidebar_label: Supported Locales And Languages description: Checkout the list of all supported locales for espresso. diff --git a/docs/supported-locales-xcui.md b/docs/supported-locales-xcui.md index 8caf2825e..b457a0e4d 100644 --- a/docs/supported-locales-xcui.md +++ b/docs/supported-locales-xcui.md @@ -1,6 +1,6 @@ --- id: supported-locales-xcui -title: Supported Locales And Languages +title: Supported Locales And Languages - XCUI hide_title: false sidebar_label: Supported Locales And Languages description: Checkout the list of all supported locales