testdriverai 6.0.22 → 6.0.23

package/docs/account/enterprise.mdx

@@ -1,6 +1,6 @@
 ---
 title: "Enterprise"
-sidebarTitle: "Enterprise"
+sidebarTitle: "For Enterprise"
 description: "The TestDriver 4x4 Guarantee!"
 icon: gem
 ---

package/docs/action/setup.mdx

@@ -1,7 +1,7 @@
 ---
-title: "CI/CD Setup Guide"
-sidebarTitle: "Setup Guide"
-description: "Learn how to set up and configure TestDriver CLI for automated cloud-based testing in your CI/CD workflows."
+title: "CI Setup Guide"
+sidebarTitle: "CI Setup"
+description: "Learn how to set up and configure TestDriver CLI for automated cloud-based testing in your CI workflows."
 icon: "square-terminal"
 ---
 

package/docs/cli/overview.mdx

@@ -1,8 +1,8 @@
 ---
-title: "Overview of the TestDriver CLI"
-sidebarTitle: "CLI Overview"
+title: "TestDriver CLI Flags"
+sidebarTitle: "Flags"
 description: "Learn about the TestDriver CLI, its commands, and how to use it effectively."
-icon: "terminal"
+icon: "flag"
 ---
 
 The `testdriverai` CLI is the primary interface for running, managing, and debugging TestDriver scripts. It provides commands to execute tests, validate configurations, and interact with the TestDriver framework.

