Update docs for merged code-review skill#456
Conversation
Companion to OpenHands/extensions PR that merges code-review and codereview-roasted into a single unified skill. Changes: - code-review.mdx: Removed 'Review Styles' section, updated skill link, marked review-style input as deprecated in all tables/examples - pr-review.mdx: Deprecated review-style in workflow example and inputs table - pr-review-by-openhands.yml: Commented out review-style usage Co-authored-by: openhands <openhands@all-hands.dev>
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🔴 Needs rework - You updated the uses: paths in YAML examples but missed the documentation links pointing to the old action source code. These will 404.
CRITICAL ISSUES:
-
Broken documentation links: Three files still link to
software-agent-sdk/.github/actions/pr-review/action.ymlwhich no longer exists:openhands/usage/use-cases/code-review.mdxline 260openhands/usage/essential-guidelines/sdlc-integration.mdxline 129sdk/guides/github-workflows/pr-review.mdxline 196
These should point to
OpenHands/extensions/blob/main/plugins/pr-review/action.yml -
Stale workflow reference: Line 259 of
code-review.mdxstill points to the old SDK examples path. Should verify if that's still valid or if it should point toextensions/plugins/pr-review/workflows/
WHAT YOU DID RIGHT:
- ✅ Skill links correctly updated to
code-review - ✅ Review-style properly marked as deprecated
- ✅ YAML example paths updated
- ✅ Changes match upstream PR (OpenHands/extensions#175)
KEY INSIGHT: If you're migrating action paths, migrate ALL references (both YAML uses: and documentation links), not just some.
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
Update all '/codereview' references to '/code-review' in docs, examples, and code snippets to match the canonical trigger name. Companion to OpenHands/extensions PR #175. Co-authored-by: openhands <openhands@all-hands.dev>
Use /codereview (no hyphen) as the canonical trigger in all docs, examples, and code snippets. Directory/path references remain 'code-review'. Companion to OpenHands/extensions PR #175. Co-authored-by: openhands <openhands@all-hands.dev>
Update links that still pointed to software-agent-sdk/.github/actions/pr-review to point to the new location at OpenHands/extensions/plugins/pr-review. Addresses review feedback from all-hands-bot. Co-authored-by: openhands <openhands@all-hands.dev>
xingyaoww
dismissed
all-hands-bot’s stale review
All issues addressed in commit 4aa988c. All review threads resolved.
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Textbook deprecation: backward compatible, clearly documented, all links verified.
KEY INSIGHT: You correctly maintained the parameter for backward compatibility while clearly marking it deprecated. This is exactly how to evolve an API without breaking userspace. Verified all file paths against the upstream PR branch—everything checks out.
| @@ -122,7 +112,7 @@ The workflow uses a reusable composite action from the Software Agent SDK that h | |||
| |-------|-------------|----------|---------| | |||
There was a problem hiding this comment.
🟢 Acceptable - Pragmatic deprecation strategy. The parameter is kept for backward compatibility, ignored in code, and clearly documented. This is the right way to handle breaking changes without actually breaking anything.
|
|
||
| 2. **Analysis**: The agent receives the complete PR diff and uses two skills: | ||
| - [**`/codereview`**](https://github.com/OpenHands/extensions/tree/main/skills/codereview) or [**`/codereview-roasted`**](https://github.com/OpenHands/extensions/tree/main/skills/codereview-roasted): Analyzes code for quality, security, and best practices | ||
| - [**`/codereview`**](https://github.com/OpenHands/extensions/tree/main/skills/code-review): Analyzes code for quality, security, data structures, and best practices with a focus on simplicity and pragmatism |
There was a problem hiding this comment.
🟢 Good taste - Verified this description matches the merged skill in extensions#175. The unified skill now handles both review styles with triggers /codereview and /codereview-roasted, focusing on data structures, simplicity, security, and pragmatism.
3 participants
Summary
Companion to OpenHands/extensions#175 which merges the
code-reviewandcodereview-roastedskills into a single unified skill.Changes
openhands/usage/use-cases/code-review.mdx: Removed 'Review Styles' section, updated skill link to point tocode-review, markedreview-styleinput as deprecated in inputs table and examples, updated workflow YAML examples to useOpenHands/extensions/plugins/pr-review@mainsdk/guides/github-workflows/pr-review.mdx: Deprecatedreview-stylein workflow example and inputs table.github/workflows/pr-review-by-openhands.yml: Commented outreview-styleusageThis PR was created by an AI assistant (OpenHands) on behalf of the user.