testdriverai 5.5.4 → 5.5.6

package/docs/guide/variables.mdx

@@ -1,17 +1,20 @@
 ---
+title: "Variables"
+sidebarTitle: "Variables"
+description: "Learn how to use variables in TestDriver for dynamic data handling."
 icon: "square-root-variable"
 ---
 
-# Using Variables in TestDriver.ai
+# Using Variables in TestDriver
 
-Variables in **TestDriver.ai** allow you to dynamically store and reuse data during test execution. This feature is particularly useful for handling dynamic content, passing data between steps, and customizing test behavior based on runtime conditions.
+Variables in **TestDriver** allow you to dynamically store and reuse data during test execution. This feature is particularly useful for handling dynamic content, passing data between steps, and customizing test behavior based on runtime conditions.
 
 - Generate a random number or string and use it to fill out a form.
 - Capture API responses and validate their content.
 - Capture text or values from the screen and use them in assertions.
 - Pass different values to the test using environment variables for testing multiple scenarios.
 
-By leveraging variables in TestDriver.ai, you can create dynamic, flexible, and reusable test scripts that adapt to changing conditions and data.
+By leveraging variables in TestDriver, you can create dynamic, flexible, and reusable test scripts that adapt to changing conditions and data.
 
 #### Test File Example:
 
@@ -41,7 +44,7 @@ steps:
 ## GitHub Actions Example
 
 ```yaml
-name: TestDriver.ai with Variables
+name: TestDriver with Variables
 
 on:
   push:
@@ -58,10 +61,10 @@ jobs:
       - name: Check out repository
         uses: actions/checkout@v2
 
-      - name: Run TestDriver.ai
+      - name: Run TestDriver
         uses: testdriverai/action@main
         with:
-          key: ${{ secrets.TESTDRIVER_API_KEY }}
+          key: ${{ secrets.TD_API_KEY }}
           prompt: |
             1. Log in with username and password
             2. Verify the dashboard is displayed

package/docs/guide/waiting.mdx

@@ -1,12 +1,13 @@
 ---
-title: Waiting in TestDriver.ai
+title: Waiting in TestDriver
 sidebarTitle: Waiting
-icon: "hourglass-half"
+description: "Waiting in TestDriver: Ensuring Stability and Reducing Flakiness"
+icon: "clock"
 ---
 
-# Waiting in TestDriver.ai: Ensuring Stability and Reducing Flakiness
+# Waiting in TestDriver: Ensuring Stability and Reducing Flakiness
 
-Waiting is a critical feature in TestDriver.ai that ensures tests are stable and reliable, even in dynamic or slow-loading environments. 
+Waiting is a critical feature in TestDriver that ensures tests are stable and reliable, even in dynamic or slow-loading environments. 
 
 - Automatically adjusts to varying load times, reducing the need for hardcoded delays.
 - Ensures that tests wait for dynamic elements to appear, reducing false negatives caused by incomplete rendering.
@@ -21,10 +22,10 @@ Waiting is a critical feature in TestDriver.ai that ensures tests are stable and
 | **`wait-for-text`**   | Waits for specific text to appear on the screen.                                |
 | **`wait-for-image`**  | Waits for a specific image or visual element to appear on the screen.           |
 
-## Key Waiting Features in TestDriver.ai
+## Key Waiting Features in TestDriver
 
 1. **Automatic Waiting with `redraw`**:
-  - TestDriver.ai automatically waits for the machine before moving to the next step.
+  - TestDriver automatically waits for the machine before moving to the next step.
   - This includes waiting for:
     - UI changes to complete.
     - Network activity to stabilize (e.g., API calls).
@@ -87,7 +88,7 @@ In this example, the test waits up to 8 seconds for the company logo to appear i
 
 ## Automatic Waiting with `redraw`
 
-TestDriver.ai's **`redraw` function** is a built-in mechanism that automatically waits for the screen to stabilize before proceeding to the next step. This includes:
+TestDriver's **`redraw` function** is a built-in mechanism that automatically waits for the screen to stabilize before proceeding to the next step. This includes:
 
 1. **UI Changes**:
   - Waits for animations, transitions, or DOM updates to complete.
@@ -105,7 +106,7 @@ TestDriver.ai's **`redraw` function** is a built-in mechanism that automatically
 ## Best Practices for Waiting
 
 2. **Leverage Automatic Waiting**:
-  - Rely on TestDriver.ai's `redraw` function to handle most waiting scenarios automatically.
+  - Rely on TestDriver's `redraw` function to handle most waiting scenarios automatically.
 
 1. **Use Explicit Waiting for Dynamic Elements**:
   - Use `wait-for-text` or `wait-for-image` for elements that take time to load.

package/docs/importing/csv.mdx

@@ -1,9 +1,11 @@
 ---
 title: "CSV Import"
 sidebarTitle: "CSV Import"
+description: "Convert user stories from CSV files into individual TestDriver test files using Node.js and GitHub Actions."
+icon: "table"
 ---
 
-This guide demonstrates how to convert user stories from **CSV files** into individual TestDriver.ai test files using **Node.js**. Each user story will be saved as its own YAML test file, and the tests will be executed in parallel using a **GitHub Actions workflow**.
+This guide demonstrates how to convert user stories from **CSV files** into individual TestDriver test files using **Node.js**. Each user story will be saved as its own YAML test file, and the tests will be executed in parallel using a **GitHub Actions workflow**.
 
 ---
 
@@ -105,8 +107,9 @@ This script will generate individual YAML test files (e.g., `test_1.yml`, `test_
 
 Create a GitHub Actions workflow to execute the generated test files in parallel.
 
