Handbook: generate screenshots with Playwright #140

Closed
opened 2026-11-06 09:59:46 +01:00 by miko · 1 comment
Owner

Part of #137
Depends on #138.

What

A Playwright pipeline that generates the handbook screenshots, so they can be regenerated after UI changes instead of being retaken by hand.

Decisions (from the #137 grilling)

  • Its own Playwright config/project, separate from the e2e suite (e.g. handbook/screenshots/ or e2e/handbook/); it reuses the e2e infrastructure where sensible.
  • Its own seed data that looks real, not like test data: e.g. a category tree with covers, a guide with several steps, photos with annotations in multiple colours, icon step lines, callouts.
  • Run manually via npm run handbook:screenshots, not as part of the test run.
  • PNGs are committed under handbook/, so the handbook build needs neither the app nor a database.
  • Light mode, English, fixed viewport only.

Acceptance criteria

  • npm run handbook:screenshots seeds, starts what it needs, captures and writes PNGs to a stable path in handbook/
  • Rerunning produces the same file names (stable, so markdown references don't break)
  • Initial set covers what the user handbook needs: guide reading view, guide editor, step with annotations, annotation drawing, category view, search; plus the admin views used by the administration handbook
  • Documented in the handbook's contributor notes (how and when to regenerate)
Part of #137 Depends on #138. ## What A Playwright pipeline that generates the handbook screenshots, so they can be regenerated after UI changes instead of being retaken by hand. ## Decisions (from the #137 grilling) - Its own Playwright config/project, separate from the e2e suite (e.g. `handbook/screenshots/` or `e2e/handbook/`); it reuses the e2e infrastructure where sensible. - **Its own seed data** that looks real, not like test data: e.g. a category tree with covers, a guide with several steps, photos with annotations in multiple colours, icon step lines, callouts. - Run **manually** via `npm run handbook:screenshots`, not as part of the test run. - PNGs are **committed** under `handbook/`, so the handbook build needs neither the app nor a database. - **Light mode, English, fixed viewport** only. ## Acceptance criteria - [ ] `npm run handbook:screenshots` seeds, starts what it needs, captures and writes PNGs to a stable path in `handbook/` - [ ] Rerunning produces the same file names (stable, so markdown references don't break) - [ ] Initial set covers what the user handbook needs: guide reading view, guide editor, step with annotations, annotation drawing, category view, search; plus the admin views used by the administration handbook - [ ] Documented in the handbook's contributor notes (how and when to regenerate)
Author
Owner

Implemented in #144: npm run handbook:screenshots seeds a makerspace example instance into kataba_e2e (as a backup, restored like one), builds and starts kataba on port 3200 and writes 30 PNGs to handbook/docs/assets/screenshots/ with stable names (light mode, English, 1280 × 800, Europe/Berlin). How and when to regenerate is in README › Handbook › Screenshots.

Implemented in #144: `npm run handbook:screenshots` seeds a makerspace example instance into kataba_e2e (as a backup, restored like one), builds and starts kataba on port 3200 and writes 30 PNGs to `handbook/docs/assets/screenshots/` with stable names (light mode, English, 1280 × 800, Europe/Berlin). How and when to regenerate is in README › Handbook › Screenshots.
miko closed this issue 2026-11-06 11:25:27 +01:00
Sign in to join this conversation.
No project
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
MassiveDynamic/kataba#140
No description provided.