Summary
Include output from the show-me skill in Patchmill's planning output so the
spec and plan get attached to the issue in a visual form. This helps
reviewers understand the spec and plan faster than reading prose alone.
Skill reference:
https://github.com/humanlayer/skills/tree/main/plugins/show-me/skills/show-me
Motivation
Reviewers must build a mental model of the spec and plan before they can
judge it. Diagrams, trees, and focused visuals give them that model directly
and shorten the review loop.
Proposal
- During planning, run the show-me skill over the spec and plan to produce
visual summaries (Mermaid diagrams, file or component trees, diffs, or a
focused HTML artifact).
- Attach the result to the GitHub issue alongside the spec and plan.
Explore: how to attach the output
GitHub issue bodies render Markdown but not raw HTML, so the attachment
mechanism needs a decision. Options to evaluate:
- Inline Mermaid in a comment or the issue body. GitHub renders Mermaid
natively; no artifacts to host. Covers diagrams but not HTML artifacts.
- Rendered images (PNG/SVG screenshots of diagrams or the HTML artifact)
uploaded as issue assets. Visible inline; loses interactivity.
- HTML file upload as an issue attachment. Preserves the artifact but
reviewers must download and open it locally; GitHub serves uploads as
downloads, not rendered pages.
- Gist or external host for the HTML, linked from the issue. Renders in
the browser but adds an external dependency and permissions surface.
- Committed artifact in the repo (for example under
docs/), linked from
the issue. Reviewable in the PR; less immediate for issue-only reviewers.
The issue should pick a primary mechanism (and a fallback) based on what
reviewers actually need to see.
Acceptance criteria
- Planning output includes a show-me visualization of the spec and plan.
- The visualization is attached to the issue through a chosen mechanism that
works for HTML artifacts, with the trade-offs of the alternatives recorded.
- Reviewers can view the visualization without local tooling.
Summary
Include output from the show-me skill in Patchmill's planning output so the
spec and plan get attached to the issue in a visual form. This helps
reviewers understand the spec and plan faster than reading prose alone.
Skill reference:
https://github.com/humanlayer/skills/tree/main/plugins/show-me/skills/show-me
Motivation
Reviewers must build a mental model of the spec and plan before they can
judge it. Diagrams, trees, and focused visuals give them that model directly
and shorten the review loop.
Proposal
visual summaries (Mermaid diagrams, file or component trees, diffs, or a
focused HTML artifact).
Explore: how to attach the output
GitHub issue bodies render Markdown but not raw HTML, so the attachment
mechanism needs a decision. Options to evaluate:
natively; no artifacts to host. Covers diagrams but not HTML artifacts.
uploaded as issue assets. Visible inline; loses interactivity.
reviewers must download and open it locally; GitHub serves uploads as
downloads, not rendered pages.
the browser but adds an external dependency and permissions surface.
docs/), linked fromthe issue. Reviewable in the PR; less immediate for issue-only reviewers.
The issue should pick a primary mechanism (and a fallback) based on what
reviewers actually need to see.
Acceptance criteria
works for HTML artifacts, with the trade-offs of the alternatives recorded.