docs(sdk): sync plugin and skill lifecycle examples#386
Open
Conversation
Co-authored-by: openhands <openhands@all-hands.dev>
5 tasks
all-hands-bot
approved these changes
Mar 9, 2026
Contributor
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Clean documentation sync that accurately reflects SDK lifecycle APIs.
Verification completed:
- ✅ Cloned SDK repo (
openhands/issue-2339-skill-plugin-lifecycle-docsbranch) - ✅ All referenced example files exist and match documented content
- ✅ API imports verified against SDK source (
openhands.sdk.plugin,openhands.sdk.skills) - ✅ Auto-sync format correct for all code blocks
- ✅ Examples include assertions that prove behavior (not just mocks)
Observations:
- The sync script detected drift in 4 unrelated files (agent-delegation, agent-file-based, agent-acp, browser-session-recording) but did NOT modify plugins.mdx or skill.mdx, confirming this PR is properly synced
- The unrelated drift should be addressed in a separate PR
Why this is good:
- Solves real problem: Documents lifecycle APIs needed by CLI for
/plugin enable,/plugin disable,/skill enable,/skill disable,/skill uninstall - Simple and complete: Each example is self-contained, runnable, and includes verification assertions
- Maintainable: Auto-sync setup ensures docs stay current with SDK changes
- No breaking changes: Pure documentation enhancement
Ship it. 🚢
- document the plugin lifecycle in the consolidated loading example - replace split skill lifecycle docs with one installed-skills example Co-authored-by: openhands <openhands@all-hands.dev>
- document the mixed marketplace skills example in the skill guide - satisfy the documented-examples check for existing SDK examples Co-authored-by: openhands <openhands@all-hands.dev>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary of changes
02_loading_pluginsexample, including the installed plugin lifecycle (enabledflag, enable/disable, uninstall)03_managing_installed_skills.github/scripts/sync_code_blocks.pyon the matchingopenhands/issue-2339-skill-plugin-lifecycle-docsbranchRelated SDK issue: OpenHands/software-agent-sdk#2339
Companion SDK PR: OpenHands/software-agent-sdk#2362
Related CLI tracking: OpenHands/OpenHands-CLI#405 and OpenHands/OpenHands-CLI#582