Skip to content

docs: fix browser-checks/examples (DOC-150) - #656

Merged
hlenke merged 2 commits into
mainfrom
docs-audit/doc-150-browser-check-examples
Oct 28, 2026
Merged

hlenke merged 2 commits into
mainfrom
docs-audit/doc-150-browser-check-examples

Conversation

@hlenke

@hlenke hlenke commented Oct 27, 2026

Copy link
Copy Markdown
Member

Removes a broken example from the browser check examples page and adds a note about imports.

What was wrong

  • The "Core Web Vitals Validation" example never finishes. I ran it with Playwright against a local test page. page.evaluate hangs until the 30 s test timeout: the PerformanceObserver is created after the page has loaded, so its callback never fires and the promise never resolves. It also waits on FID, which needs a real user click.
  • None of the examples import test and expect, so copying one into a check gives test is not defined.

What changed

  • I replaced the Web Vitals code with one sentence: Checkly collects Web Vitals automatically for every page a browser check visits. It links to the Performance & Web Vitals page.
  • I added one line under the intro saying the examples leave out the @playwright/test import.

Not changed (noted on the ticket)
The rest of the page is generic sample code. The accessibility example's "contrast check" only compares two colors, and using @axe-core/playwright would be better. Rewriting the page is a bigger editorial job, so I left it for a follow-up.

vale and npm run check:links are clean.

Linear: DOC-150

🤖 Generated with Claude Code

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

mintlify Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
checkly-422f444a 🟢 Ready View Preview Oct 27, 2026, 9:42 PM

The old example's 'contrast check' only compared two colors. Checkly runtimes ship
@axe-core/playwright; tested with 4.11.1: a clean page passes, a page with contrast,
label and alt-text issues fails.

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

hlenke commented Oct 27, 2026

Copy link
Copy Markdown
Member Author

Follow-up from review (F254): the accessibility example now uses @axe-core/playwright, which ships in runtimes 2025.04 (4.10.1) and 2026.04 (4.11.1), instead of a 'contrast check' that only compared two colors (240db66). Tested with Playwright 1.64.1 and axe 4.11.1: a clean page passed, a page with contrast, label, alt-text and lang issues failed, and example.com passed. It wasn't run as a Checkly browser check, because the browser runner isn't enabled on the local stack. F255 (rewrite the page with Checkly-specific examples) is editorial and is tracked in DOC-235.

@hlenke
hlenke marked this pull request as ready for review October 28, 2026 19:08
@hlenke
hlenke merged commit 9a89b61 into main Oct 28, 2026
9 checks passed

This branch was successfully deployed

1 active deployment
staging — 240db661 Deployed Oct 27, 2026 by mintlify[bot]
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