Skip to content

Fix doc screenshots skill Markdown - #4239

Merged
ashfame merged 3 commits into
trunkfrom
agent/fix-doc-screenshots-skill-markdown
Aug 6, 2026
Merged

Fix doc screenshots skill Markdown#4239
ashfame merged 3 commits into
trunkfrom
agent/fix-doc-screenshots-skill-markdown

Conversation

@ashfame

@ashfame ashfame commented Aug 3, 2026

Copy link
Copy Markdown
Member

What

Repair malformed Markdown in the doc-screenshots skill's Workflow section so its instructions render correctly and commands remain copyable. Additionally, remove the line wrapping from other lines to be consistent in raw form.

Problems fixed

  • Fenced JavaScript and shell examples were over-indented inside numbered list items, causing them to be parsed as malformed nested content instead of normal fenced code blocks.
  • The Playwright installation command was split by a blank line across separate Markdown paragraphs.
  • The virtual-environment and Pillow installation command was also split across paragraphs.
  • Inline code lacked required surrounding spacing, producing text such as `config error:`message and `output` must be a`.webp`.

What was not the issue

Ordinary prose wrapping was not the underlying bug, and skill files are not categorically forbidden from containing wrapped prose. The edited paragraphs are kept unwrapped to follow this repository's Markdown convention, but the functional problem was malformed Markdown structure and broken commands.

Impact

This changes only the skill instructions. The annotation script, examples, and runtime behavior are unchanged.

Checks

  • quick_validate.py .agents/skills/doc-screenshots
  • prettier --check .agents/skills/doc-screenshots/SKILL.md
  • git diff --check

Created screenshots

Screenshot 2026-08-03 at 18 09 49

@github-actions github-actions Bot added the [Type] Documentation Improvements or additions to documentation label Aug 3, 2026
@ashfame
ashfame requested a review from Copilot August 3, 2026 13:38

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Note

Copilot was unable to run its full agentic suite in this review.

Repairs the doc-screenshots skill’s Workflow Markdown so nested fenced code blocks and setup commands render and copy/paste correctly.

Changes:

  • Re-formatted numbered workflow steps to avoid malformed nested Markdown around fenced code blocks.
  • Consolidated previously wrapped paragraphs/commands to preserve spacing and inline-code integrity.
  • Tweaked the Playwright snippet for clarity (factor viewport into a variable).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .agents/skills/doc-screenshots/SKILL.md Outdated

**WordPress modals:** Editor screens open welcome guides ("Edit your site" → Get started) whose overlay swallows clicks; some have no `aria-label="Close"` button. Dismiss with an Escape loop — while `.components-modal__screen-overlay` exists, press Escape on the frame's body, wait ~1s — and retry the blocked click between attempts. The modal can appear _after_ the page looks loaded, so dismiss lazily around the click, not once up front.

Prefer driving the browser from Node with the repo's own `node_modules/playwright`; otherwise run `pip install playwright && playwright install chromium`, or use the Chrome DevTools MCP capture tools.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in 37b1bf6: the fallback now invokes both pip and Playwright through python3 -m ..., so the browser installation is bound to the same Python environment.

Comment thread .agents/skills/doc-screenshots/SKILL.md Outdated
python .agents/skills/doc-screenshots/scripts/annotate.py config.json --crops crops/
```

The script needs Python with Pillow. If no suitable interpreter is active, create a virtual environment in the session scratchpad with `python3 -m venv <scratchpad>/venv && <scratchpad>/venv/bin/pip install Pillow`, then call that interpreter directly. The script validates the config up front and exits with a readable `config error:` message on bad input; `output` must be a `.webp` path.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated in 37b1bf6: the virtual-environment setup now uses <scratchpad>/venv/bin/python -m pip install Pillow, explicitly binding pip to that interpreter.

@ashfame
ashfame marked this pull request as ready for review August 3, 2026 14:49
@ashfame
ashfame requested a review from fellyph August 3, 2026 14:50
@ashfame

ashfame commented Aug 3, 2026

Copy link
Copy Markdown
Member Author

@fellyph This got flagged while working on something so fixed it. After fixing, I tested it and it still works as expected. Screenshot attached in PR description.

@fellyph fellyph left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ashfame I tested locally and LGTM!

@ashfame
ashfame merged commit e66b21d into trunk Aug 6, 2026
56 checks passed
@ashfame
ashfame deleted the agent/fix-doc-screenshots-skill-markdown branch August 6, 2026 10:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

[Type] Documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants