Skip to content

docs: bring the adapter READMEs in line with the code and the website - #431

Merged
vishnuv688 merged 2 commits into
mainfrom
docs/readme-website-parity
Oct 13, 2026
Merged

vishnuv688 merged 2 commits into
mainfrom
docs/readme-website-parity

Conversation

@vishnuv688

Copy link
Copy Markdown
Member

What & why

Several README statements had drifted from the code they describe. The matching website pages are corrected in webdriverio/webdriverio#16071, so without this the README and webdriver.io would disagree. Every change was checked against the current code.

Corrected

  • Nightwatch traces. Cucumber traces nest Feature → Scenario; steps are not stamped as groups. The trace pipeline is @wdio/devtools-trace, not core.
  • Nightwatch screencast. Each WebDriver session gets its own video, written under test-results/. Frames are taken over the WebDriver HTTP transport, not browser.takeScreenshot().
  • Nightwatch BiDi. A failed BiDi attach logs a warning; it is not silent.
  • Nightwatch examples table. It pointed at a removed ./example folder; it now lists the top-level examples/nightwatch/ demos.
  • Selenium import order. The README claimed the plugin must be imported before selenium-webdriver. Order doesn't matter: the plugin patches Selenium's prototypes as it loads, and every import finishes before test code runs.
  • Python README. It claimed there is no per-test slicing or retention, which contradicts its own granularity/policy section.
  • Python install. "pip install (when published)" is out of date: the package is on PyPI.
  • Service README:
    • fluent-ffmpeg already installs with the service, so the separate install step is gone.
    • The wdio-trace-*.json output is no longer written.
    • Output goes under test-results/.
    • The port default is 3000, not random.
    • show-trace opens a .zip only.
  • Root README.
    • The Selenium DOM-anchor footnote now reflects BiDi document-start registration.
    • The action allow-list lives in packages/shared/src/trace-actions.ts, with its real exclusions.
    • Nightwatch per-test screenshot/video are produce-only.
    • TestLens is the Source tab plus an "Open in editor" link for VS Code, not general editor integration.
    • The mobile examples key a timer duration rather than start a timer.
    • pip install selenium-devtools-py comes first.
  • @wdio/elements. The peer range is ^9 || ^10, and Nightwatch prefers CSS locators.

Added, to match the website

  • Mobile (Appium) sections for the Selenium, Python and Nightwatch adapters, including how to run the demos from a built checkout.
  • Nightwatch:
    • requirements (Nightwatch 3+, and @cucumber/cucumber taken from your own project)
    • why to set webSocketUrl: true even without bidi
    • maxBufferFrames
    • that live mode keeps the run open until the dashboard is closed

CLAUDE.md gets the same timer-flow correction as the root README.

Type of change

  • Bugfix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Polish (an improvement to an existing feature)
  • Breaking change (existing behavior changes for users)
  • Documentation
  • Internal (build, CI, dependencies, tooling)

Packages touched

  • shared (types and contracts)
  • core (framework-agnostic capture/reporting)
  • elements (published element/snapshot API — @wdio/elements)
  • service (WebdriverIO adapter)
  • nightwatch-devtools (Nightwatch adapter)
  • selenium-devtools (Selenium adapter)
  • selenium-devtools-py (Selenium Python adapter)
  • backend (server)
  • app (UI)
  • script (page-injected runtime)
  • trace (Trace mode)

Notes for reviewers

🤖 Generated with Claude Code

Several README statements had drifted from the code they describe, and
the website pages (webdriverio/webdriverio#16071) now state the
corrected behaviour, so the two sides would disagree.

Correct Nightwatch Cucumber nesting (Feature to Scenario), its per-session
screencast and output path, the Selenium import-order claim, the Python
README's claim that per-test slicing does not exist, the service's
fluent-ffmpeg step and removed trace JSON, which formats show-trace opens,
the port default, TestLens, the action allow-list and the elements peer
range. Add the Mobile (Appium) sections, the Nightwatch requirements and
the webSocketUrl advice the website documents.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@greptile-apps

greptile-apps Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerConfidence Score: 5/5

[Low impact] The documentation changes appear safe to merge.

Summary

Updates the adapter READMEs to match current capture behavior, options, and examples.

  • Nightwatch guides explain how traces, videos, and live runs behave.
  • Adapter guides show how to run DevTools with Appium.
  • Selenium imports work in either order in the setup guide.
  • Python guides describe the published install and trace slicing.
  • Root guides describe the current trace, mobile, and source details.
  • Service docs point to the current output folder and trace options.
  • Element docs cover WebdriverIO 10 and Nightwatch's CSS-first locators.

Reviews (2) · Last reviewed commit: "Update README.md" · Reviewed by Greptile

Comment thread README.md Outdated
Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
@vishnuv688
vishnuv688 merged commit 96799bb into main Oct 13, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant