Skip to content

Update PR review documentation for extensions migration#378

Draft
juanmichelini wants to merge 1 commit intomainfrom
update-pr-review-docs
Draft

Update PR review documentation for extensions migration#378
juanmichelini wants to merge 1 commit intomainfrom
update-pr-review-docs

Conversation

@juanmichelini
Copy link

This PR updates the PR review documentation to reflect the migration of PR review scripts from the SDK repository to the extensions repository.

Changes

Updated Files

1. openhands/usage/use-cases/code-review.mdx (Use Case Documentation)

  • Updated composite action description to reference extensions repository
  • Changed action input parameters from sdk-version/sdk-repo to extensions-version/extensions-repo
  • Updated workflow configuration examples
  • Added note about extensions repository containing the plugin scripts

2. sdk/guides/github-workflows/pr-review.mdx (SDK Workflow Documentation)

  • Updated reference workflow to use extensions-version parameter
  • Changed action inputs table to reflect new parameter names
  • Updated "Related Files" section to point to extensions repository:
    • Now links to the complete plugin in extensions repo
    • Updated agent_script.py and prompt.py links to extensions repo
    • Maintained links to workflow.yml and composite action in SDK repo

Summary of Changes

✅ All references to sdk-versionextensions-version
✅ All references to sdk-repoextensions-repo
✅ Updated file links to point to extensions repository
✅ Added clarification that scripts now live in extensions repo
✅ Maintained consistency across both documentation files

Related Issues

Closes #369
Related to OpenHands/software-agent-sdk#2282

Testing

The documentation now correctly:

  1. Instructs users to use extensions-version and extensions-repo parameters
  2. Links to the PR review plugin in the extensions repository
  3. Maintains the same workflow structure but with updated parameter names

- Update use-case documentation (code-review.mdx)
- Update SDK workflow documentation (pr-review.mdx)
- Change sdk-repo/sdk-version to extensions-repo/extensions-version
- Update related files links to point to extensions repository
- Remove references to deleted agent_script.py and prompt.py

Related to #369 and OpenHands/software-agent-sdk#2282

Co-authored-by: openhands <openhands@all-hands.dev>
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.

PR review plugin update docs on use-case and sdk workflow

2 participants