Skip to content

[docs] Reduce redundancy in playwright.md reference doc#26360

Merged
pelikhan merged 1 commit intomainfrom
docs/unbloat-playwright-449fd596fcbe8df2
Apr 15, 2026
Merged

[docs] Reduce redundancy in playwright.md reference doc#26360
pelikhan merged 1 commit intomainfrom
docs/unbloat-playwright-449fd596fcbe8df2

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

What changed

Removed documentation bloat from docs/src/content/docs/reference/playwright.md.

Bloat removed

  • Redundant intro code block — The opening code block showed three 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.
  • "Default Localhost Access" section — Showed a yaml block for localhost/127.0.0.1 defaults. The same defaults are already stated in plain text in the Network Access Configuration intro sentence. The standalone section added no new information.
  • "GitHub Actions Compatibility" bullets — Two bullet points listing internal Docker flags (--security-opt, --ipc=host) with verbose descriptions. These flags are applied automatically and users never configure them. Condensed to a single sentence.
  • "Browser Support" list — Three-item bullet list for Chromium/Firefox/WebKit. Converted to a single prose sentence with no loss of information.

Metrics

Metric Before After Reduction
Lines 207 174 -33 (16%)
Bullet points 34 27 -7 (21%)

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

🗜️ Compressed by Documentation Unbloat · ● 496.4K ·

  • expires on Apr 17, 2026, 3:53 AM UTC

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>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation doc-unbloat labels Apr 15, 2026
@pelikhan pelikhan marked this pull request as ready for review April 15, 2026 04:01
Copilot AI review requested due to automatic review settings April 15, 2026 04:01
@pelikhan pelikhan merged commit 458d295 into main Apr 15, 2026
3 checks passed
@pelikhan pelikhan deleted the docs/unbloat-playwright-449fd596fcbe8df2 branch April 15, 2026 04:02
@github-actions github-actions bot mentioned this pull request Apr 15, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.playwright key 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 single tools.playwright block and describe the allowed version values 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


Comment on lines +14 to 17
Pin to a specific version or use the latest:

```yaml wrap
tools:
Copy link

Copilot AI Apr 15, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation doc-unbloat documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants