Screenshot capture plan
Runs after the doc text is written and coverage-checked, so image and prose agree. Captured with Playwright against local sites, never from a live customer site.
Two sites, two jobs
Section titled “Two sites, two jobs”| Site | Used for | State |
|---|---|---|
reign-release.local:10058 |
Admin captures: Reign Settings, the Customizer, panels and sections | Reign 8.0.6, branch 8.0.6. Ready. |
buddynext-model.local |
Frontend captures: member screens, directories, blog, header and footer in use | Reign 8.0.4 with a reign-child child theme. Needs updating to 8.0.6 before capture. |
The version gap matters. A frontend screenshot taken on 8.0.4 documents a build the reader does not have, which is the exact failure the old corpus had. Update the model site first.
The model site is the right source for frontend shots because it carries real content. Never screenshot an empty state: a member directory with no members or a feed with no posts teaches nothing and looks unfinished.
- Light mode, default palette, unless the doc is specifically about dark mode or palettes. Consistency across the set matters more than variety.
- Crop to the subject. A full 1440px browser window to show one toggle wastes the reader’s attention. Crop to the panel or the component.
- Desktop at 1440 wide for admin. Frontend gets 1440 and 390 where the doc discusses mobile behaviour, which the header and mobile-menu docs do.
- No personal data. The model site’s demo members are fine. Check for real email addresses, real names outside the demo set, and licence keys before saving any admin shot.
- Redact the licence key in any capture of Reign Settings > License.
- Save as PNG to
docs/website/images/<section>/<doc-slug>-<n>.png. - Reference in markdown with alt text that describes the setting, not the
image:
.
What to capture
Section titled “What to capture”Driven by the docs actually written, so the list is finalised after the coverage check. Expected shape:
Admin, from reign-release.local
Section titled “Admin, from reign-release.local”- Reign Settings Home, with the Brand your site checklist
- Reign Settings Design, Community empty state, Integrations, Extend, Tools
- Reign Settings License, key redacted
- Customizer root, showing the eight Reign panels
- One capture per documented section that has a non-obvious layout: Left Panel, Sticky Menu, Colour Palette, Light and Dark Mode, Font Presets, Forms, Content Layouts, Page Mapping, Branded Login
Frontend, from buddynext-model.local
Section titled “Frontend, from buddynext-model.local”- Header variants, desktop and 390
- Left panel open
- Sticky menu, mid-scroll
- Member directory, group directory, single member
- Blog archive grid and single post
- Footer
- Light and dark side by side, for the dark mode doc
- Update the model site to 8.0.6.
- Confirm both sites are on 8.0.6 and note it here.
- Capture admin, then frontend.
- Insert into the docs and re-run the link and style checks.