Files

37 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

# Screenshot payloads
Each JSON file here stages one web console screen for the docs, with no agent
involved. `node scripts/capture-screenshots.mjs` opens a console session in a
throwaway sample project, posts these files, and saves the screens as light
and dark WebP images in `docs/screenshots/`.
| File | Stages |
| --- | --- |
| `dashboard.json` | The dashboard menu, suggesting the next build phase |
| `dashboard-plan.json` | The dashboard in a project with no specs yet, suggesting Plan (the script builds that project) |
| `question.json` | A Plan session with three questions open (also the base of the Ask shot) |
| `doc.json` | A living document with settled, assumed and draft sections, and its review card |
| `build.json` | A phase being built: the progress bar, the task list and the current task |
| `signoff.json` | The completion report and the sign-off card |
| `finish.json` | The finished screen after sign-off (posted after `signoff.json`) |
| `git.json` | The git board, handed back to you in a sample repository with three changes to commit (the script builds the repository) |
Refresh every image with `node scripts/capture-screenshots.mjs`, or one with
`--only <shot>`.
## Comparison-only shots
`--compare` adds the screens the docs never show, so a change to the console
can be checked by eye against a "before" set. They are never published: the
script refuses `--compare` with an `--out` inside `docs/screenshots/`.
| File | Stages |
| --- | --- |
| `stop.json` | A build with a question open, behind the Stop dialog and its handoff choice |
| `delete.json` | The dashboard, behind the first step of a spec chip's Delete |
| `help.json` | A Plan question, behind Help on its first tab |
| `prefs.json` | A Plan question, behind User Preferences |
| `cleanup.json` | A Plan question, behind User Preferences on the System tab after a Cleanup scan |
| `workspace.json` | A Plan question, behind the Workspace panel with a second folder added (shot last: the console remembers the folder) |
`node scripts/capture-screenshots.mjs --compare --out <folder outside the repo>`