From d1f1248eff7f776ac0e006f7a3ca18431c8d40f6 Mon Sep 17 00:00:00 2001
From: Saksham Arora <sakshamarora@lambdatest.com>
Date: Mon, 8 Dec 2025 16:35:41 +0530
Subject: [PATCH] Updated documentation

---
 docs/getting-started-with-xcuitest.md |  9 ++++++-
 docs/regular-expression-xcui.md       |  3 +++
 docs/sharding-xcui.md                 |  3 ++-
 docs/speedup-xcui.md                  |  9 ++++---
 docs/xcresult.md                      |  4 ++--
 docs/xctestplan.md                    |  3 +++
 docs/xcui-supported-capibilities.md   | 34 ++++++++++++++-------------
 docs/xcui-xml-report.md               |  3 +++
 8 files changed, 45 insertions(+), 23 deletions(-)

diff --git a/docs/getting-started-with-xcuitest.md b/docs/getting-started-with-xcuitest.md
index e1ce900e0..1d86834f2 100644
--- a/docs/getting-started-with-xcuitest.md
+++ b/docs/getting-started-with-xcuitest.md
@@ -18,6 +18,8 @@ slug: getting-started-with-xcuitest/
 
 import CodeBlock from '@theme/CodeBlock';
 import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
+import RealDeviceTag from '../src/component/realDevice';
+import VirtualDeviceTag from '../src/component/virtualDevice';
 
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
@@ -42,7 +44,7 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
       })
     }}
 ></script>
-
+<RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />
 Developed by Apple, XCUITest is a framework for user-interface (UI) testing for iOS applications. It is built on top of XCTest, an integrated test framework in Apple's Xcode IDE. LambdaTest lets you perform automated app testing of your iOS apps using XCUITest across 10000+ real devices and OS combinations.
 
 ## Prerequisites
