docs: Update code review documentation with PR review workflow

[xingyaoww]

• I have read and reviewed the documentation changes to the best of my ability.
• If the change is significant, I have run the documentation site locally and confirmed it renders as expected.

Summary of changes

This PR completely rewrites the code review documentation page (openhands/usage/use-cases/code-review.mdx) to document the automated PR review workflow powered by the OpenHands Software Agent SDK.

Changes

High-Level Overview

• Explains how the PR review workflow works using the Software Agent SDK
• Documents the two skills used: /codereview (or /codereview-roasted) for code analysis and /github-pr-review for posting inline comments

How to Use

• Added a comprehensive Quick Start guide with step-by-step setup instructions
• Explains the two trigger methods: review-this label and requesting openhands-agent as reviewer

Customization

• Documents how to create repo-specific review guidelines via .openhands/skills/code-review.md with /codereview trigger
• Shows how to modify the workflow for different triggers, review styles, and LLM configurations

Additional Sections

• Security considerations for handling fork PRs
• What gets reviewed (code quality, security, best practices)
• Example review output showing priority labels and suggestion syntax
• Troubleshooting guide

Closes #297

@xingyaoww can click here to continue refining the PR

[xingyaoww]

@OpenHands please review the diff of this PR, and this PR: OpenHands/software-agent-sdk#1927

Now the SDK supports the new composed github action, can you update the documentation we add in this PR accordingly?

[openhands-ai]

I'm on it! xingyaoww can track my progress at all-hands.dev

[openhands-ai]

I've updated the code review documentation to reflect the new composite GitHub Action from software-agent-sdk PR #1927. The changes have been pushed to the openhands/update-code-review-docs branch.

Summary of Changes

File modified: openhands/usage/use-cases/code-review.mdx

Key Updates:

1. Simplified Quick Start workflow - Replaced the verbose 50+ line workflow with a simple 8-line configuration using the new composite action:

   - name: Run PR Review
     uses: OpenHands/software-agent-sdk/.github/actions/pr-review@main
     with:
       llm-model: anthropic/claude-sonnet-4-5-20250929
       review-style: standard
       llm-api-key: ${{ secrets.LLM_API_KEY }}
       github-token: ${{ secrets.GITHUB_TOKEN }}

2. Added new "Composite Action" section - Documents what the composite action handles automatically and includes a complete action inputs table with all 7 inputs (llm-model, llm-base-url, review-style, sdk-version, sdk-repo, llm-api-key, github-token)

3. Updated Customization section - Changed from env variable configuration to the new input-based configuration style

4. Removed manual setup steps - The composite action now handles Python setup, uv installation, dependency installation, and log artifact uploads automatically

The documentation is now much simpler for users to follow while still providing all the customization options through the action inputs.

View full conversation

[xingyaoww]

@OpenHands please fix the failing actions on PR #302 at branch openhands/update-code-review-docs

[openhands-ai]

I'm on it! xingyaoww can track my progress at all-hands.dev

[openhands-ai]

I've fixed the failing GitHub Actions on PR #302 by removing a broken link.

Summary of Changes

File modified: openhands/usage/use-cases/dependency-upgrades.mdx

Issue: The "Check Broken Links" GitHub Action was failing because the file contained a link to /openhands/usage/admin/security, which is a non-existent page.

Fix: Removed the broken link from the "Related Resources" section. The link was:

- [Security](/openhands/usage/admin/security) - Security best practices

The remaining related resources (Vulnerability Remediation and Prompting Best Practices) are still present and link to valid pages.

Verification: Ran mint broken-links locally and confirmed no broken links remain.

Commit: b76480e - "fix: Remove broken link to non-existent security page"

The changes have been pushed to the openhands/update-code-review-docs branch and the GitHub Actions should now pass.

View full conversation

[xingyaoww]

@OpenHands pls bring changes introduced in #306 to this PR

[openhands-ai]

I'm on it! xingyaoww can track my progress at all-hands.dev

[openhands-ai]

I've successfully brought the changes from PR #306 to this PR. The changes have been pushed to the openhands/update-code-review-docs branch.

Summary of Changes

File modified: sdk/guides/github-workflows/pr-review.mdx

Key Updates from PR #306:

1. Added "Customizable" feature - New bullet point in Features section highlighting the ability to add custom code review guidelines without forking

2. New "Customizing the Code Review" section including:

   • How custom skills work (overriding default skills from OpenHands/skills)
   • Example custom code review skill with complete markdown template
   • Benefits of custom skills (no forking, version controlled, easy updates, team alignment)
   • Link to software-agent-sdk's own code-review skill as reference

3. Updated Reference Workflow - Simplified from ~50 lines to ~20 lines using the new composite action:

   • Uses OpenHands/software-agent-sdk/.github/actions/pr-review composite action
   • Cleaner configuration with named inputs
   • Updated comments with more information

4. Added Action Inputs table - Documents all available inputs for the composite action (llm-model, llm-base-url, review-style, sdk-version, sdk-repo, llm-api-key, github-token)

5. Added Composite Action link - New entry in Related Files section pointing to the composite action

The changes are now live on PR #302.

View full conversation

[openhands-ai]

Looks like there are a few issues preventing this PR from being merged!

• GitHub Actions are failing:
  • .github/workflows/sync-docs-code-blocks.yml
  • .github/workflows/sync-agent-sdk-openapi.yml

If you'd like me to help, just leave a comment, like

@OpenHands please fix the failing actions on PR #302 at branch `openhands/update-code-review-docs`

Feel free to include any additional details that might help me get this PR into a better state.

_{^{You can manage your notification settings}}

[enyst]

Was this intended, to be only on Joe's branch?

Of course we can move forward anyway, just wondering since this is probably compatible with main as far as I can tell

[xingyaoww]

@enyst yep! looks like we can merge to main

[xingyaoww]

My bad :(

Looks like this PR also included a bunch of changes from Joe's PR that's probably not yet ready -- trying to revert unnecessary ones in #311