package/docs/docs.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://mintlify.com/docs.json",
-  "theme": "mint",
+  "theme": "willow",
   "name": "TestDriver",
   "colors": {
     "primary": "#b3d334",
@@ -12,92 +12,67 @@
   },
   "favicon": "/images/template/icon.png",
   "navigation": {
-    "tabs": [
+    "groups": [
       {
-        "tab": "Overview",
-        "groups": [
+        "group": "Overview",
+        "pages": [
+          "/overview/what-is-testdriver",
           {
-            "group": "Intro",
+            "group": "Concepts",
+            "icon": "book",
             "pages": [
-              "/overview/quickstart",
-              "/overview/what-is-testdriver",
-              "/overview/faq",
+              "/features/selectorless",
               "/overview/comparison",
               "/overview/performance",
-              "/account/enterprise"
-            ]
-          },
-          {
-            "group": "Features",
-            "pages": [
-              "/features/selectorless",
-              "/features/generation",
-              "/features/visual-assertions",
-              "/features/auto-healing",
-              "/features/reusable-snippets",
-              "/features/parallel-testing"
-            ]
-          },
-          {
-            "group": "Security & Privacy",
-            "pages": [
-              "/security/agent",
-              "/security/action",
-              "/security/platform"
+              "/overview/faq"
             ]
           },
+          "/account/enterprise"
+        ]
+      },
+      {
+        "group": "Get Started",
+        "pages": [
+          "/overview/quickstart",
           {
-            "group": "Account",
+            "group": "CLI",
+            "icon": "terminal",
             "pages": [
-              "/account/dashboard",
-              "/account/projects",
-              "/account/team"
+              "/getting-started/cli",
+              "/cli/overview",
+              {
+                "group": "Commands",
+                "icon": "command",
+                "pages": [
+                  "/interactive/assert",
+                  "/interactive/dry",
+                  "/interactive/explore",
+                  "/interactive/generate",
+                  "/interactive/run",
+                  "/interactive/save",
+                  "/interactive/undo"
+                ]
+              }
             ]
           }
         ]
       },
       {
-        "tab": "Guide",
-        "groups": [
+        "group": "Examples",
+        "pages": [
           {
-            "group": "Getting Started",
-            "pages": [
-              "/getting-started/vscode",
-              "/getting-started/running",
-              "/getting-started/ci",
-              "/getting-started/editing"
-            ]
-          },
-          {
-            "group": "Writing Tests",
+            "group": "Apps",
+            "icon": "laptop",
             "pages": [
-              "/guide/locating",
-              "/guide/waiting",
-              "/guide/assertions",
-              "/guide/variables",
-              "/guide/authentication",
-              "/guide/lifecycle",
-              "/guide/code",
-              "/guide/environment-variables",
-              "/guide/protips"
+              "apps/static-websites",
+              "apps/desktop-apps",
+              "apps/chrome-extensions",
+              "apps/mobile-apps"
             ]
           },
-          {
-            "group": "Running in CI",
-            "pages": [
-              "/action/setup",
-              "/action/performance",
-              "/action/secrets",
-              "/action/ami"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "Examples",
-        "groups": [
           {
             "group": "Scenarios",
+            "icon": "computer-mouse",
             "pages": [
               "scenarios/ai-chatbot",
               "scenarios/cookie-banner",
@@ -109,29 +84,45 @@
             ]
           },
           {
-            "group": "Apps",
+            "group": "Build Systems",
+            "icon": "helmet-safety",
             "pages": [
-              "apps/chrome-extensions",
-              "apps/desktop-apps",
-              "apps/mobile-apps",
-              "apps/static-websites"
+              "/integrations/electron",
+              "/integrations/netlify",
+              "/integrations/vercel"
             ]
           }
         ]
       },
       {
-        "tab": "Integrations",
-        "groups": [
+        "group": "Guide",
+        "pages": [
           {
-            "group": "Building",
+            "group": "Configuration",
+            "icon": "desktop",
             "pages": [
-              "/integrations/electron",
-              "/integrations/netlify",
-              "/integrations/vercel"
+              "/guide/variables",
+              "/guide/lifecycle",
+              "/guide/environment-variables",
+              "/action/ami"
+            ]
+          },
+          {
+            "group": "Writing",
+            "icon": "pencil",
+            "pages": [
+              "/features/generation",
+              "/guide/locating",
+              "/guide/waiting",
+              "/guide/assertions",
+              "/guide/code",
+              "/features/reusable-snippets",
+              "/guide/protips"
             ]
           },
           {
             "group": "Importing",
+            "icon": "file-import",
             "pages": [
               "/importing/csv",
               "/importing/gherkin",
@@ -140,58 +131,49 @@
             ]
           },
           {
-            "group": "Exporting",
-            "pages": ["/exporting/playwright", "exporting/junit"]
-          },
-          {
-            "group": "Test Reporting",
-            "pages": ["exporting/junit", "/bugs/jira"]
-          }
-        ]
-      },
-      {
-        "tab": "Reference",
-        "groups": [
-          {
-            "group": "Commands",
+            "group": "Running",
+            "icon": "play",
             "pages": [
-              "/commands/assert",
-              "/commands/exec",
-              "/commands/focus-application",
-              "/commands/hover-image",
-              "/commands/hover-text",
-              "/commands/if",
-              "/commands/match-image",
-              "/commands/press-keys",
-              "/commands/remember",
-              "/commands/run",
-              "/commands/scroll",
-              "/commands/scroll-until-image",
-              "/commands/scroll-until-text",
-              "/commands/type",
-              "/commands/wait",
-              "/commands/wait-for-image",
-              "/commands/wait-for-text",
-              "/commands/issues"
+              "/getting-started/running",
+              "/action/setup",
+              "/features/parallel-testing",
+              "/action/performance",
+              "/action/secrets"
             ]
           },
           {
-            "group": "Interactive Commands",
-            "pages": [
-              "/interactive/assert",
-              "/interactive/dry",
-              "/interactive/explore",
-              "/interactive/generate",
-              "/interactive/run",
-              "/interactive/save",
-              "/interactive/undo"
-            ]
+            "group": "Maintaining",
+            "icon": "wrench",
+            "pages": ["/getting-started/editing", "/features/auto-healing"]
           },
           {
-            "group": "CLI",
-            "pages": ["/cli/overview"]
+            "group": "Reporting",
+            "icon": "chart-simple",
+            "pages": ["exporting/junit", "/bugs/jira"]
           }
         ]
+      },
+      {
+        "group": "Reference",
+        "pages": [
+          "/commands/assert",
+          "/commands/exec",
+          "/commands/focus-application",
+          "/commands/hover-image",
+          "/commands/hover-text",
+          "/commands/if",
+          "/commands/match-image",
+          "/commands/press-keys",
+          "/commands/remember",
+          "/commands/run",
+          "/commands/scroll",
+          "/commands/scroll-until-image",
+          "/commands/scroll-until-text",
+          "/commands/type",
+          "/commands/wait",
+          "/commands/wait-for-image",
+          "/commands/wait-for-text"
+        ]
       }
     ],
     "global": {
@@ -215,17 +197,9 @@
   },
   "navbar": {
     "links": [
-      {
-        "label": "GitHub",
-        "href": "https://github.com/testdriverai/testdriverai"
-      },
       {
         "label": "Discord",
         "href": "https://discord.com/invite/cWDFW8DzPm"
-      },
-      {
-        "label": "Report an Issue",
-        "href": "https://forums.testdriver.ai/new-topic?category=help"
       }
     ],
     "primary": {

package/docs/features/auto-healing.mdx

@@ -1,15 +1,15 @@
 ---
-title: "Auto-Healing in TestDriver"
-sidebarTitle: "Auto-Healing"
-description: "Learn how TestDriver's auto-healing feature keeps your tests resilient and up-to-date with minimal manual effort."
+title: "Self-Healing in TestDriver"
+sidebarTitle: "Self-Healing"
+description: "Learn how TestDriver's self-healing feature keeps your tests resilient and up-to-date with minimal manual effort."
 icon: "bandage"
 ---
 
-Auto-healing is a powerful feature in TestDriver that ensures your tests remain resilient even when the application under test changes.
+Self-healing is a powerful feature in TestDriver that ensures your tests remain resilient even when the application under test changes.
 
-Use `--heal` to enable auto-healing in your test runs. This feature allows TestDriver to automatically update tests when minor changes occur, such as text updates or small UI adjustments, without requiring manual intervention.
+Use `--heal` to enable self-healing in your test runs. This feature allows TestDriver to automatically recover when minor changes occur, such as text updates or small UI adjustments, without requiring manual intervention.
 
-## Why use auto-healing?
+## Why use self-healing?
 
 In modern software development, applications frequently undergo changes, whether it's UI updates, text modifications, or layout adjustments. These changes can lead to test failures, requiring developers to manually update test scripts to reflect the new state of the application.
 
@@ -17,28 +17,28 @@ This means that if a test fails due to a change in the application, TestDriver w
 
 This feature is particularly useful in continuous integration (CI) environments, where tests need to adapt to frequent changes in the application.
 
-## How to enable auto-healing
+## How to enable self-healing
 
-To enable auto-healing in TestDriver, simply add the `--heal` and `--write` flags when running your tests. The `--heal` flag instructs TestDriver to attempt to automatically update any failing tests due to minor changes in the application, while `--write` ensures the updated test files are saved.
+To enable self-healing in TestDriver, simply add the `--heal` and `--write` flags when running your tests. The `--heal` flag instructs TestDriver to recover when test fail due to minor changes in the application, while `--write` saves newly generated steps to the test file.
 
 ```bash
 npx testdriverai@latest run my-tests.yaml --heal --write
 ```
 
-## How auto-healing works
+## How self-healing works
 
 When TestDriver steps fail, the AI will progressively fall back to attempt to complete the test.
 
-When running with `--heal` and `--write`, TestDriver will update the test files locally with any changes made during auto-healing. You can then use GitHub Actions to commit these changes and create a pull request for review.
+When running with `--heal` and `--write`, TestDriver will update the test files locally with any changes made during self-healing. You can then use GitHub Actions to commit these changes and create a pull request for review.
 
-## Benefits of auto-healing
+## Benefits of self-healing
 
 - **Reduced Maintenance**: Eliminates the need for manual updates to tests when minor UI changes occur.
 - **Increased Test Resilience**: Ensures tests adapt to changes without breaking.
 - **Continuous Integration**: Keeps your test suite aligned with the latest application changes.
 - **Developer Collaboration**: Automatically opens a PR, allowing developers to review and approve updates.
 
-## How auto-healing works
+## How self-healing works
 
 1. **Test Execution**: TestDriver runs your test suite as usual.
 2. **Failure Detection**: If a test fails due to a change in the application (for example, text or UI updates), the AI identifies the failure point.
@@ -67,7 +67,7 @@ When running with `--heal` and `--write`, TestDriver will update the test files
   - TestDriver runs the test and fails to find the "Submit" button.
 </Step>
 
-<Step title="Auto-Healing">
+<Step title="Self-Healing">
   - The AI detects the failure and searches for a similar element.
   - It identifies the "Send" button as the updated element and retries the action.
 </Step>
@@ -88,12 +88,12 @@ When running with `--heal` and `--write`, TestDriver will update the test files
 
 </Step>
 </Steps>
-## Example GitHub Action for Auto-Healing
+## Example GitHub Action for self-healing
 
-Here's how you can configure a GitHub Action to enable auto-healing and automatically create PRs for any test updates:
+Here's how you can configure a GitHub Action to enable self-healing and automatically create PRs for any test updates:
 
 ```yaml
-name: TestDriver Auto-Healing
+name: TestDriver Self-Healing
 
 on:
   push:
@@ -104,12 +104,12 @@ on:
 
 jobs:
   test:
-    name: "Run Tests with Auto-Healing"
+    name: "Run Tests with Self-Healing"
     steps:
       - name: Check out repository
         uses: actions/checkout@v4
 
-      - name: Run TestDriver with Auto-Healing
+      - name: Run TestDriver with Self-Healing
         run: npx testdriverai@latest run testdriver/onboarding.yaml --heal --write --headless
         env:
           TD_API_KEY: ${{ secrets.TD_API_KEY }}
@@ -126,7 +126,7 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           commit-message: "Auto-healed test updates"
-          title: "Auto-Healed Test Updates"
+          title: "Self-Healed Test Updates"
           branch: auto-heal-updates
           base: main
           body: |
@@ -137,8 +137,8 @@ jobs:
 
 ---
 
-## Limitations of Auto-Healing
+## Limitations of Self-Healing
 
-- **Major UI Overhauls**: Auto-healing is best suited for minor changes (for example, text updates, small layout adjustments). Significant UI changes may still require manual intervention.
+- **Major UI Overhauls**: Self-healing is best suited for minor changes (for example, text updates, small layout adjustments). Significant UI changes may still require manual intervention.
 - **Ambiguous Changes**: If multiple elements match the updated criteria, the AI may require additional context to make the correct decision.
 - **Step Deletion**: If UI or wizard pages are removed, the AI may not be able to recover. In such cases, manual updates are necessary.

package/docs/features/selectorless.mdx

@@ -1,5 +1,5 @@
 ---
-title: "Selectorless Testing with TestDriver"
+title: "Selectorless Testing"
 sidebarTitle: "Selectorless Testing"
 description: "Selectorless testing approach simplifies end-to-end testing by using natural language and AI vision."
 icon: "eye"

package/docs/getting-started/cli.mdx

@@ -0,0 +1,97 @@
+---
+title: "Setup"
+sidebarTitle: "Setup"
+description: "Get started with TestDriver in minutes."
+icon: "download"
+mode: "wide"
+---
+
+import Comments from "/snippets/comments.mdx";
+
+<Steps>
+  <Step title="Set up your environment">
+      
+    Copy your API key from [the TestDriver dashboard](https://app.testdriver.ai/team), and set it as an environment variable.
+    
+    <Tabs>
+      <Tab title="macOS / Linux">
+        ```bash Export an environment variable on macOS or Linux systems
+        export TD_API_KEY="your_api_key_here"
+        ```
+      </Tab>
+      <Tab title="Windows">
+      ```powershell Export an environment variable in PowerShell
+      setx TD_API_KEY "your_api_key_here"
+      ```
+      </Tab>
+    </Tabs>
+
+  </Step>
+  <Step title="Try an example test">
+      
+    Download the TestDriver GitHub repository and run the web example test.
+
+    ```bash
+    git clone https://github.com/testdriverai/cli testdriverai
+    cd testdriverai/testdriver/examples/web
+    ```
+
+    TestDriver tests are written in YAML, a human-readable data format. The `example.yaml` file contains a series of steps that the agent will execute.
+
+    ```yaml testdriver/test.yaml
+    steps:
+      - prompt: log in
+      - prompt: add an item to the cart
+      - prompt: click on the cart icon
+      - prompt: complete checkout
+    ```
+
+    Each step has a `prompt` that describes what the agent should do. The agent will use the prompt to generate [commands](/commands) that make the tests faster and more reliable the next time you run the test.
+
+  </Step>
+  <Step title="Generate test steps from prompts">
+    
+    Run the following command to run the test file. TestDriver will spawn a virtual machine, launch the sandbox test page, and execute the steps defined in the `example.yaml` file.
+
+    ```bash
+    npx testdriverai@beta run example.yaml --write --heal
+    ```
+
+    The `--write` flag tells TestDriver to save any generated commands to the test file, and the `--heal` flag allows TestDriver to recover from unexpected issues during the test run.
+
+  </Step>
+  <Step title="Run a regression test">
+
+    ```yaml
+      version: 5.7.7
+      session: 682f6071811bd5a322c0e6dd
+      steps:
+        - prompt: focus chrome
+          commands:
+            - command: focus-application
+              name: Google Chrome
+        - prompt: enter a username
+          commands:
+            - command: hover-text
+              text: Username
+              description: username input field
+              action: click
+            - command: type
+              text: standard_user
+        - prompt: enter a password
+          commands:
+            - command: hover-text
+              text: Password
+              description: password input field
+              action: click
+            - command: type
+              text: secret_password
+      ```
+
+      The `--write` command tells the agent to save the generated commands to the test file, and the `--heal` command gives the agent permission to recover if something goes wrong.
+
+  </Step>
+</Steps>
+
+<Comments />
+```

package/docs/guide/lifecycle.mdx

@@ -2,7 +2,7 @@
 title: "Lifecycle Files"
 sidebarTitle: "Lifecycle Files"
 description: "Learn how to customize TestDriver execution with lifecycle files for setup, provisioning, and cleanup."
-icon: "arrows-rotate"
+icon: "wrench"
 ---
 
 Lifecycle files are YAML files placed in your repository's `lifecycle/` directory. TestDriver automatically executes these files during the appropriate phases:

package/docs/guide/protips.mdx

@@ -7,26 +7,26 @@ icon: "star"
 
 TestDriver is a vision-based testing tool and is not aware of the underlying HTML structure of the page. Pay attention to the following tips to improve your testing experience and reduce test flake.
 
-### Use unique descriptions for `hover-image` and `hover-text`
+### Use unique descriptions for [`hover-image`](/commands/hover-image) and [`hover-text`](/commands/hover-text)
 
-When executing the `hover-image` and `hover-text` command, TestDriver may use the description to identify the image, especially if multiple images are visible. If multiple images on the screen match the description, TestDriver may not be able to determine which one to interact with. To improve accuracy, use specific and unique descriptions for images.
+When executing the [`hover-image`](/commands/hover-image) and [`hover-text`](/commands/hover-text) command, TestDriver may use the description to identify the image, especially if multiple images are visible. If multiple images on the screen match the description, TestDriver may not be able to determine which one to interact with. To improve accuracy, use specific and unique descriptions for images.
 
-TestDriver may not accurately locate matches in certain cases. This can lead to unexpected behavior when using the `hover-image` or `hover-text` command. For example, if you specify a description that's too generic or similar to other images on the screen, TestDriver may not be able to identify the correct image to interact with. To improve accuracy, use specific and unique descriptions for images and text.
-When executing the `hover-image` and `hover-text` commands, TestDriver uses the provided description to identify the target image or text. If the description is too generic or matches multiple elements on the screen, TestDriver may not be able to determine which one to interact with, leading to unexpected behavior. To improve accuracy, always use specific and unique descriptions for both images and text.
+TestDriver may not accurately locate matches in certain cases. This can lead to unexpected behavior when using the [`hover-image`](/commands/hover-image) or [`hover-text`](/commands/hover-text) command. For example, if you specify a description that's too generic or similar to other images on the screen, TestDriver may not be able to identify the correct image to interact with. To improve accuracy, use specific and unique descriptions for images and text.
+When executing the [`hover-image`](/commands/hover-image) and [`hover-text`](/commands/hover-text) commands, TestDriver uses the provided description to identify the target image or text. If the description is too generic or matches multiple elements on the screen, TestDriver may not be able to determine which one to interact with, leading to unexpected behavior. To improve accuracy, always use specific and unique descriptions for both images and text.
 
-### Avoid using `hover-text` for single characters (ex: `1`, `>`, `|`)
+### Avoid using [`hover-text`](/commands/hover-text) for single characters (ex: `1`, `>`, `|`)
 
-To improve accuracy of our model, we do not include single characters or symbols in the matching data. This means that `hover-text` may not work as expected for these cases. If you need to interact with single characters or symbols, consider using the `match-image` command with a screenshot of the target element instead.
+To improve accuracy of our model, we do not include single characters or symbols in the matching data. This means that [`hover-text`](/commands/hover-text) may not work as expected for these cases. If you need to interact with single characters or symbols, consider using the [`match-image`](/commands/match-image) command with a screenshot of the target element instead.
 
 ### Use `<label>`s to match empty text inputs.
 
-To focus empty text inputs, prefer to `hover-text` on the label associated with the input. This [should](https://www.w3.org/WAI/tutorials/forms/labels/) focus the input field.
+To focus empty text inputs, prefer to [`hover-text`](/commands/hover-text) on the label associated with the input. This [should](https://www.w3.org/WAI/tutorials/forms/labels/) focus the input field.
 
-This is more reliable than trying to match the empty input itself, which may not have any visible text. You can always use `match-image` to match the input field if needed.
+This is more reliable than trying to match the empty input itself, which may not have any visible text. You can always use [`match-image`](/commands/match-image) to match the input field if needed.
 
-### Provide strict criteria for `assert`
+### Provide strict criteria for [`assert`](/commands/assert)
 
-Assertions use the current state of the page to determine if the step passes or fails. `assert` is not aware of the past, so avoid writing "assert" steps that rely on previous state. Instead, use `assert` to check the current state of the page against strict criteria.
+Assertions use the current state of the page to determine if the step passes or fails. [`assert`](/commands/assert) is not aware of the past, so avoid writing "assert" steps that rely on previous state. Instead, use [`assert`](/commands/assert) to check the current state of the page against strict criteria.
 
 ## Reporting issues