@@ -227,6 +229,11 @@ curl --location --request POST 'https://mobile-api.lambdatest.com/framework/v1/x
 }'
 ```
 
+:::info
+- For Virtual Devices, both the App file and Test-suite should be in the `Zip format`.
+- We need to pass the following capability `isvirtualdevice:true` as well when we are running test for Virtual Devices.
+:::
+
 <nav aria-label="breadcrumbs">
   <ul className="breadcrumbs">
     <li className="breadcrumbs__item">
diff --git a/docs/regular-expression-xcui.md b/docs/regular-expression-xcui.md
index 99e0236c9..56cb48fb0 100644
--- a/docs/regular-expression-xcui.md
+++ b/docs/regular-expression-xcui.md
@@ -12,6 +12,8 @@ site_name: LambdaTest
 slug: regular-expression-xcui/
 ---
 
+import RealDeviceTag from '../src/component/realDevice';
+
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",
@@ -35,6 +37,7 @@ slug: regular-expression-xcui/
       })
     }}
 ></script>
+<RealDeviceTag value="Real Device" />
 Regular Expression or REGEX is widely used to make searching/find characters in a string.
 
 When you run a test on LambdaTest using a specific device, there may be scenarios, in which the particular device that you selected isn’t available. In these scenarios, REGEX will help you widen the search request for devices to run the test on.
diff --git a/docs/sharding-xcui.md b/docs/sharding-xcui.md
index 3a981df5b..23782e638 100644
--- a/docs/sharding-xcui.md
+++ b/docs/sharding-xcui.md
@@ -22,6 +22,7 @@ import CodeBlock from '@theme/CodeBlock';
 import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
+import RealDeviceTag from '../src/component/realDevice';
 
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
@@ -47,7 +48,7 @@ import TabItem from '@theme/TabItem';
     }}
 ></script>
 
-
+<RealDeviceTag value="Real Device" />
 Generally the XCUI tests are run in sequence which is a time taking process. This document explains how you can speed up this process by splitting the tests into **shards**. We can divide the various tests into shards which can run parallelly and save time while running various XCUI tests. 
 
 This document will cover how to execute **XCUI Tests** on real devices with **HyperExecute**. HyperExecute is a smart test orchestration platform to run end-to-end tests at the fastest speed possible. HyperExecute is configured using a YAML file.
diff --git a/docs/speedup-xcui.md b/docs/speedup-xcui.md
index 860188901..7123535a6 100644
--- a/docs/speedup-xcui.md
+++ b/docs/speedup-xcui.md
@@ -24,6 +24,9 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
+import RealDeviceTag from '../src/component/realDevice';
+import VirtualDeviceTag from '../src/component/virtualDevice';
+
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",
@@ -47,7 +50,7 @@ import TabItem from '@theme/TabItem';
       })
     }}
 ></script>
-
+<RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />
 Usually, all the test cases of your XCUI test suite are executed, but there is a way to filter these. You can specify some selected classes or tests, which provides you with options to filter the test cases which you want to execute.
 
 To filter the test cases, you just need to pass the suitable parameters in LambdaTest’s REST API request. Refer to the table below to understand how to use various filters provided by LambdaTest.
@@ -73,8 +76,8 @@ curl --location --request POST 'https://mobile-api.lambdatest.com/framework/v1/x
 
 | Parameters | Description | Values | Datatype | 
 |----------- | ----------- | ------ | -------- |
-| `only-testing` | Allows the user to run only those tests/classes provided in the list | Values can be of the following format: className or className/testName. E.g. `["Class1/Test1", "Class2"]` | Array |
-| `skip-testing`| Allows the user to run all the tests/classes except the ones provided in the list | Values can be of the following format: className or className/testName. E.g. `["Class1/Test1", "Class2"]` | Array |
+| `only-testing` <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| Allows the user to run only those tests/classes provided in the list | Values can be of the following format: className or className/testName. E.g. `["Class1/Test1", "Class2"]` | Array |
+| `skip-testing`<RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" /> | Allows the user to run all the tests/classes except the ones provided in the list | Values can be of the following format: className or className/testName. E.g. `["Class1/Test1", "Class2"]` | Array |
 
 :::info Note
 You can not use the following filters simultaneously. 
diff --git a/docs/xcresult.md b/docs/xcresult.md
index a2f2035c0..e7dfc6610 100644
--- a/docs/xcresult.md
+++ b/docs/xcresult.md
@@ -21,6 +21,7 @@ import CodeBlock from '@theme/CodeBlock';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
+import RealDeviceTag from '../src/component/realDevice';
 
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
@@ -45,9 +46,8 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
       })
     }}
 ></script>
-
 # XCResult on LambdaTest
-
+<RealDeviceTag value="Real Device" />
 Apple’s **Native XCResult Bundles (`.xcresult`)** are comprehensive test reports generated when you run XCUITest cases. These bundles include **test hierarchy, logs, stack traces, screenshots, and performance data**, which can be directly viewed in Xcode. They provide developers with rich debugging information, making it easier to analyze why a test passed or failed.  
 
 On LambdaTest, you can now **generate and download `.xcresult` bundles** for your XCUI test sessions. You can access them via the **REST API**.
diff --git a/docs/xctestplan.md b/docs/xctestplan.md
index ea9f3399c..c3c8e2810 100644
--- a/docs/xctestplan.md
+++ b/docs/xctestplan.md
@@ -24,6 +24,8 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
+import RealDeviceTag from '../src/component/realDevice';
+
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",
@@ -47,6 +49,7 @@ import TabItem from '@theme/TabItem';
       })
     }}
 ></script>
+<RealDeviceTag value="Real Device" />
 XCTestPlan is a feature within Xcode used for building iOS, iPadOS, macOS, watchOS, tvOS, and audioOS applications. XCTestPlan helps manage how you run automated tests written with the XCTest framework.
 
 XCTestPlan improves the organization and efficiency of running automated tests within Xcode. It allows you to create targeted test runs and manage various testing scenarios effectively.
diff --git a/docs/xcui-supported-capibilities.md b/docs/xcui-supported-capibilities.md
index 059dc96a7..4d1c07613 100644
--- a/docs/xcui-supported-capibilities.md
+++ b/docs/xcui-supported-capibilities.md
@@ -19,6 +19,8 @@ slug: xcui-supported-capabilities/
 
 import CodeBlock from '@theme/CodeBlock';
 import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
+import RealDeviceTag from '../src/component/realDevice';
+import VirtualDeviceTag from '../src/component/virtualDevice';
 
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
@@ -43,29 +45,29 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
       })
     }}
 ></script>
-
+<RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />
 This document provide details about the features and capabilities supported for XCUI Framework on LambdaTest.
 
 > The capabilities listed in this document are also supported for [Virtual Devices](/support/docs/app-automation-on-emulators-simulators/)
 
 | Capability Name | Data Type | Description |
 |------|-----------|-------------|
-| app | String | Enter the app id generated while uploading the app to the platform. Example:`lt://APP123456789123456789` |
-| testSuite | String | Enter the test suite id generated while uploading the test suite to the platform. Example: `lt://APP123456789123456789` |
-| device | String | Enter the device name and os version in `DeviceName-OSVersion` format. Example: `"device" :  ["Galaxy S20-10","Pixel 3 XL-9"]` |
-| video | Boolean | When you pass the `video: true`, it will generate the video for all the tests that are executed. |
-| queueTimeout | Integer | Enter the time in seconds after which you want your build to timeout from queue. Example: `queueTimeout: 300` |
-| idleTimeout | Integer | Enter the time in seconds for maximum running time of a test in a build. Example: `idleTimeout: 120`|
-| deviceLog | Boolean | To generate the device logs, pass the value as `deviceLog: true` |
-| network | String | To generate the network logs, pass the value as `network: true`. |
-| build | String | To set the Espresso build name. Example: `build: My Espresso Build`. |
-| geoLocation | String | Set the geolocation [country code](/support/docs/appium-ip-geolocation/#supported-ip-geolocations) if you want to enable the same in your test. Example: `geoLocation: FR`|
-| gpsLocation | Decimal | The capability should be defined to override the device’s default GPS coordinates and should be provided as a comma-separated string. Example: `"location": {"lat": "-50","long": "150.028333"}`.|
-| tunnel, tunnelName | Boolean | To activate the tunnel mode, pass the value as `tunnel: true` and provide the name of your tunnel as `tunnelName: NewTunnel` |
-| enableBluetooth | Boolean | Used to enable the bluetooth functionality during the session. Example: `enableBluetooth: true`|
+| app <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| String | Enter the app id generated while uploading the app to the platform. Example:`lt://APP123456789123456789` |
+| testSuite <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| String | Enter the test suite id generated while uploading the test suite to the platform. Example: `lt://APP123456789123456789` |
+| device <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| String | Enter the device name and os version in `DeviceName-OSVersion` format. Example: `"device" :  ["Galaxy S20-10","Pixel 3 XL-9"]` |
+| video <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| Boolean | When you pass the `video: true`, it will generate the video for all the tests that are executed. |
+| queueTimeout <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| Integer | Enter the time in seconds after which you want your build to timeout from queue. Example: `queueTimeout: 300` |
+| idleTimeout <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| Integer | Enter the time in seconds for maximum running time of a test in a build. Example: `idleTimeout: 120`|
+| deviceLog <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| Boolean | To generate the device logs, pass the value as `deviceLog: true` |
+| network <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| String | To generate the network logs, pass the value as `network: true`. |
+| build <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| String | To set the Espresso build name. Example: `build: My Espresso Build`. |
+| geoLocation <RealDeviceTag value="Real Device" />| String | Set the geolocation [country code](/support/docs/appium-ip-geolocation/#supported-ip-geolocations) if you want to enable the same in your test. Example: `geoLocation: FR`|
+| gpsLocation <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| Decimal | The capability should be defined to override the device’s default GPS coordinates and should be provided as a comma-separated string. Example: `"location": {"lat": "-50","long": "150.028333"}`.|
+| tunnel, tunnelName <RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />| Boolean | To activate the tunnel mode, pass the value as `tunnel: true` and provide the name of your tunnel as `tunnelName: NewTunnel` |
+| enableBluetooth <RealDeviceTag value="Real Device" />| Boolean | Used to enable the bluetooth functionality during the session. Example: `enableBluetooth: true`|
 | resignApp <br /> <br />Not supported in **Virtual Devices** | Boolean | Set this to `false` if you want to to prevent the apps from being re-signed. The app should be built for enterprise distribution. |
-| testRemarks <br /> <br />| Boolean | Set to `true` to surface failure remarks at the top of the dashboard when a test fails. Has no effect on passing tests. **Default**: `false`. |
-| retries <br /> <br /> | Integer |Defines the number of times a test should automatically retry if it fails. Maximum allowed value: 5.|
+| testRemarks <br /> <br />  <RealDeviceTag value="Real Device" />| Boolean| Set to `true` to surface failure remarks at the top of the dashboard when a test fails. Has no effect on passing tests. **Default**: `false`. |
+| retries <br /> <br />  <RealDeviceTag value="Real Device" />| Integer |Defines the number of times a test should automatically retry if it fails. Maximum allowed value: 5.|
 
 :::note
 Ensure that the latitude is between -90 and 90, and the longitude is between -180 and 180. Otherwise, an error will occur like "Invalid GPS location: Latitude must be between -90 and +90, Longitude must be between -180 and +180."
diff --git a/docs/xcui-xml-report.md b/docs/xcui-xml-report.md
index 4c8e464e7..8367e0d18 100644
--- a/docs/xcui-xml-report.md
+++ b/docs/xcui-xml-report.md
@@ -20,6 +20,8 @@ slug: xcui-report/
 
 import CodeBlock from '@theme/CodeBlock';
 import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";
+import RealDeviceTag from '../src/component/realDevice';
+import VirtualDeviceTag from '../src/component/virtualDevice';
 
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
@@ -44,6 +46,7 @@ import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/co
       })
     }}
 ></script>
+<RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />
 XML reports provide a detailed summary of test execution, allowing you to better understand your test outcomes. This document aims to guide you through the process of retrieving XML reports for XCUI tests executed on the LambdaTest platform.
 
 > This feature is also supported for [Virtual Devices](/support/docs/app-automation-on-emulators-simulators/)