feat(skills): add pr-design-doc skill - #451
Open
smolpaws wants to merge 2 commits into
Open
Conversation
Add a skill that guides writing a self-contained HTML design doc for a non-trivial PR, committed under the temporary .pr/ directory and linked in the PR description via htmlpreview so maintainers see the code/API design and the before/after at a glance, grounded to real code. Adapted from the show-me visualization skill for the OpenHands PR-review workflow: focuses the craft on the .pr/ convention (auto-removed on approval) and the fork-branch htmlpreview link that renders before merge. Includes SKILL.md, README.md, references/html-craft.md, the generated command files and .plugin manifest/symlinks, and the marketplace + README catalog registration. sync_extensions.py --check passes. Co-authored-by: smolpaws <engel@enyst.org>
Point contributors at the frontend-design skill, if it helps, when building the design HTML page. Co-authored-by: smolpaws <engel@enyst.org>
Contributor
|
👋 This PR needs a couple of things fixed before OpenHands can review it:
Push an update once this is addressed and this check re-runs automatically. This is an automated check - no AI was used to generate this comment. |
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
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.
Why
Reviewers of a non-trivial PR often have to reconstruct the design from the diff alone — the shape of the change, the API before/after, and why this approach. That's slow and error-prone. This skill guides an agent to hand maintainers a single, self-contained HTML design doc they can grasp in ~15 seconds, grounded to real code.
It also operationalizes the
.pr/convention: the doc is committed under the temporary.pr/directory (auto-removed on approval bypr-artifacts.yml), and linked in the PR description via an htmlpreview URL that renders before the PR is merged.Companion guideline issue: OpenHands/OpenHands#16304.
Summary
pr-design-docskill (/pr-design-doc,/design-doc): when to use it (and when to skip — trivial PRs), the.pr/workflow, a step-by-step process, what the page contains (decision-first summary, API before/after, per-file before/after cards grounded topath:line), and anti-patterns.references/html-craft.md— the editorial look, hand-drawn before/after SVG technique, code-grounding discipline, and the htmlpreview delivery link (adapted so.pr/+ the fork/branch URL is the primary path).openhands-extensionsmarketplace + README catalog; add the.pluginmanifest, vendor symlinks, and generated command files viascripts/sync_extensions.py.Adapted from the
show-mevisualization skill, focused on the OpenHands PR-review workflow.Issue Number
Related: OpenHands/OpenHands#16304
How to Test
You can also read
skills/pr-design-doc/SKILL.mdand follow it against any non-trivial PR: it produces.pr/design.htmland an htmlpreview link of the shapehttps://htmlpreview.github.io/?https://github.com/<fork-owner>/<repo>/blob/<pr-branch>/.pr/design.html.Notes
.pr/auto-removal workflow lives inOpenHands/OpenHands; this skill documents relying on it.Co-authored-by: smolpaws engel@enyst.org