Skip to content

docs: rewrite README, add CONTRIBUTING, and polish project metadata#1

Merged
awdr74100 merged 3 commits into
mainfrom
docs/oss-front-door
Jun 23, 2026
Merged

docs: rewrite README, add CONTRIBUTING, and polish project metadata#1
awdr74100 merged 3 commits into
mainfrom
docs/oss-front-door

Conversation

@awdr74100

Copy link
Copy Markdown
Owner

Summary

Polishes the project's open-source front door. No runtime/behavior changes beyond a pnpm-version requirement bump.

  • README — full rewrite (the old one still read "M0 / Not yet usable"). Adds a Mermaid architecture diagram, Quick start, Skills, an 88-tool overview, an FAQ (covering the common npx + version-manager PATH gotcha with fnm/nvm/asdf/volta/mise), and a "What's in the name" note (the -wright maker tradition, a nod to Playwright).
  • CONTRIBUTING.md — new contributor guide; points to AGENTS.md for the architecture deep-dive.
  • npm metadata — sharpened the @figwright/mcp description and added keywords for discoverability; aligned the root description to match.
  • pnpm 11 — bumped engines.pnpm to >=11.0.0 and aligned the docs (the project already pins pnpm@11.8.0 via packageManager).

Validation

  • Local CI gate green: typecheck, lint, format:check, knip, build, test (664 tests).
  • publint reports no issues for @figwright/mcp.

Out of band

  • GitHub repo About + topics were updated separately and are already live (not part of this diff).

@awdr74100 awdr74100 merged commit 92b42ad into main Jun 23, 2026
2 checks passed
@awdr74100 awdr74100 deleted the docs/oss-front-door branch July 4, 2026 10:23
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