Merge pull request #2239 from sakshamarora-arch/stage

Updated documentation

Author: surishubham

docs/appium-firebase-app-upload.md

@@ -49,9 +49,9 @@ import TabItem from '@theme/TabItem';
 import RealDeviceTag from '../src/component/realDevice';
 
 ---
-
-## Tutorial to test an app uploaded on Firebase
 <RealDeviceTag value="Real Device" /> 
+## Tutorial to test an app uploaded on Firebase
+
 **Firebase** is a platform developed by **Google** for creating mobile and web applications. **LambdaTest cloud platform** provides you various methods to upload your files on a real device like from playstore and appstore. Uploading an app through Firebase is one such method.
 
 ## How to Start with Firebase

docs/appium-install-uninstall-hook.md

@@ -55,7 +55,8 @@ import VirtualDeviceTag from '../src/component/virtualDevice';
 
 LambdaTest now allows you to install and uninstall apps in the middle of your automated tests. This means you don’t need to restart the session every time you want to switch apps, upgrade them, or clean up the device.
 
-## Installing and Uninstalling Apps
+## Installing and Uninstalling Apps  
+<RealDeviceTag value="Real Device" /> <VirtualDeviceTag value="Virtual Device" />
 
 LambdaTest enables you to install and uninstall applications during automation test execution by using commands that can be run through WebDriver's script execution functionality.
 

docs/application-setup-via-api.md

@@ -117,7 +117,7 @@ The maximum size for application should not exceed 1GB.
 The upload time of your application can range from a few seconds to a minute, depending on the size of your application. Therefore, do not interrupt the cURL command request until you receive the response.
 :::
 
-## Fetch your Applications
+## Fetch your Applications for Real Devices
 
 <Tabs className="docs__val">
 
@@ -161,6 +161,30 @@ Shown below is the response to the above cURL request.
 }
 ```
 
+## Fetch your Applications for Virtual Devices
+
+<Tabs className="docs__val">
+
+<TabItem value="android" label="Android" default>
+  <div className="lambdatest__codeblock">
+    <CodeBlock className="language-bash">
+  {`curl --location --request GET "https://${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}@manual-api.lambdatest.com/app/data?type=emulator&level=user"`}
+  </CodeBlock>
+</div>
+
+</TabItem>
+
+<TabItem value="ios" label="iOS" default>
+  <div className="lambdatest__codeblock">
+    <CodeBlock className="language-powershell">
+  {`curl --location --request GET "https://${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}@manual-api.lambdatest.com/app/data?type=simulator&level=user"`}
+  </CodeBlock>
+</div>
+
+</TabItem>
+</Tabs>
+
+
 ## Deleting your Application
 
 <Tabs className="docs__val">

docs/supported-appium-versions.md

@@ -26,9 +26,6 @@ import NewTag from '../src/component/newTag';
 import RealDeviceTag from '../src/component/realDevice';
 import VirtualDeviceTag from '../src/component/virtualDevice';
 
-<RealDeviceTag value="Real Device" /> 
-<VirtualDeviceTag value="Virtual Device" />
-
 <script type="application/ld+json"
       dangerouslySetInnerHTML={{ __html: JSON.stringify({
        "@context": "https://schema.org",
@@ -52,9 +49,12 @@ import VirtualDeviceTag from '../src/component/virtualDevice';
       })
     }}
 ></script>
+# Supported Appium Versions
+<RealDeviceTag value="Real Device" /> 
+<VirtualDeviceTag value="Virtual Device" />
 Customize your testing experience on LambdaTest by selecting the appropriate Appium version for your tests on real devices. LambdaTest offers flexibility in choosing the Appium version to meet your testing requirements. By default, the suitable Appium version is selected based on the operating system (OS) when running tests. However, you can explicitly specify the  version using the `appiumVersion` capability in your test scripts.
 
-## Appium Version Configuration
+## Appium Version Configuration for Real Devices
 To configure the Appium version for your tests on LambdaTest, use the `appiumVersion` capability in your test scripts. Below is a table of supported Appium versions for different platforms:
 
 | Platform Versions | Supported Versions | Default Version | Latest Version |
@@ -65,16 +65,6 @@ To configure the Appium version for your tests on LambdaTest, use the `appiumVer
 | fireos | 1.21.0, 1.22.0, 1.22.3, 2.0.0, 2.1.3, 2.2.1, 2.3.0 | 2.2.1 | 2.3.0 |
 | tvos | 1.22.3, 2.2.1 | 1.22.3 | 1.22.3 |
 
-:::info
-
-**For Virtual Devices:**
-- LambdaTest currently supports the following Appium versions:
-  - **Android Devices:** `1.21.0`, `1.22.3`, `2.0.0`, `2.1.3`, `2.16.2`
-  - **iOS Devices:** `1.22.3`, `2.0.0`, `2.1.3`, `2.16.2`
-- We also provide Support for Appium 3.0.2 
-  - **Android Devices:** `13`, `15`, `16`
-  - **iOS Devices:** `16`, `17`, `18`, `26`
-:::
 **Java Example:** 
 ```java
 // Java code for configuring Appium version in tests on LambdaTest
@@ -111,4 +101,19 @@ capabilities.setCapability("platformName", "ios");
 :::note 
 - If a user passes any Appium version other than the mentioned versions, appropriate error will be thrown.
 - For devices running iOS 17 and newer, it is recommended to use Appium versions `2.2.1` and `above` to ensure the best compatibility and performance.
-:::
+:::
+
+
+## Appium Version Configuration for Virtual Devices
+
+| Platform Versions | Supported Versions | 
+|-------------------|--------------------|
+| Android | 1.21.0, 1.22.3, 2.0.0, 2.1.3, 2.16.2 |
+| iOS |1.22.3, 2.0.0, 2.1.3, 2.16.2 |
+
+
+:::info
+- We also provide Support for Appium 3.0.2 on following versions
+  - **Android Devices:** 13, 15, 16
+  - **iOS Devices:** 16, 17, 18, 26
+:::

docs/supported-locales-xcui.md

@@ -179,7 +179,13 @@ curl --location --request POST 'https://mobile-api.lambdatest.com/framework/v1/x
 ```
 
 :::note
-- Ensure that both the **language** and **locale** parameters are passed simultaneously in the API request.
-- App should support the language and locale mentioned in the API request to work.
-- For XCUI sharding tests, you have to mention this in the `.yaml` file.
+- When setting language or locale parameters, make sure your tests use the `ProcessInfo` object to pass these arguments correctly. This ensures the app launches with the specified language and locale settings.
+ ```swift
+    let app = XCUIApplication()
+    app.launchArguments += ProcessInfo().arguments
+    app.launch() 
+```
+-	The language and locale settings are applied at the app level.
+-	To ensure your application under test displays the correct localized strings, dates, times, and calendar formats, include both language and locale in your desired capabilities.
+- For XCUI sharding tests, you have to mention this in the  `.yaml` file.
 :::

docs/supported-timezone.md

@@ -48,7 +48,7 @@ import VirtualDeviceTag from '../src/component/virtualDevice';
     }}
 ></script>
 
-# Setting up timezone on Real Devices
+# Setting up timezone 
 <RealDeviceTag value="Real Device" /> 
 <VirtualDeviceTag value="Virtual Device" />
 In automated testing with Appium on LambdaTest, configuring the timezone accurately is crucial for precise testing scenarios. LambdaTest provides support for various timezones, allowing users to customize their testing environments to meet specific requirements.