-### GitHub Actions Workflow (`.github/workflows/run-tests.yml`)```yaml
-name: Run TestDriver.ai Tests
+### GitHub Actions Workflow (`.github/workflows/run-tests.yml`)
+```yaml
+name: Run TestDriver Tests
 
 on:
   push:
@@ -144,10 +147,10 @@ jobs:
       - name: Check out repository
         uses: actions/checkout@v2
 
-      - name: Run TestDriver.ai
+      - name: Run TestDriver
         uses: testdriverai/action@main
         with:
-          key: ${{ secrets.TESTDRIVER_API_KEY }}
+          key: ${{ secrets.TD_API_KEY }}
           prompt: |
             1. /run ${{ matrix.test_file }}
         env:
@@ -160,7 +163,7 @@ jobs:
 
 ## Step 4: Secure API Key
 
-Store your TestDriver.ai API key as a GitHub secret (e.g., `TESTDRIVER_API_KEY`) to securely authenticate your tests.
+Store your TestDriver API key as a GitHub secret (e.g., `TD_API_KEY`) to securely authenticate your tests.
 
 ---
 

package/docs/importing/gherkin.mdx

@@ -1,9 +1,11 @@
 ---
 title: "Gherkin"
 sidebarTitle: "Gherkin"
+description: "Convert Gherkin scenarios to TestDriver prompts"
+icon: "file-code"
 ---
 
-This guide explains how to convert **Gherkin scenarios** into **TestDriver.ai prompts** for use in your testing workflows. By following this process, you can easily adapt existing Gherkin test cases into a format compatible with TestDriver.ai.
+This guide explains how to convert **Gherkin scenarios** into **TestDriver prompts** for use in your testing workflows. By following this process, you can easily adapt existing Gherkin test cases into a format compatible with TestDriver.
 
 ---
 
@@ -23,9 +25,9 @@ Scenario: Successful login
 
 ---
 
-## What Are TestDriver.ai Prompts?
+## What Are TestDriver Prompts?
 
-TestDriver.ai prompts are high-level instructions that describe what the AI should do. They are written in plain text and focus on user actions or expected outcomes.
+TestDriver prompts are high-level instructions that describe what the AI should do. They are written in plain text and focus on user actions or expected outcomes.
 
 ### Example Prompts:
 
@@ -39,11 +41,11 @@ TestDriver.ai prompts are high-level instructions that describe what the AI shou
 
 ---
 
-## Steps to Convert Gherkin to TestDriver.ai Prompts
+## Steps to Convert Gherkin to TestDriver Prompts
 
 ### Step 1: Understand the Mapping
 
-| **Gherkin Keyword** | **TestDriver.ai Prompt**                     |
+| **Gherkin Keyword** | **TestDriver Prompt**                     |
 |----------------------|----------------------------------------------|
 | `Given`             | Describes the initial state or setup.       |
 | `When`              | Describes the user action.                 |
@@ -58,7 +60,7 @@ Take each step from the Gherkin scenario and rewrite it as a plain-text prompt.
 
 #### Example:
 
-| **Gherkin Step**                     | **TestDriver.ai Prompt**             |
+| **Gherkin Step**                     | **TestDriver Prompt**             |
 |--------------------------------------|--------------------------------------|
 | `Given the user is on the login page` | `the user is on the login page`      |
 | `When the user enters valid credentials` | `the user enters valid credentials` |
@@ -85,13 +87,13 @@ Combine the extracted prompts into a YAML file. Each step should be written as a
 ### Step 4: Save the YAML File
 
 1. Save the YAML content to a file (e.g., `login_test.yml`).
-2. Ensure the file is stored in the appropriate directory for your TestDriver.ai project (e.g., `testdriver/`).
+2. Ensure the file is stored in the appropriate directory for your TestDriver project (e.g., `testdriver/`).
 
 ---
 
-### Step 5: Run the Test with TestDriver.ai
+### Step 5: Run the Test with TestDriver
 
-Use the TestDriver.ai CLI to execute the test.
+Use the TestDriver CLI to execute the test.
 
 #### Command:
 
@@ -139,4 +141,4 @@ testdriverai run add_to_cart_test.yml
 
 ---
 
-By following this guide, you can efficiently convert Gherkin scenarios into TestDriver.ai prompts, enabling seamless integration of existing test cases into your TestDriver.ai workflows.
+By following this guide, you can efficiently convert Gherkin scenarios into TestDriver prompts, enabling seamless integration of existing test cases into your TestDriver workflows.

package/docs/importing/jira.mdx

@@ -1,20 +1,22 @@
 ---
 title: "Jira"
 sidebarTitle: "Jira"
+description: "Import user stories from Jira into TestDriver test files."
+icon: "file-image"
 ---
 
-# Importing User Stories from Jira into TestDriver.ai Test Files
+# Importing User Stories from Jira into TestDriver Test Files
 
-This guide explains how to extract **user stories** from Jira and convert them into **TestDriver.ai test files**. By automating this process, you can ensure that your user stories are directly translated into actionable test cases for TestDriver.ai.
+This guide explains how to extract **user stories** from Jira and convert them into **TestDriver test files**. By automating this process, you can ensure that your user stories are directly translated into actionable test cases for TestDriver.
 
 ---
 
 ## Workflow Overview
 
 1. **Export User Stories from Jira**: Use the Jira API to fetch user stories.
-2. **Convert User Stories to TestDriver.ai YAML**: Transform the user stories into YAML test files.
+2. **Convert User Stories to TestDriver YAML**: Transform the user stories into YAML test files.
 3. **Save and Organize Test Files**: Store the generated YAML files in a structured directory.
-4. **Run Tests with TestDriver.ai**: Execute the tests using the TestDriver.ai CLI.
+4. **Run Tests with TestDriver**: Execute the tests using the TestDriver CLI.
 
 ---
 
@@ -115,7 +117,7 @@ fetchJiraTickets();
 
 ---
 
-## Step 2: Convert User Stories to TestDriver.ai YAML
+## Step 2: Convert User Stories to TestDriver YAML
 
 The script above generates a YAML file for each Jira ticket. Each file contains the **acceptance criteria** as `prompt` entries.
 
@@ -134,13 +136,13 @@ steps:
 ## Step 3: Save and Organize Test Files
 
 1. The generated YAML files will be saved in the `testdriver_tests/` directory.
-2. Ensure the directory is part of your TestDriver.ai project structure.
+2. Ensure the directory is part of your TestDriver project structure.
 
 ---
 
-## Step 4: Run Tests with TestDriver.ai
+## Step 4: Run Tests with TestDriver
 
-Use the TestDriver.ai CLI to execute the generated test files.
+Use the TestDriver CLI to execute the generated test files.
 
 ### Run a Single Test File:
 
@@ -169,4 +171,4 @@ testdriverai run testdriver_tests/*.yml
 
 ## Summary
 
-By following this guide, you can automate the process of importing user stories from Jira into TestDriver.ai test files. This ensures that your acceptance criteria are directly translated into actionable tests, streamlining your testing workflows and improving coverage.
+By following this guide, you can automate the process of importing user stories from Jira into TestDriver test files. This ensures that your acceptance criteria are directly translated into actionable tests, streamlining your testing workflows and improving coverage.

package/docs/importing/testrail.mdx

@@ -1,18 +1,20 @@
 ---
 title: "TestRail"
 sidebarTitle: "TestRail"
+description: "Import test cases from TestRail into TestDriver."
+icon: "square-pen"
 ---
 
-This guide explains how to extract **test cases** from TestRail and convert them into **TestDriver.ai YAML test files**. By automating this process, you can ensure that your TestRail test cases are directly translated into actionable tests for TestDriver.ai.
+This guide explains how to extract **test cases** from TestRail and convert them into **TestDriver YAML test files**. By automating this process, you can ensure that your TestRail test cases are directly translated into actionable tests for TestDriver.
 
 ---
 
 ## Workflow Overview
 
 1. **Export Test Cases from TestRail**: Use the TestRail API to fetch test cases.
-2. **Convert Test Cases to TestDriver.ai YAML**: Transform the test cases into YAML test files.
+2. **Convert Test Cases to TestDriver YAML**: Transform the test cases into YAML test files.
 3. **Save and Organize Test Files**: Store the generated YAML files in a structured directory.
-4. **Run Tests with TestDriver.ai**: Execute the tests using the TestDriver.ai CLI.
+4. **Run Tests with TestDriver**: Execute the tests using the TestDriver CLI.
 
 ---
 
@@ -111,7 +113,7 @@ fetchTestRailTestCases();
 
 ---
 
-## Step 2: Convert Test Cases to TestDriver.ai YAML
+## Step 2: Convert Test Cases to TestDriver YAML
 
 The script above generates a YAML file for each TestRail test case. Each file contains the **steps** as `prompt` entries.
 
@@ -131,13 +133,13 @@ steps:
 ## Step 3: Save and Organize Test Files
 
 1. The generated YAML files will be saved in the `testdriver_tests/` directory.
-2. Ensure the directory is part of your TestDriver.ai project structure.
+2. Ensure the directory is part of your TestDriver project structure.
 
 ---
 
-## Step 4: Run Tests with TestDriver.ai
+## Step 4: Run Tests with TestDriver
 
-Use the TestDriver.ai CLI to execute the generated test files.
+Use the TestDriver CLI to execute the generated test files.
 
 ### Run a Single Test File:
 
@@ -158,4 +160,4 @@ testdriverai run testdriver_tests/test_123.yml
 
 ## Summary
 
-By following this guide, you can automate the process of importing test cases from TestRail into TestDriver.ai test files. This ensures that your test steps are directly translated into actionable tests, streamlining your testing workflows and improving coverage.
+By following this guide, you can automate the process of importing test cases from TestRail into TestDriver test files. This ensures that your test steps are directly translated into actionable tests, streamlining your testing workflows and improving coverage.

package/docs/integrations/electron.mdx

@@ -1,17 +1,21 @@
 ---
 title: "Electron"
+sidebarTitle: "Electron"
+description: "Integrate TestDriver with Electron applications"
+icon: "atom"
 ---
 
-To integrate **TestDriver.ai** with a workflow that uses the **runner artifact URL** and **GitHub token** for downloading artifacts, you can modify the workflow to include these steps. Below is an example of how to adapt the workflow to ensure TestDriver.ai can access the artifacts.
+To integrate **TestDriver** with a workflow that uses the **runner artifact URL** and **GitHub token** for downloading artifacts, you can modify the workflow to include these steps. Below is an example of how to adapt the workflow to ensure TestDriver can access the artifacts.
 
 ---
 
-## Updated Workflow with TestDriver.ai Integration
+## Updated Workflow with TestDriver Integration
 
-This workflow builds the application, uploads the build as an artifact, and then uses TestDriver.ai to download the artifact via the runner artifact URL and run tests.
+This workflow builds the application, uploads the build as an artifact, and then uses TestDriver to download the artifact via the runner artifact URL and run tests.
 
-### Workflow File: `.github/workflows/testdriver-integration.yml````yaml
-name: Build and Test with TestDriver.ai
+### Workflow File: `.github/workflows/testdriver-integration.yml
+```yaml
+name: Build and Test with TestDriver
 
 on:
   push:
@@ -46,7 +50,7 @@ jobs:
           path: dist/ # Replace with the path to your built application
 
   test:
-    name: Test Application with TestDriver.ai
+    name: Test Application with TestDriver
     runs-on: ubuntu-latest
     needs: build
     steps:
@@ -55,10 +59,10 @@ jobs:
         run: |
           echo "ARTIFACT_URL=${{ github.server_url }}/repos/${{ github.repository }}/actions/artifacts" >> $GITHUB_ENV
 
-      - name: Run Tests with TestDriver.ai
+      - name: Run Tests with TestDriver
         uses: testdriverai/action@main
         with:
-          key: ${{ secrets.TESTDRIVER_API_KEY }}
+          key: ${{ secrets.TD_API_KEY }}
           prompt: |
             1. Download the artifact from the runner URL
             2. Extract the artifact
@@ -85,7 +89,8 @@ jobs:
 ## Key Changes and Explanation
 
 ### 1. **Artifact URL Retrieval**
-The `Get Artifact URL` step constructs the artifact URL dynamically using the GitHub repository and server URL. This ensures the TestDriver.ai runner can download the artifact.```yaml
+The `Get Artifact URL` step constructs the artifact URL dynamically using the GitHub repository and server URL. This ensures the TestDriver runner can download the artifact.
+```yaml
 - name: Get Artifact URL
   id: artifact-url
   run: |
@@ -96,7 +101,8 @@ The `Get Artifact URL` step constructs the artifact URL dynamically using the Gi
 ---
 
 ### 2. **Downloading the Artifact**
-The `prerun` script in the TestDriver.ai action uses `curl` to download the artifact from the runner URL. The `GITHUB_TOKEN` is passed as a header for authentication.```yaml
+The `prerun` script in the TestDriver action uses `curl` to download the artifact from the runner URL. The `GITHUB_TOKEN` is passed as a header for authentication.
+```yaml
 prerun: |
   echo "Downloading artifact..."
   curl -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
@@ -111,16 +117,17 @@ prerun: |
 
 ---
 
-### 3. **TestDriver.ai Integration**
-The TestDriver.ai action is configured to:
+### 3. **TestDriver Integration**
+The TestDriver action is configured to:
 - Download the artifact.
 - Extract the artifact.
 - Run the application.
-- Execute the specified test steps.```yaml
-- name: Run Tests with TestDriver.ai
+- Execute the specified test steps.
+```yaml
+- name: Run Tests with TestDriver
   uses: testdriverai/action@main
   with:
-    key: ${{ secrets.TESTDRIVER_API_KEY }}
+    key: ${{ secrets.TD_API_KEY }}
     prompt: |
       1. Download the artifact from the runner URL
       2. Extract the artifact
@@ -135,18 +142,18 @@ The TestDriver.ai action is configured to:
 ## Secrets Configuration
 
 Add the following secrets to your GitHub repository:
-1. **`TESTDRIVER_API_KEY`**: Your TestDriver.ai API key.
+1. **`TD_API_KEY`**: Your TestDriver API key.
 2. **`GITHUB_TOKEN`**: Automatically provided by GitHub Actions for authentication.
 
 ---
 
 ## Benefits of This Workflow
 
-1. **Dynamic Artifact Access**: Ensures TestDriver.ai can download artifacts directly from the runner.
-2. **Automated Testing**: Integrates TestDriver.ai to validate the application after the build.
+1. **Dynamic Artifact Access**: Ensures TestDriver can download artifacts directly from the runner.
+2. **Automated Testing**: Integrates TestDriver to validate the application after the build.
 3. **Secure Authentication**: Uses the GitHub token for secure artifact access.
 4. **Cross-Platform Support**: Can be adapted for different operating systems and environments.
 
 ---
 
-By integrating TestDriver.ai with the runner artifact URL and GitHub token, this workflow ensures seamless testing of your application builds.
+By integrating TestDriver with the runner artifact URL and GitHub token, this workflow ensures seamless testing of your application builds.

package/docs/integrations/netlify.mdx

@@ -1,17 +1,18 @@
 ---
 title: "Netlify"
+sidebarTitle: "Netlify"
+description: "Integrate TestDriver with Netlify deployments using GitHub Actions."
+icon: "cloud"
 ---
 
-# Testing Netlify Deployments with TestDriver.ai GitHub Action
-
-This guide explains how to integrate **TestDriver.ai** with **Netlify deployments** using the **GitHub Actions workflow**. By combining these tools, you can automatically test your Netlify preview deployments or production builds to ensure they meet your quality standards before merging or releasing.
+This guide explains how to integrate **TestDriver** with **Netlify deployments** using the **GitHub Actions workflow**. By combining these tools, you can automatically test your Netlify preview deployments or production builds to ensure they meet your quality standards before merging or releasing.
 
 ---
 
 ## Workflow Overview
 
 1. **Trigger Netlify Deployment**: Use Netlify's GitHub integration to deploy your application on every pull request or push to the main branch.
-2. **Run Tests on the Deployment URL**: Use the TestDriver.ai GitHub Action to test the deployed application using the Netlify deployment URL.
+2. **Run Tests on the Deployment URL**: Use the TestDriver GitHub Action to test the deployed application using the Netlify deployment URL.
 3. **Report Results**: View test results in the GitHub Actions dashboard or as comments on the pull request.
 
 ---
@@ -19,32 +20,31 @@ This guide explains how to integrate **TestDriver.ai** with **Netlify deployment
 ## Prerequisites
 
 1. **Netlify GitHub Integration**: Ensure your repository is connected to Netlify for automatic deployments.
-2. **TestDriver.ai API Key**: Store your API key as a GitHub secret (e.g., `TESTDRIVER_API_KEY`).
+2. **TestDriver API Key**: Store your API key as a GitHub secret (e.g., `TD_API_KEY`).
 3. **Netlify Deployment URL**: Use the `DEPLOY_URL` environment variable provided by Netlify to access the deployment.
 
 ---
 
 ## GitHub Actions Workflow
 
-Here’s a complete workflow to test Netlify deployments with TestDriver.ai:
+Here's a complete workflow to test Netlify deployments with TestDriver:
 
-### Workflow File: `.github/workflows/test-netlify.yml````yaml
-name: Test Netlify Deployment with TestDriver.ai
+### Workflow File: `.github/workflows/test-netlify.yml
+```yaml
+name: Test Netlify Deployment with TestDriver
 
 on:
-  pull_request:
-  push:
-    branches:
-      - main
-  workflow_dispatch:
+pull_request:
+push:
+branches: - main
+workflow_dispatch:
 
 jobs:
-  test-netlify:
-    name: Test Netlify Deployment
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out repository
-        uses: actions/checkout@v2
+test-netlify:
+name: Test Netlify Deployment
+runs-on: ubuntu-latest
+steps: - name: Check out repository
+uses: actions/checkout@v2
 
       - name: Wait for Netlify Deployment
         id: netlify
@@ -56,10 +56,10 @@ jobs:
             exit 1
           fi
 
-      - name: Run Tests with TestDriver.ai
+      - name: Run Tests with TestDriver
         uses: testdriverai/action@main
         with:
-          key: ${{ secrets.TESTDRIVER_API_KEY }}
+          key: ${{ secrets.TD_API_KEY }}
           prompt: |
             1. Open the deployment URL: $DEPLOY_URL
             2. Verify the homepage loads correctly
@@ -78,7 +78,8 @@ jobs:
 ## Workflow Steps Explained
 
 ### 1. **Wait for Netlify Deployment**
-Netlify automatically sets the `DEPLOY_URL` environment variable for each deployment. This step ensures the deployment URL is available before running tests.```yaml
+Netlify automatically sets the `DEPLOY_URL` environment variable for each deployment. This step ensures the deployment URL is available before running tests.
+```yaml
 - name: Wait for Netlify Deployment
   id: netlify
   run: |
@@ -93,6 +94,6 @@ Netlify automatically sets the `DEPLOY_URL` environment variable for each deploy
 
 ---
 
-### 2. **Run Tests with TestDriver.ai**
-The TestDriver.ai GitHub Action runs tests on the deployed application using the deployment URL. The `prompt` field specifies the test steps to execute.
+### 2. **Run Tests with TestDriver**
 
+The TestDriver GitHub Action runs tests on the deployed application using the deployment URL. The `prompt` field specifies the test steps to execute.