legend/gooey-test
Watch
9
0
Fork
You've already forked gooey-test
 0
Code Issues 9 Pull requests 6 Projects Releases Packages Wiki Activity Actions

docs: rewrite the README in the lead's voice (+ API reference & worked example) #13

Merged
sufian merged 6 commits from readme-tone into main 2026-10-12 12:24:17 +00:00
Conversation 0 Commits 6 Files changed 1 +203 -138
sufian commented 2026-10-12 03:57:58 +00:00
Owner
Copy link

Brings the README back to the lead's rewrite (the tone/style), on top of main.

The README that shipped in #1 was the earlier, more formal draft on wip/headless-runner; the rewrite lived on sufian-patch-1 and never made it into the squash merge. This PR is the rewrite, rebased onto main as a README-only change (so it doesn't revert the testRoot export / smoke test).

Contents:

  • Setup, Writing Tests, Running Tests, In browser, Test Runner Options, Debugging, Performance (the lead's structure + voice)
  • Corrected install steps (@playwright/test, vite, @srhazi/gooey peer, --with-deps)
  • Full exported API reference + a worked example (the two TODOs)
  • Drops the bottom ## Mocking and spying section (already covered by the "No mocks" bullet)

Diff is README.md only.

Brings the README back to the lead's rewrite (the tone/style), on top of `main`. The README that shipped in #1 was the earlier, more formal draft on `wip/headless-runner`; the rewrite lived on `sufian-patch-1` and never made it into the squash merge. This PR is the rewrite, rebased onto `main` as a **README-only** change (so it doesn't revert the `testRoot` export / smoke test). Contents: - Setup, Writing Tests, Running Tests, In browser, Test Runner Options, Debugging, Performance (the lead's structure + voice) - Corrected install steps (`@playwright/test`, `vite`, `@srhazi/gooey` peer, `--with-deps`) - Full exported **API** reference + a **worked example** (the two `TODO`s) - Drops the bottom `## Mocking and spying` section (already covered by the "No mocks" bullet) Diff is `README.md` only.
The README shipped in PR #1 was the earlier formal draft; this brings in the
lead's rewrite (tone), the corrected setup steps, the full exported API
reference, and a worked example. Drops the bottom 'Mocking and spying' section
(already covered by the 'No mocks' bullet).
- Running Tests now has ### Headless / ### In browser subsections
- Debugging a failure and Performance testing are top-level (they were
  mistakenly nested under Test Runner Options)
- Performance: close the unterminated backtick, drop the stray bullet, add a
  trailing newline, language on the example fence; describe what actually
  happens (numRuns default 29, warm-up, median/p50) rather than 'run your test
  a number of times'.
- Debugging: --debug-failures leaves the browser + server up; it does NOT open a
  debugging port (that's --remote-debugging-port). Split the Chromium path out.
Actually use my voice
sufian merged commit 8c0ef1561c into main 2026-10-12 12:24:17 +00:00
sufian deleted branch readme-tone 2026-10-12 12:24:17 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
legend/gooey-test!13
No description provided.