phase 1 5 docs site

Incremental PRs can introduce subtle layout regressions (horizontal scroll, overlapping TOC, missing copy buttons) that unit tests miss. Playwright screenshot baselines on representative pages lock Matte Graphite across dark/light before production launch.

Milestone D.5.1 — Visual QA sweep

Status: Planned
Goal: D.5
Phase: 1.5 — Docs Site
Wave: 12
Estimated effort: 0.5 day
ADR required: None

Spec detail: MASTER_BRIEF.md Part D (D.5.1).


Why This Milestone Exists

Incremental PRs can introduce subtle layout regressions (horizontal scroll, overlapping TOC, missing copy buttons) that unit tests miss.

Playwright screenshot baselines on representative pages lock Matte Graphite across dark/light before production launch.

Manual sweep at 375/768/1440 catches issues automated tests omit.


Non-Goals

  • Visual testing for Go services
  • Percy or third-party visual SaaS
  • Full-page screenshot of every leaf (sample set only)

Branch

feat/d5-1-visual-qa

PR Title

test(docs): visual QA baseline (D.5.1)


Prerequisites


Deliverables

  • docs/app/tests/visual.spec.ts Playwright baseline
  • Sample paths: introduction, proxy/overview, api-reference
  • Dark + light toHaveScreenshot per path
  • Manual QA checklist fixes from sweep

See MASTER_BRIEF Part D (D.5.1) for full acceptance detail.


Files Affected

File PathActionNotes
docs/app/tests/visual.spec.tsAddScreenshot baseline tests
docs/app/playwright.config.tsAddPlaywright config

Testing Requirements

  • test_baseline_screenshot_dark: Introduction dark mode matches committed snapshot
  • test_baseline_screenshot_light: Introduction light mode matches committed snapshot
  • verifyVisual_NoHorizontalScroll: Manual check at 375px width

Acceptance Criteria

  • Baseline screenshots committed
  • CI runs playwright test on PRs touching docs/app/
  • Manual sweep finds no P0 layout bugs

Risks

RiskProbabilityImpactMitigation
Screenshot maintenance burden on token changeMediumMediumUpdate baselines only in D.2.2 or D.5.1 PRs
Font rendering differs CI vs localLowMediumRun Playwright in CI only for gate
Flaky animations break snapshotsLowLowDisable motion in test via prefers-reduced-motion
Edit on GitHub

Last updated on

On this page

0%