[docs] Reduce redundancy in playwright.md reference doc#26360
Conversation
Removed duplicated intro code block (re-shown in Version section), Default Localhost Access section (restated what the intro already says), and condensed the GitHub Actions Compatibility and Browser Support sections. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Reduces redundancy in the Playwright reference documentation by removing duplicated examples/sections and condensing verbose explanations.
Changes:
- Removed duplicated introductory YAML examples and the “Default Localhost Access” section.
- Condensed GitHub Actions compatibility guidance into a single sentence.
- Converted the Browser Support bullet list into a single prose sentence.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/reference/playwright.md |
Trims repeated/verbose documentation to make the Playwright reference more concise. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (1)
docs/src/content/docs/reference/playwright.md:22
- The YAML example under “Version” is invalid because it repeats the
tools.playwrightkey twice; in YAML the latter entry overwrites the former, so readers won’t actually get both configurations. Consider splitting this into separate examples (one per variant) or keep a singletools.playwrightblock and describe the allowedversionvalues in text/comments without duplicating the key.
```yaml wrap
tools:
playwright:
version: "1.56.1" # Pin to specific version (default)
playwright:
version: "latest" # Use latest available version
</details>
- **Files reviewed:** 1/1 changed files
- **Comments generated:** 1
| Pin to a specific version or use the latest: | ||
|
|
||
| ```yaml wrap | ||
| tools: |
There was a problem hiding this comment.
The wording here implies the default is a pinned version. In practice the default behavior is “omit version”, and the documented default 1.56.1 should match the implementation default (DefaultPlaywrightBrowserVersion is v1.59.1 in pkg/constants/version_constants.go). Please adjust the text/example so it shows the true default case and aligns the default version value with the code.
What changed
Removed documentation bloat from
docs/src/content/docs/reference/playwright.md.Bloat removed
tools.playwright:yaml snippets (bare, pinned version, latest). These were immediately re-shown in the "Configuration Options → Version" section with identical content, making the intro block pure duplication. Removed the intro block; the Version section is the canonical location.localhost/127.0.0.1defaults. The same defaults are already stated in plain text in the Network Access Configuration intro sentence. The standalone section added no new information.--security-opt,--ipc=host) with verbose descriptions. These flags are applied automatically and users never configure them. Condensed to a single sentence.Metrics
Verification
Page renders correctly at
/gh-aw/reference/playwright/. Verified via curl — Playwright screenshots were unavailable due to container network isolation in this workflow run.References: §24435268283