-
Notifications
You must be signed in to change notification settings - Fork 6
Add documentation for skill packages #197
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add documentation for skill packages #197
Conversation
This adds comprehensive documentation for the new skill packages feature, covering installation, loading, configuration, and package creation. Related to: OpenHands/software-agent-sdk#1399 Co-authored-by: openhands <openhands@all-hands.dev>
sdk/guides/skill-packages.mdx
Outdated
|
|
||
| Prerequisites: | ||
| 1. Install a skill package: | ||
| pip install openhands-simple-code-review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to recommend pip, or maybe we should stick to uv?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Definitely stick to uv.
sdk/guides/skill-packages.mdx
Outdated
| 3. Or use the package loading functions directly in code. | ||
|
|
||
| For more information on creating skill packages, see: | ||
| https://github.com/OpenHands/package-poc |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this repository is super-secret 😅
404 here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oops. That repo is being carved up with its parts landing in our existing public projects so that reference shouldn't be there for sure.
…o references - Changed all pip install commands to uv pip install - Removed references to private OpenHands/package-poc repository Co-authored-by: openhands <openhands@all-hands.dev>
|
✅ Review comments addressed:
Changes were made in both the auto-synced code block and the documentation sections outside it. |
|
📝 Note: The changes in the auto-synced code block (lines 12-256) will need the corresponding source file updated:
The same changes should be made there:
This will ensure the changes persist when the code sync workflow runs. |
This PR adds comprehensive documentation for the new skill packages feature introduced in the Agent SDK.
Changes
Related PRs
This documentation resolves the failing check in PR #1399 which requires all examples to be documented.