Skip to content

docs: README update#4

Merged
MrFullStackDev merged 2 commits into
mainfrom
docs/readme-portfolio-polish
May 2, 2026
Merged

docs: README update#4
MrFullStackDev merged 2 commits into
mainfrom
docs/readme-portfolio-polish

Conversation

@MrFullStackDev

Copy link
Copy Markdown
Owner

Summary

Restructures the README so a recruiter or hiring manager can grok the project in 30 seconds while still keeping full reference material below.

  • New "At a glance" table — 73 tests · 4 browsers · 4-shard CI · 1.5 min suite. Skim-friendly.
  • New "What this project demonstrates" — test architecture, CI engineering, observability, dev ergonomics. Frames the work for SDET hiring criteria.
  • Live dashboard link to the GitHub Pages deploy at the top.
  • Accurate post-merge description — web-first assertions, Locator-first POs, `getByRole`/`getByLabel`, factory fixtures, tag taxonomy (smoke/critical/regression/flaky/slow), `test.step()`, storageState pattern, sharded CI with the shard-merge step.
  • New "CI strategy" section with an ASCII pipeline so reviewers can see the matrix → artifacts → merge → deploy flow at a glance.
  • Trimmed the deploy-target table and the static-mode feature comparison — details still in the workflow file and `export-dashboard.ts`.

Net diff: +229 / -278 (much higher info density up top).

Caveat

This PR describes the project as it will be after #1, #2, #3 land. Merge after those three so the README and the code agree.

Test plan

🤖 Generated with Claude Code

MrFullStackDev and others added 2 commits May 2, 2026 09:30
Restructures the README so a recruiter or hiring manager can grok the
project in 30 seconds while still having full reference material below.

- New "At a glance" table up top with concrete stats: 73 tests · 4
  browsers · 4-shard CI · 1.5 min suite.
- New "What this project demonstrates" callout — test architecture, CI
  engineering, observability, dev ergonomics — tied to SDET hiring
  criteria without sounding pleading.
- Live dashboard link to the GitHub Pages deploy.
- Accurate description of post-merge state: web-first assertions,
  Locator-first POs, getByRole/Label, factory fixtures, tag taxonomy
  (smoke/critical/regression/flaky/slow), test.step() usage,
  storageState pattern, sharded CI with shard-merge step.
- New "CI strategy" section with an ASCII pipeline so reviewers can see
  the matrix → artifacts → merge → deploy flow at a glance.
- Trimmed the deploy table and the static-mode feature comparison —
  details still in the workflow file and export script for anyone who
  wants them.

Net: -49 lines, much higher information density up top.

Note: this PR describes the state after #1, #2, #3 land. Merge after
those three.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@MrFullStackDev MrFullStackDev changed the title docs: README polish for portfolio use docs: README update May 2, 2026
@MrFullStackDev MrFullStackDev merged commit b23e2a8 into main May 2, 2026
7 checks passed
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