diff --git a/docs-site/docs/accessibility.md b/docs-site/docs/accessibility.md index d3e0924..bc43c87 100644 --- a/docs-site/docs/accessibility.md +++ b/docs-site/docs/accessibility.md @@ -1,4 +1,5 @@ --- +description: "Accessibility testing in Selenium: assert WCAG compliance with bundled axe-core in one line, inside your existing Selenium tests, no extra tools." id: accessibility title: Accessibility Assertions sidebar_position: 17 diff --git a/docs-site/docs/changelog.md b/docs-site/docs/changelog.md index deb50cb..a93e13e 100644 --- a/docs-site/docs/changelog.md +++ b/docs-site/docs/changelog.md @@ -1,4 +1,5 @@ --- +description: "Selenium Boot release notes and version history: new features, fixes, and breaking changes across every release." id: changelog title: Changelog sidebar_position: 99 diff --git a/docs-site/docs/ci/github-actions.md b/docs-site/docs/ci/github-actions.md index 44c4421..d378629 100644 --- a/docs-site/docs/ci/github-actions.md +++ b/docs-site/docs/ci/github-actions.md @@ -1,4 +1,5 @@ --- +description: "Run Selenium tests in GitHub Actions: a copy-paste workflow that installs Chrome, runs the suite headless, and uploads the HTML report on every push." id: github-actions title: GitHub Actions sidebar_position: 1 diff --git a/docs-site/docs/ci/jenkins.md b/docs-site/docs/ci/jenkins.md index 5688dd2..8e7c3d4 100644 --- a/docs-site/docs/ci/jenkins.md +++ b/docs-site/docs/ci/jenkins.md @@ -1,4 +1,5 @@ --- +description: "Run Selenium tests on Jenkins: a ready Jenkinsfile pipeline that runs the suite, publishes JUnit results, and archives the Selenium Boot HTML report." id: jenkins title: Jenkins sidebar_position: 2 diff --git a/docs-site/docs/ci/quality-gates.md b/docs-site/docs/ci/quality-gates.md index d8ef53a..9f2c32c 100644 --- a/docs-site/docs/ci/quality-gates.md +++ b/docs-site/docs/ci/quality-gates.md @@ -1,4 +1,5 @@ --- +description: "Fail your CI build on a low pass rate or too many flaky tests. Configure Selenium test quality gates so a green pipeline never hides real failures." id: quality-gates title: Quality Gates sidebar_position: 3 diff --git a/docs-site/docs/clock-mocking.md b/docs-site/docs/clock-mocking.md index 0b6d54c..b018b66 100644 --- a/docs-site/docs/clock-mocking.md +++ b/docs-site/docs/clock-mocking.md @@ -1,4 +1,5 @@ --- +description: "Mock the browser clock in Selenium tests: freeze or advance JavaScript Date to test countdowns, trials, and time-sensitive UI deterministically." id: clock-mocking title: Clock Mocking sidebar_position: 14 diff --git a/docs-site/docs/cloud-execution.md b/docs-site/docs/cloud-execution.md index b1f25fa..590f7c7 100644 --- a/docs-site/docs/cloud-execution.md +++ b/docs-site/docs/cloud-execution.md @@ -1,4 +1,5 @@ --- +description: "Run Selenium tests on BrowserStack and Sauce Labs with zero code changes. Switch from local Chrome to cloud browsers by editing one config line." id: cloud-execution title: Cloud Execution sidebar_position: 12 diff --git a/docs-site/docs/configuration.md b/docs-site/docs/configuration.md index 8c6ae3a..312dfa1 100644 --- a/docs-site/docs/configuration.md +++ b/docs-site/docs/configuration.md @@ -1,4 +1,5 @@ --- +description: "Complete selenium-boot.yml configuration reference: browser, parallel threads, timeouts, retry, and CI quality gates, every option in one place." id: configuration title: Configuration Reference sidebar_position: 3 diff --git a/docs-site/docs/cucumber.md b/docs-site/docs/cucumber.md index abb79b1..ced49bc 100644 --- a/docs-site/docs/cucumber.md +++ b/docs-site/docs/cucumber.md @@ -1,4 +1,5 @@ --- +description: "BDD Selenium testing with Cucumber 7: driver lifecycle, screenshots on failure, and a step timeline in the HTML report, wired up out of the box." id: cucumber title: BDD / Cucumber sidebar_position: 11 diff --git a/docs-site/docs/email-verification.md b/docs-site/docs/email-verification.md index 032da0e..cec40d6 100644 --- a/docs-site/docs/email-verification.md +++ b/docs-site/docs/email-verification.md @@ -1,4 +1,5 @@ --- +description: "Verify emails in Selenium tests: assert confirmation links, password resets, and OTPs via Mailhog, Mailtrap, Graph API, or IMAP with the mailbox() API." id: email-verification title: Email Verification sidebar_position: 11 diff --git a/docs-site/docs/extensibility/custom-drivers.md b/docs-site/docs/extensibility/custom-drivers.md index 260c5d7..70b1342 100644 --- a/docs-site/docs/extensibility/custom-drivers.md +++ b/docs-site/docs/extensibility/custom-drivers.md @@ -1,4 +1,5 @@ --- +description: "Add a custom WebDriver to Selenium Boot: plug in Edge, Safari, Appium, or a cloud driver via NamedDriverProvider without touching the framework." id: custom-drivers title: Custom Drivers sidebar_position: 3 diff --git a/docs-site/docs/extensibility/hooks.md b/docs-site/docs/extensibility/hooks.md index e2c3359..2391d76 100644 --- a/docs-site/docs/extensibility/hooks.md +++ b/docs-site/docs/extensibility/hooks.md @@ -1,4 +1,5 @@ --- +description: "Run code at suite and test lifecycle points in Selenium with ExecutionHook: inject setup, teardown, and failure handling without subclassing." id: hooks title: Execution Hooks sidebar_position: 2 diff --git a/docs-site/docs/extensibility/plugins.md b/docs-site/docs/extensibility/plugins.md index 166c2d7..4f822f6 100644 --- a/docs-site/docs/extensibility/plugins.md +++ b/docs-site/docs/extensibility/plugins.md @@ -1,4 +1,5 @@ --- +description: "Extend Selenium Boot with plugins: SeleniumBootPlugin adds behaviour alongside the framework, auto-discovered via Java SPI and ServiceLoader." id: plugins title: Plugins sidebar_position: 1 diff --git a/docs-site/docs/extensibility/report-adapters.md b/docs-site/docs/extensibility/report-adapters.md index 4f8e388..e95d404 100644 --- a/docs-site/docs/extensibility/report-adapters.md +++ b/docs-site/docs/extensibility/report-adapters.md @@ -1,4 +1,5 @@ --- +description: "Turn Selenium test results into any format with ReportAdapter: Slack messages, Allure, email summaries, or custom dashboards from the metrics JSON." id: report-adapters title: Report Adapters sidebar_position: 4 diff --git a/docs-site/docs/external-test-data.md b/docs-site/docs/external-test-data.md index de83485..5f80081 100644 --- a/docs-site/docs/external-test-data.md +++ b/docs-site/docs/external-test-data.md @@ -1,4 +1,5 @@ --- +description: "Data-driven Selenium tests: load @TestData rows from CSV files, Excel workbooks, and live database queries with no extra boilerplate." id: external-test-data title: External Test Data Sources sidebar_position: 13 diff --git a/docs-site/docs/getting-started.md b/docs-site/docs/getting-started.md index 76dd5ca..22b6011 100644 --- a/docs-site/docs/getting-started.md +++ b/docs-site/docs/getting-started.md @@ -1,4 +1,5 @@ --- +description: "Get your first Selenium test running in under 5 minutes: add one dependency, extend BaseTest, and run, with no WebDriver setup or boilerplate." id: getting-started title: Getting Started sidebar_position: 2 diff --git a/docs-site/docs/gradle.md b/docs-site/docs/gradle.md index bfb1faf..b4b4e58 100644 --- a/docs-site/docs/gradle.md +++ b/docs-site/docs/gradle.md @@ -1,4 +1,5 @@ --- +description: "Use Selenium Boot with Gradle: the recommended build.gradle setup for running TestNG or JUnit 5 Selenium tests with the Maven Central JAR." id: gradle title: Gradle Build Support sidebar_position: 3 diff --git a/docs-site/docs/guides/api-auth.md b/docs-site/docs/guides/api-auth.md index 0662c51..34c8916 100644 --- a/docs-site/docs/guides/api-auth.md +++ b/docs-site/docs/guides/api-auth.md @@ -1,4 +1,5 @@ --- +description: "API authentication for Selenium API tests: Bearer token, Basic auth, and OAuth2 client credentials supported out of the box." sidebar_position: 14 --- diff --git a/docs-site/docs/guides/api-testing.md b/docs-site/docs/guides/api-testing.md index 1c6db5f..5c8ea2b 100644 --- a/docs-site/docs/guides/api-testing.md +++ b/docs-site/docs/guides/api-testing.md @@ -1,4 +1,5 @@ --- +description: "API testing in Selenium Boot: write pure API tests or hybrid UI plus API tests in the same suite, config, and HTML report." sidebar_position: 13 --- diff --git a/docs-site/docs/guides/base-page.md b/docs-site/docs/guides/base-page.md index 5438dcd..7f52ad4 100644 --- a/docs-site/docs/guides/base-page.md +++ b/docs-site/docs/guides/base-page.md @@ -1,4 +1,5 @@ --- +description: "BasePage in Selenium Boot: wait-backed click, type, getText, dropdown, iframe, and upload helpers so you never write raw Selenium in page objects." id: base-page title: BasePage sidebar_position: 2 diff --git a/docs-site/docs/guides/base-test.md b/docs-site/docs/guides/base-test.md index c45ed52..eb8c164 100644 --- a/docs-site/docs/guides/base-test.md +++ b/docs-site/docs/guides/base-test.md @@ -1,4 +1,5 @@ --- +description: "BaseTest is the one superclass every Selenium Boot test extends, the only setup required. Driver lifecycle, waits, and reporting come for free." id: base-test title: BaseTest sidebar_position: 1 diff --git a/docs-site/docs/guides/browser-lifecycle.md b/docs-site/docs/guides/browser-lifecycle.md index 2b722c5..755524d 100644 --- a/docs-site/docs/guides/browser-lifecycle.md +++ b/docs-site/docs/guides/browser-lifecycle.md @@ -1,4 +1,5 @@ --- +description: "Control the Selenium browser lifecycle: choose per-test or per-suite WebDriver sessions to balance execution speed against test isolation." id: browser-lifecycle title: Browser Lifecycle sidebar_position: 7 diff --git a/docs-site/docs/guides/console-errors.md b/docs-site/docs/guides/console-errors.md index f509f28..29535fd 100644 --- a/docs-site/docs/guides/console-errors.md +++ b/docs-site/docs/guides/console-errors.md @@ -1,4 +1,5 @@ --- +description: "Catch JavaScript errors in Selenium tests: ConsoleErrorCollector captures browser console errors so silent JS failures fail the test." id: console-errors title: Console Error Collector sidebar_position: 11 diff --git a/docs-site/docs/guides/download-manager.md b/docs-site/docs/guides/download-manager.md index 746a745..f967006 100644 --- a/docs-site/docs/guides/download-manager.md +++ b/docs-site/docs/guides/download-manager.md @@ -1,4 +1,5 @@ --- +description: "Test file downloads in Selenium: DownloadManager polls the download directory, waits for the file to appear, and handles partial downloads." id: download-manager title: DownloadManager sidebar_position: 10 diff --git a/docs-site/docs/guides/parallel.md b/docs-site/docs/guides/parallel.md index c5b8c87..735d58f 100644 --- a/docs-site/docs/guides/parallel.md +++ b/docs-site/docs/guides/parallel.md @@ -1,4 +1,5 @@ --- +description: "Parallel Selenium test execution: set the thread count in selenium-boot.yml and get thread-safe, isolated WebDriver instances automatically." id: parallel title: Parallel Execution sidebar_position: 5 diff --git a/docs-site/docs/guides/precondition.md b/docs-site/docs/guides/precondition.md index 3150825..4dc925b 100644 --- a/docs-site/docs/guides/precondition.md +++ b/docs-site/docs/guides/precondition.md @@ -1,4 +1,5 @@ --- +description: "Log in once for all Selenium tests: @PreCondition runs setup once per thread and caches the session (cookies and localStorage) for every test." id: precondition title: "@PreCondition" sidebar_position: 12 diff --git a/docs-site/docs/guides/retry.md b/docs-site/docs/guides/retry.md index 45a660a..2e99c4b 100644 --- a/docs-site/docs/guides/retry.md +++ b/docs-site/docs/guides/retry.md @@ -1,4 +1,5 @@ --- +description: "Automatic retry for flaky Selenium tests: Selenium Boot re-runs failures with no IRetryAnalyzer wiring, enabled in a single config line." id: retry title: Retry sidebar_position: 4 diff --git a/docs-site/docs/guides/scenario-context.md b/docs-site/docs/guides/scenario-context.md index 0eb50e2..c94dd6a 100644 --- a/docs-site/docs/guides/scenario-context.md +++ b/docs-site/docs/guides/scenario-context.md @@ -1,4 +1,5 @@ --- +description: "Share state between Selenium test steps safely: built-in scenario and suite context stores replace static fields and thread-unsafe globals." sidebar_position: 15 --- diff --git a/docs-site/docs/guides/screenshots.md b/docs-site/docs/guides/screenshots.md index 859c232..d9b3474 100644 --- a/docs-site/docs/guides/screenshots.md +++ b/docs-site/docs/guides/screenshots.md @@ -1,4 +1,5 @@ --- +description: "Automatic screenshots on Selenium test failure, embedded as Base64 in the HTML report, with no external image files or storage to manage." id: screenshots title: Screenshots sidebar_position: 8 diff --git a/docs-site/docs/guides/self-healing.md b/docs-site/docs/guides/self-healing.md index f35cdbe..a729877 100644 --- a/docs-site/docs/guides/self-healing.md +++ b/docs-site/docs/guides/self-healing.md @@ -1,4 +1,5 @@ --- +description: "Self-healing Selenium locators: when a selector breaks, the framework falls back through id, name, text, and data-testid and flags every heal." id: self-healing title: Self-Healing Locators sidebar_position: 10 diff --git a/docs-site/docs/guides/semantic-locators.md b/docs-site/docs/guides/semantic-locators.md index 45b7b4e..3231ee9 100644 --- a/docs-site/docs/guides/semantic-locators.md +++ b/docs-site/docs/guides/semantic-locators.md @@ -1,4 +1,5 @@ --- +description: "Accessibility-first Selenium locators: Playwright-style getByRole, getByText, and getByLabel target the accessibility tree and survive CSS refactors." id: semantic-locators title: Accessibility-First Locators sidebar_position: 10 diff --git a/docs-site/docs/guides/smart-locator.md b/docs-site/docs/guides/smart-locator.md index 088b4db..8824ff8 100644 --- a/docs-site/docs/guides/smart-locator.md +++ b/docs-site/docs/guides/smart-locator.md @@ -1,4 +1,5 @@ --- +description: "SmartLocator tries multiple Selenium locator strategies in order and returns the first visible match: resilient locators for brittle selectors." id: smart-locator title: SmartLocator sidebar_position: 9 diff --git a/docs-site/docs/guides/step-logging.md b/docs-site/docs/guides/step-logging.md index c77c52d..ae6f07d 100644 --- a/docs-site/docs/guides/step-logging.md +++ b/docs-site/docs/guides/step-logging.md @@ -1,4 +1,5 @@ --- +description: "Log named test steps in Selenium: StepLogger renders a timeline with screenshots inside each test's detail panel in the HTML report." id: step-logging title: Step Logging sidebar_position: 6 diff --git a/docs-site/docs/guides/wait-engine.md b/docs-site/docs/guides/wait-engine.md index 7c42cb3..7ca77a2 100644 --- a/docs-site/docs/guides/wait-engine.md +++ b/docs-site/docs/guides/wait-engine.md @@ -1,4 +1,5 @@ --- +description: "Explicit waits in Selenium without Thread.sleep(): WaitEngine gives fluent, auto-configured waits driven by your selenium-boot.yml timeout." id: wait-engine title: WaitEngine sidebar_position: 3 diff --git a/docs-site/docs/intro.md b/docs-site/docs/intro.md index 27e05d7..5293d79 100644 --- a/docs-site/docs/intro.md +++ b/docs-site/docs/intro.md @@ -1,4 +1,5 @@ --- +description: "Selenium Boot is the Spring Boot of Selenium: zero setup, Playwright-inspired locators and auto-waiting, and enterprise features, without hiding Selenium." id: intro title: Introduction sidebar_position: 1 diff --git a/docs-site/docs/junit5.md b/docs-site/docs/junit5.md index 7c61c3f..9f0b930 100644 --- a/docs-site/docs/junit5.md +++ b/docs-site/docs/junit5.md @@ -1,4 +1,5 @@ --- +description: "Run Selenium Boot with JUnit 5: opt in via @ExtendWith(SeleniumBootExtension) or BaseJUnit5Test for the same lifecycle, waits, and reporting as TestNG." id: junit5 title: JUnit 5 Support sidebar_position: 10 diff --git a/docs-site/docs/performance.md b/docs-site/docs/performance.md index 9fd7685..f1030d1 100644 --- a/docs-site/docs/performance.md +++ b/docs-site/docs/performance.md @@ -1,4 +1,5 @@ --- +description: "Assert Core Web Vitals in Selenium tests: check LCP, CLS, and other Google performance metrics inline, with no proxy or external service." id: performance title: Performance Assertions sidebar_position: 16 diff --git a/docs-site/docs/quarantine.md b/docs-site/docs/quarantine.md index 2f6d7c0..3dc48b3 100644 --- a/docs-site/docs/quarantine.md +++ b/docs-site/docs/quarantine.md @@ -1,4 +1,5 @@ --- +description: "Quarantine flaky Selenium tests: mark known-broken tests so the framework skips them automatically, without deleting or commenting out code." id: quarantine title: Test Quarantine sidebar_position: 15 diff --git a/docs-site/docs/reporting/html-report.md b/docs-site/docs/reporting/html-report.md index b044674..590c7b3 100644 --- a/docs-site/docs/reporting/html-report.md +++ b/docs-site/docs/reporting/html-report.md @@ -1,4 +1,5 @@ --- +description: "Selenium Boot HTML report: a self-contained dashboard with pass-rate gauge, retries, screenshots, flakiness radar, and dark mode, no server needed." id: html-report title: HTML Report sidebar_position: 1 diff --git a/docs-site/docs/reporting/junit-xml.md b/docs-site/docs/reporting/junit-xml.md index ec772df..fca1176 100644 --- a/docs-site/docs/reporting/junit-xml.md +++ b/docs-site/docs/reporting/junit-xml.md @@ -1,4 +1,5 @@ --- +description: "Selenium Boot emits JUnit-compatible XML that Jenkins, GitHub Actions, and GitLab CI parse natively for standard test result reporting." id: junit-xml title: JUnit XML sidebar_position: 2 diff --git a/docs-site/docs/test-management.md b/docs-site/docs/test-management.md index 9c8a75b..53373df 100644 --- a/docs-site/docs/test-management.md +++ b/docs-site/docs/test-management.md @@ -1,4 +1,5 @@ --- +description: "Push Selenium test results to TestRail and Xray automatically: one annotation, no extra reporting code in your test methods." id: test-management title: TestRail & Xray Integration sidebar_position: 16