Skip to content

docs: add Chromium installation to example verification instructions - #543

Merged
electrohyun merged 2 commits into
electrohyun:mainfrom
Revan0809:docs/chromium-install-for-browser-verification
Oct 1, 2026
Merged

electrohyun merged 2 commits into
electrohyun:mainfrom
Revan0809:docs/chromium-install-for-browser-verification

Conversation

@Revan0809

Copy link
Copy Markdown
Contributor

Summary

Both examples/drawing-game and examples/shared-worker-lobby offer browser verification (pnpm example:drawing-game:verify / pnpm example:shared-worker), but neither README mentioned that Playwright needs Chromium installed first. CI already installs it (.github/workflows/ci.yml runs pnpm exec playwright install --with-deps chromium) before running these checks, so a first-time local run of the verify commands fails without this.

  • Added a setup note before each browser verification command: "Before your first browser verification, install Chromium by running pnpm exec playwright install chromium from the repository root."
  • Kept the note with the browser checks only — the Node comparison commands (pnpm example:drawing-game:test) don't need Chromium, so they're left alone.

Fixes #522

Test plan

  • pnpm format — 0 changes to the two edited files (formatting already correct)
  • Verified the note sits immediately before each browser-based verify command in both READMEs

🤖 Generated with Claude Code

@Revan0809
Revan0809 requested a review from electrohyun as a code owner October 1, 2026 12:48
@vercel

vercel Bot commented Oct 1, 2026

Copy link
Copy Markdown

@Revan0809 is attempting to deploy a commit to the electrohyun's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Important

  • 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Repository: electrohyun/smocket/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: fc7d9009-2e20-47e6-978b-ab8c9fe37602

  • Autopilot · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Autopilot is currently an internal CodeRabbit preview.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions github-actions Bot added documentation Improvements or additions to documentation 📏 xs Pull request changes fewer than 10 lines good first issue Good for newcomers labels Oct 1, 2026
@vercel

vercel Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
smocket Ready Ready Preview Oct 1, 2026 1:00pm UTC

@electrohyun
electrohyun enabled auto-merge (squash) October 1, 2026 13:01
@electrohyun
electrohyun disabled auto-merge October 1, 2026 13:03

@electrohyun electrohyun left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thank you for the contribution!

@electrohyun
electrohyun merged commit cabf05c into electrohyun:main Oct 1, 2026
16 of 17 checks passed

This branch was previously deployed

1 inactive deployment
Preview — 0429bc6a Deployed Oct 1, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation good first issue Good for newcomers 📏 xs Pull request changes fewer than 10 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: add Chromium installation to example verification instructions

2 participants