Screenshots
The rule
A screenshot exists to locate a control. A diagram exists to show a sequence or a decision. Nothing else gets a picture.A screenshot is justified when the reader has to find something on screen and prose cannot say where more cheaply than the picture can. “Select Add registry in the top right” needs no screenshot. A node editor, a gallery, or a panel with six controls does. A screenshot is not justified when it shows a filled-in form the prose already describes, a list of rows, a terminal prompt, or the page the reader is already looking at. Reference pages, concept pages, FAQ pages and plan or limits pages carry zero images. Where the subject is a flow or a decision, use a mermaid diagram instead. See the diagram standard in STYLE.md.
The current set
Three images, on three pages.
Eight images were removed in the docs overhaul. Each showed a filled-in form, a list of rows,
or a terminal prompt the surrounding prose already described.
repos/list.png was an orphan
referencing a console page that no longer exists.
Capturing
Shots are plain: no outlines, no numbered chips, no annotation. The annotation script was retired along with itssharp dependency.
Capture at 2x (device pixel ratio 2) or images look soft on retina. Playwright’s
screenshot({scale:'device'}) cannot do this on a 1x monitor; use raw CDP
Page.captureScreenshot with captureBeyondViewport: true and clip: {..., scale: 2}.
Before capturing:
- Strip the trial banner.
- Replace any personal email with
ben@slipway.sh. - Wake the demo app so statuses read live rather than sleeping.