docs: describe the agent-driven user guide sweep and add screenshot utilities - #5721
Draft
awwaiid wants to merge 2 commits into
Draft
docs: describe the agent-driven user guide sweep and add screenshot utilities#5721awwaiid wants to merge 2 commits into
awwaiid wants to merge 2 commits into
Conversation
…tilities Adds docs/agentic_update.md, a write-up of the process used in September 2026 to document a batch of merged PRs and refresh every page of the bank user guide, plus the reusable pieces under docs/utils/: - utils/screenshots/shot.tmpl.js + mkshot.py: spec-driven Playwright helper that logs in, stages the page, grows the viewport, draws the red boxes and numbered labels after the resize, and crops. - utils/screenshots/example_spec.json and README.md: spec format, conventions and the gotchas hit along the way (no fullPage, modals, select2, sidebar dropdown headers, seed state). - utils/check_guide_images.sh: reports image references with no file and image files nothing references. Also ignores .playwright-mcp/, the Playwright MCP plugin's scratch directory. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LMAt57FU2qBq45yR7YCsEZ
awwaiid
commented
Sep 6, 2026
| @@ -0,0 +1,62 @@ | |||
| #!/usr/bin/env python3 | |||
Collaborator
Author
There was a problem hiding this comment.
Please switch this to a shell script or ruby so that we don't add python as a dependency.
Collaborator
Author
There was a problem hiding this comment.
Done in 052b7fc: replaced mkshot.py with a Ruby script at docs/utils/screenshots/mkshot (stdlib only: json, optparse, fileutils). Same options and output; README and template comments updated. Verified it generates a working snippet against the local app.
Review asked not to add Python as a dependency. Same behaviour: inlines the JSON spec into shot.tmpl.js, resolves relative output paths from the repo root, writes .playwright-mcp/run.js by default. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LMAt57FU2qBq45yR7YCsEZ
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Writes down the process used for the September 2026 user-guide sweep (documenting #5386, #5674, #5686, #5692, #5681, #5604, #5606, then refreshing every page's text and screenshots, then splitting into #5708–#5720) so the next sweep is faster and lands in the same style. Extracts the reusable tooling into
docs/utils/.docs/agentic_update.md— the method: setup, scoping feature PRs, building the burn-down list, the per-page review loop, verification, splitting into stacked PRs, responding to review, and a checklist for the kickoff prompt.docs/utils/screenshots/— spec-driven Playwright helper for annotated screenshots (shot.tmpl.js,mkshot.py,example_spec.json) and a README with the spec format, style conventions and gotchas.docs/utils/check_guide_images.sh— reports markdown image references with no file and image files nothing references. (Run againstmaintoday it lists 2 missing and 15 orphans, all fixed in User guide: fix typos, broken links and stale labels #5709 / User guide: refresh Getting Started and Everyday Essentials screenshots #5717.).gitignore— ignores.playwright-mcp/, the Playwright MCP plugin's scratch directory.Notes for review
🤖 Generated with Claude Code
https://claude.ai/code/session_01LMAt57FU2qBq45yR7YCsEZ