Skip to content

Update docs for combined code-review skill#455

Closed
xingyaoww wants to merge 1 commit intomainfrom
combine-code-review-skills
Closed

Update docs for combined code-review skill#455
xingyaoww wants to merge 1 commit intomainfrom
combine-code-review-skills

Conversation

@xingyaoww
Copy link
Copy Markdown
Contributor

Summary

The code-review and github-pr-review skills have been merged into a single code-review skill in the extensions repo. This PR updates documentation references accordingly.

Companion PR: OpenHands/extensions#173

Changes

openhands/usage/use-cases/code-review.mdx

  • Updated "Analysis" section to describe the combined skill instead of two separate skills
  • Fixed skill links to point to skills/code-review (was pointing to skills/codereview)
  • Updated review styles table with combined skill description
  • Marked review-style action input as deprecated

sdk/guides/github-workflows/pr-review.mdx

  • Added note that code-review skill now includes GitHub API posting instructions
  • Marked review-style action input as deprecated in action inputs table

This PR was created by an AI assistant (OpenHands) on behalf of the user.

The code-review and github-pr-review skills have been merged into a
single code-review skill in the extensions repo. Update documentation
references accordingly.

Changes:
- Update code review use case page: reflect combined skill, fix links
- Update SDK pr-review guide: note about combined skill, mark
  review-style as deprecated in action inputs table
- Mark review-style input as deprecated in both action input tables

Co-authored-by: openhands <openhands@all-hands.dev>
@xingyaoww xingyaoww requested review from enyst and mamoodi as code owners April 14, 2026 15:50
@mintlify
Copy link
Copy Markdown

mintlify bot commented Apr 14, 2026

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
all-hands-ai 🟢 Ready View Preview Apr 14, 2026, 3:51 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

Copy link
Copy Markdown
Contributor

@all-hands-bot all-hands-bot left a comment

Choose a reason for hiding this comment

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

Documentation changes accurately reflect the skill merger. Two minor suggestions for improved clarity.

| Style | Description | Best For |
|-------|-------------|----------|
| **Standard** ([`/codereview`](https://github.com/OpenHands/extensions/tree/main/skills/codereview)) | Pragmatic, constructive feedback focusing on code quality, security, and best practices | Day-to-day code reviews |
| **Standard** ([`/codereview`](https://github.com/OpenHands/extensions/tree/main/skills/code-review)) | Pragmatic, constructive feedback focusing on code quality, security, and best practices. Includes GitHub API posting instructions. | Day-to-day code reviews |
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.

🟡 Suggestion: The phrase "Includes GitHub API posting instructions." is an implementation detail that may confuse users. Both review styles will post to GitHub in practice (since the plugin loads both skill files), so this phrase suggests only the Standard style posts reviews, which isn't true.

Consider removing this phrase or rephrasing to clarify that all reviews are posted to GitHub regardless of style. The original description was already clear that it's a code review tool.

| `llm-model` | LLM model to use | Yes | - |
| `llm-base-url` | LLM base URL (for custom endpoints) | No | `''` |
| `review-style` | Review style: `standard` or `roasted` | No | `roasted` |
| `review-style` | **[Deprecated]** Review style: `standard` or `roasted`. Both styles now use the combined `code-review` skill. | No | `roasted` |
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.

🟡 Suggestion: The deprecation message "Both styles now use the combined code-review skill" is technically confusing since the roasted style still uses the codereview-roasted skill file. What's actually changed is that GitHub API posting is now built into the workflow, making this parameter redundant.

Consider clarifying: "[Deprecated] GitHub API posting is now built into both review styles, making this parameter redundant." This better explains WHY it's deprecated.

@xingyaoww xingyaoww closed this Apr 14, 2026
@xingyaoww xingyaoww deleted the combine-code-review-skills branch April 14, 2026 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants