testdriverai 5.5.4 → 5.5.6

package/docs/docs.json

@@ -1,152 +1,266 @@
 {
-  "$schema": "https://mintlify.com/docs.json",
-  "theme": "mint",
-  "name": "TestDriver",
-  "colors": {
-    "primary": "#b3d334",
-    "light": "#b3d334",
-    "dark": "#050d23"
-  },
-  "favicon": "/images/template/icon.png",
-  "navigation": {
-    "tabs": [
-      {
-        "tab": "Overview",
-        "groups": [
-          {
-            "group": "Intro",
-            "pages": [
-              "/overview/quickstart",
-              "/overview/what-is-testdriver",
-              "/overview/faq",
-              "/overview/comparison"
+    "$schema": "https://mintlify.com/docs.json",
+    "theme": "mint",
+    "name": "TestDriver",
+    "colors": {
+        "primary": "#b3d334",
+        "light": "#b3d334",
+        "dark": "#152a65"
+    },
+    "appearance": {
+        "default": "dark"
+    },
+    "favicon": "/images/template/icon.png",
+    "navigation": {
+        "tabs": [
+            {
+                "tab": "Overview",
+                "groups": [
+                    {
+                        "group": "Intro",
+                        "pages": [
+                            "/overview/quickstart",
+                            "/overview/what-is-testdriver",
+                            "/overview/faq",
+                            "/overview/comparison",
+                            "/account/enterprise"
+                        ]
+                    },
+                    {
+                        "group": "Features",
+                        "pages": [
+                            "/features/selectorless",
+                            "/features/generation",
+                            "/features/visual-assertions",
+                            "/features/auto-healing",
+                            "/features/cross-platform",
+                            "/features/reusable-snippets",
+                            "/features/parallel-testing",
+                            "/features/github"
+                        ]
+                    },
+                    {
+                        "group": "Security & Privacy",
+                        "pages": [
+                            "/security/agent",
+                            "/security/action",
+                            "/security/platform"
+                        ]
+                    },
+                    {
+                        "group": "Account",
+                        "pages": [
+                            "/account/dashboard",
+                            "/account/projects",
+                            "/account/team"
+                        ]
+                    }
+                ]
+            },
+            {
+                "tab": "Guide",
+                "groups": [
+                    {
+                        "group": "Getting Started",
+                        "pages": [
+                            "/getting-started/setup",
+                            "/getting-started/writing",
+                            "/getting-started/generating",
+                            "/getting-started/running",
+                            "/getting-started/ci",
+                            "/getting-started/editing",
+                            "/overview/upgrading"
+                        ]
+                    },
+                    {
+                        "group": "Writing Tests",
+                        "pages": [
+                            "/guide/locating",
+                            "/guide/waiting",
+                            "/guide/assertions",
+                            "/guide/variables",
+                            "/guide/authentication",
+                            "/guide/lifecycle",
+                            "/guide/code",
+                            "/guide/environment-variables"
+                        ]
+                    },
+                    {
+                        "group": "Running in CI",
+                        "pages": [
+                            "/action/setup",
+                            "/action/browser",
+                            "/action/os",
+                            "/action/output",
+                            "/action/performance",
+                            "/action/prerun",
+                            "/action/secrets"
+                        ]
+                    }
+                ]
+            },
+            {
+                "tab": "Examples",
+                "groups": [
+                    {
+                        "group": "Scenarios",
+                        "pages": [
+                            "scenarios/ai-chatbot",
+                            "scenarios/cookie-banner",
+                            "scenarios/file-upload",
+                            "scenarios/form-filling",
+                            "scenarios/log-in",
+                            "scenarios/pdf-generation",
+                            "scenarios/spell-check"
+                        ]
+                    },
+                    {
+                        "group": "Apps",
+                        "pages": [
+                            "apps/chrome-extensions",
+                            "apps/desktop-apps",
+                            "apps/mobile-apps",
+                            "apps/static-websites"
+                        ]
+                    }
+                ]
+            },
+            {
+                "tab": "Integrations",
+                "groups": [
+                    {
+                        "group": "Building",
+                        "pages": [
+                            "/integrations/electron",
+                            "/integrations/netlify",
+                            "/integrations/vercel"
+                        ]
+                    },
+                    {
+                        "group": "Importing",
+                        "pages": [
+                            "/importing/csv",
+                            "/importing/gherkin",
+                            "/importing/jira",
+                            "/importing/testrail"
+                        ]
+                    },
+                    {
+                        "group": "Exporting",
+                        "pages": [
+                            "/exporting/playwright"
+                        ]
+                    },
+                    {
+                        "group": "Bug Reporting",
+                        "pages": [
+                            "/bugs/jira"
+                        ]
+                    }
+                ]
+            },
+            {
+                "tab": "Reference",
+                "groups": [
+                    {
+                        "group": "Commands",
+                        "pages": [
+                            "/commands/assert",
+                            "/commands/exec",
+                            "/commands/focus-application",
+                            "/commands/hover-image",
+                            "/commands/hover-text",
+                            "/commands/if",
+                            "/commands/match-image",
+                            "/commands/press-keys",
+                            "/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"
+                        ]
+                    },
+                    {
+                        "group": "Interactive Commands",
+                        "pages": [
+                            "/interactive/assert",
+                            "/interactive/dry",
+                            "/interactive/explore",
+                            "/interactive/generate",
+                            "/interactive/run",
+                            "/interactive/save",
+                            "/interactive/undo"
+                        ]
+                    },
+                    {
+                        "group": "CLI",
+                        "pages": [
+                            "/cli/overview"
+                        ]
+                    }
+                ]
+            }
+        ],
+        "global": {
+            "anchors": [
+                {
+                    "anchor": "Community",
+                    "href": "https://discord.com/invite/cWDFW8DzPm",
+                    "icon": "discord"
+                },
+                {
+                    "anchor": "Book a Demo",
+                    "href": "https://calendly.com/d/cq23-qyn-3v6/testdriver-ai-demo",
+                    "icon": "calendar"
+                }
             ]
-          },
-          {
-            "group": "Getting Started",
-            "pages": [
-              "/getting-started/vscode",
-              "/getting-started/setup",
-              "/getting-started/writing",
-              "/getting-started/generating",
-              "/getting-started/running",
-              "/getting-started/ci",
-              "/features/auto-healing",
-              "/getting-started/editing"
-            ]
-          },
-          {
-            "group": "Writing Tests",
-            "pages": [
-              "/guide/locating",
-              "/guide/waiting",
-              "/guide/assertions",
-              "/guide/variables",
-              "/guide/authentication",
-              "/guide/lifecycle",
-              "/guide/code"
-            ]
-          },
-          {
-            "group": "Running in CI",
-            "pages": [
-              "/action/setup",
-              "/action/browser",
-              "/action/os",
-              "/action/output",
-              "/action/performance",
-              "/action/prerun",
-              "/action/secrets"
-            ]
-          },
-          {
-            "group": "Security & Privacy",
-            "pages": [
-              "/security/agent",
-              "/security/action",
-              "/security/platform"
-            ]
-          }
-        ]
-      },
-      {
-        "tab": "Reference",
-        "groups": [
-          {
-            "group": "Commands",
-            "pages": [
-              "/commands/assert",
-              "/commands/exec",
-              "/commands/focus-application",
-              "/commands/hover-image",
-              "/commands/hover-text",
-              "/commands/match-image",
-              "/commands/if",
-              "/commands/press-keys",
-              "/commands/run",
-              "/commands/scroll",
-              "/commands/scroll-until-image",
-              "/commands/scroll-until-text",
-              "/commands/type",
-              "/commands/wait",
-              "/commands/wait-for-image",
-              "/commands/wait-for-text"
-            ]
-          },
-          {
-            "group": "Interactive Commands",
-            "pages": [
-              "/interactive/assert",
-              "/interactive/undo",
-              "/interactive/save",
-              "/interactive/run",
-              "/interactive/generate"
-            ]
-          },
-          {
-            "group": "CLI",
-            "pages": ["/cli/overview"]
-          }
-        ]
-      }
-    ],
-    "global": {
-      "anchors": [
-        {
-          "anchor": "Community",
-          "href": "https://discord.com/invite/cWDFW8DzPm",
-          "icon": "discord"
-        },
-        {
-          "anchor": "Book a Demo",
-          "href": "https://calendly.com/d/cq23-qyn-3v6/testdriver-ai-demo",
-          "icon": "calendar"
         }
-      ]
-    }
-  },
-  "logo": {
-    "light": "/images/template/light.png",
-    "dark": "/images/template/dark.png",
-    "href": "https://testdriver.ai"
-  },
-  "navbar": {
-    "links": [
-      {
-        "label": "Support",
-        "href": "https://testdriver.canny.io/testdriver"
-      }
-    ],
-    "primary": {
-      "type": "button",
-      "label": "Dashboard",
-      "href": "https://app.testdriver.ai"
-    }
-  },
-  "footer": {
-    "socials": {
-      "x": "https://x.com/testdriverai",
-      "github": "https://github.com/testdriverai"
+    },
+    "modeToggle": {
+        "enabled": false,
+        "default": "dark"
+    },
+    "logo": {
+        "light": "/images/template/light.png",
+        "dark": "/images/template/dark.png",
+        "href": "https://testdriver.ai"
+    },
+    "navbar": {
+        "links": [
+            {
+                "label": "GitHub",
+                "href": "https://github.com/testdriverai/testdriverai"
+            },
+            {
+                "label": "Report an Issue",
+                "href": "https://github.com/testdriverai/testdriverai/issues/new"
+            }
+        ],
+        "primary": {
+            "type": "button",
+            "label": "Dashboard",
+            "href": "https://app.testdriver.ai"
+        }
+    },
+    "footer": {
+        "socials": {
+            "x": "https://x.com/testdriverai",
+            "github": "https://github.com/testdriverai",
+            "discord": "https://discord.com/invite/cWDFW8DzPm",
+            "youtube": "https://www.youtube.com/@testdriverai"
+        }
+    },
+    "redirects": [],
+    "integrations": {
+      "segment": {
+          "key": "oh4PK60u4Qvm2DKIjxfhxd0KCdRbQsQE"
+      },
+      "posthog": {
+          "apiKey": "phc_ovOQ2HFpqFwPVqaxE5plJmI9buPMsz024FB2iajItqn"
     }
   }
 }

package/docs/exporting/playwright.mdx

@@ -1,17 +1,18 @@
 ---
 title: "Playwright Export"
 sidebarTitle: "Playwright"
-description: "A comprehensive guide to integrating TestDriver.ai with Playwright for automated test generation."
+description: "A comprehensive guide to integrating TestDriver with Playwright for automated test generation."
+icon: "masks-theater"
 ---
 
-This guide explains how to use **TestDriver.ai** to generate Playwright test scripts and integrate them into your repository using a GitHub Actions workflow. The workflow automates the process of generating Playwright tests, creating a pull request with the generated test, and ensuring all dependencies are installed.
+This guide explains how to use **TestDriver** to generate Playwright test scripts and integrate them into your repository using a GitHub Actions workflow. The workflow automates the process of generating Playwright tests, creating a pull request with the generated test, and ensuring all dependencies are installed.
 
 ---
 
 ## Workflow Overview
 
 1. **Install Playwright**: The workflow installs Playwright and its dependencies.
-2. **Generate Playwright Test**: TestDriver.ai generates a Playwright test script using the `playwright codegen` tool.
+2. **Generate Playwright Test**: TestDriver generates a Playwright test script using the `playwright codegen` tool.
 3. **Create Pull Request**: The generated test is committed to a new branch, and a pull request is created for review.
 
 ---
@@ -19,19 +20,19 @@ This guide explains how to use **TestDriver.ai** to generate Playwright test scr
 ## Prerequisites
 
 1. **GitHub Repository**: Ensure your project is hosted on GitHub.
-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. **Node.js Installed**: Playwright requires Node.js to run.
 
 ---
 
 ## GitHub Actions Workflow
 
-Here’s the GitHub Actions workflow to automate the process:
+Here's the GitHub Actions workflow to automate the process:
 
 ### Workflow File: `.github/workflows/playwright.yml`
 
 ```yaml
-name: TestDriver.ai / Playwright
+name: TestDriver / Playwright
 
 on:
   push:
@@ -56,11 +57,11 @@ jobs:
 
       - uses: testdriverai/action@main
         with:
-          key: ${{ secrets.TESTDRIVER_API_KEY }}
+          key: ${{ secrets.TD_API_KEY }}
 
           create-pr: true
           pr-base: main
-          pr-title: "TestDriver.ai / Generate Playwright Test"
+          pr-title: "TestDriver / Generate Playwright Test"
           pr-branch: generate-playwright
           pr-test-filename: generate-playwright.yml
 
@@ -90,70 +91,76 @@ jobs:
 ## Workflow Steps Explained
 
 ### 1. **Check Out Repository**
-The workflow checks out the repository to ensure the latest code is available for the test generation process.```yaml
+The workflow checks out the repository to ensure the latest code is available for the test generation process.
+```yaml
 - name: Check out repository
   uses: actions/checkout@v2
   with:
     ref: $\{\{ github.event.ref }}
-
 ```
 
 ---
 
 ### 2. **Install Playwright**
-The `prerun` script installs Playwright globally and sets up its dependencies (e.g., Chromium browser).```bash
+The `prerun` script installs Playwright globally and sets up its dependencies (e.g., Chromium browser).
+```bash
 npm install playwright -g
 playwright install --with-deps chromium
 
-```---
+```
+---
 
 ### 3. **Generate Playwright Test**
-The `playwright codegen` command generates a Playwright test script (`pw-test.spec.js`) for the specified URL (`https://airbnb.com`).```bash
+The `playwright codegen` command generates a Playwright test script (`pw-test.spec.js`) for the specified URL (`https://airbnb.com`).
+```bash
 npx playwright codegen --target playwright-test -o testdriver/pw-test.spec.js https://airbnb.com
-
-```---
+```
+---
 
 ### 4. **Create Pull Request**
-The workflow commits the generated test script to a new branch (`generate-playwright`) and creates a pull request with the title `TestDriver.ai / Generate Playwright Test`.```yaml
+The workflow commits the generated test script to a new branch (`generate-playwright`) and creates a pull request with the title `TestDriver / Generate Playwright Test`.
+```yaml
 create-pr: true
 pr-base: main
-pr-title: "TestDriver.ai / Generate Playwright Test"
+pr-title: "TestDriver / Generate Playwright Test"
 pr-branch: generate-playwright
 pr-test-filename: generate-playwright.yml
-
 ```
 
 ---
 
 ## Running the Workflow
 
-1. **Trigger the Workflow**:
+<Steps>
+<Step title="Trigger the Workflow">
   - Push changes to the `main` branch.
   - Open a pull request.
   - Manually trigger the workflow using the **workflow_dispatch** event.
-
-2. **Review the Pull Request**:
+  </Step>
+<Step title="Review the Pull Request">
   - Navigate to the **Pull Requests** tab in your GitHub repository.
   - Review the generated Playwright test script (`pw-test.spec.js`).
+  </Step>
 
-3. **Merge the Pull Request**:
+<Step title="Merge the Pull Request">
   - Once reviewed, merge the pull request to include the generated test in your repository.
-
+</Step>
+</Steps>
 ---
 
 ## Example Output
 
 - **Generated Test File**: `testdriver/pw-test.spec.js`
-- **Pull Request**: A new pull request titled `TestDriver.ai / Generate Playwright Test` will be created.
+- **Pull Request**: A new pull request titled `TestDriver / Generate Playwright Test` will be created.
 
 ---
 
 ## Best Practices
 
-1. **Secure API Key**: Store the TestDriver.ai API key as a GitHub secret to avoid exposing sensitive information.
+1. **Secure API Key**: Store the TestDriver API key as a GitHub secret to avoid exposing sensitive information.
 2. **Review Generated Tests**: Always review the generated Playwright test scripts to ensure they meet your requirements.
 3. **Customize Test Generation**: Modify the `playwright codegen` command to target specific URLs or workflows.
 
 ---
 
-By following this guide, you can seamlessly integrate TestDriver.ai with Playwright to generate and manage end-to-end tests in your GitHub repository.
+By following this guide, you can seamlessly integrate TestDriver with Playwright to generate and manage end-to-end tests in your GitHub repository.

package/docs/features/auto-healing.mdx

@@ -1,11 +1,11 @@
 ---
-title: "Auto-Healing in TestDriver.ai"
+title: "Auto-Healing in TestDriver"
 sidebarTitle: "Auto-Healing"
-description: "Learn how TestDriver.ai's auto-healing feature keeps your tests resilient and up-to-date with minimal manual effort."
+description: "Learn how TestDriver's auto-healing feature keeps your tests resilient and up-to-date with minimal manual effort."
 icon: "bandage"
 ---
 
-Auto-healing is a powerful feature in TestDriver.ai that ensures your tests remain resilient even when the application under test changes. 
+Auto-healing is a powerful feature in TestDriver that ensures your tests remain resilient even when the application under test changes. 
 
 When TestDriver steps fail, the AI will progressively fall back to attempt to complete the test.
 
@@ -20,15 +20,16 @@ If running on CI, TestDriver will open a pull request (PR) with the updated test
 
 ## How Auto-Healing Works
 
-1. **Test Execution**: TestDriver.ai runs your test suite as usual.
+1. **Test Execution**: TestDriver runs your test suite as usual.
 2. **Failure Detection**: If a test fails due to a change in the application (e.g., text or UI updates), the AI identifies the failure point.
 3. **Recovery Attempt**: The AI uses its adaptive capabilities to locate the updated element or text and retries the action.
-4. **Test Update**: If the recovery is successful, TestDriver.ai updates the test script with the new element or text.
+4. **Test Update**: If the recovery is successful, TestDriver updates the test script with the new element or text.
 5. **Pull Request Creation**: The updated test script is committed to a new branch, and a pull request is automatically opened in your repository for review.
 
 ### Example: Button Text Changes from "Submit" to "Send"
 
-1. **Initial Test**:
+<Steps>
+<Step title="Initial Test">
 
 ```yaml {2}
 - command: hover-text
@@ -36,18 +37,20 @@ If running on CI, TestDriver will open a pull request (PR) with the updated test
   description: Submit button in the form
   action: click
 ```
-
-2. **Application Update**:
+</Step>
+<Step title="Application Update">
   - The button text is changed from "Submit" to "Send" in the application.
+</Step>
 
-3. **Test Execution**:
-  - TestDriver.ai runs the test and fails to find the "Submit" button.
+<Step title="Test Execution">
+  - TestDriver runs the test and fails to find the "Submit" button.
+</Step>
 
-4. **Auto-Healing**:
+<Step title="Auto-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.
-
-5. **Test Update**:
+</Step>
+<Step title="Test Update">
   - The test script is updated to reflect the new button text:
   
   ```yaml {2}
@@ -56,18 +59,20 @@ If running on CI, TestDriver will open a pull request (PR) with the updated test
     description: Submit button in the form
     action: click
   ```
-
-6. **Pull Request Creation**:
-   - TestDriver.ai commits the updated test to a new branch and opens a PR:
+</Step>
+<Step title="Pull Request Creation">
+   - TestDriver commits the updated test to a new branch and opens a PR:
      - **Branch Name**: `auto-heal-update-submit-to-send`
      - **PR Title**: `Auto-Healed Test: Updated "Submit" to "Send"`
 
+</Step>
+</Steps>
 ## Example GitHub Action for Auto-Healing
 
-Here’s how you can configure a GitHub Action to enable auto-healing and PR creation:
+Here's how you can configure a GitHub Action to enable auto-healing and PR creation:
 
 ```yaml {24-30} 
-name: TestDriver.ai Auto-Healing
+name: TestDriver Auto-Healing
 
 on:
   push:
@@ -84,10 +89,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 testdriver/onboarding.yaml --save
           create-pr: true