docs(sdk): document local plugin install example#367
Conversation
Co-authored-by: openhands <openhands@all-hands.dev>
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
Taste Rating: 🟡 Acceptable - Works but violates focused documentation principles
The fundamental issue: this example is a comprehensive integration test masquerading as a user tutorial. It demonstrates install, list, load, get, update, uninstall, AND a full conversation with persistence - all in 165 lines. That's not documentation, that's a feature test.
Verdict: ✅ Worth merging with improvements - The code is correct and follows sync patterns, but needs focused examples and explanatory prose to actually help users.
Key Insight: Documentation examples should demonstrate one thing well, not everything at once.
- Update Ready-to-run Example with current 02_loading_plugins/main.py code - Add succinct 'Installing Plugins to Persistent Storage' section - Remove reference to non-existent 03_local_plugin_install example Co-authored-by: openhands <openhands@all-hands.dev>
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
Taste Rating: 🟡 Acceptable - Source-verified and correct, but architectural preference issues remain
Source Verification: ✅ All imports, function signatures, and example paths verified against OpenHands/software-agent-sdk main branch.
Verdict: ✅ Worth merging - Previous critical issues (artifact mode, missing explanations) were addressed. The multi-demo structure is acceptable, though a few clarity improvements would help users navigate the 5 different demos.
|
|
||
| ## Ready-to-run Example | ||
|
|
||
| The example below demonstrates plugin loading via Conversation and plugin management utilities (install, list, update, uninstall). |
There was a problem hiding this comment.
🟡 Suggestion: Misleading section title - says "Example" (singular) but contains 5 separate demos.
Why it matters: Users scanning the docs expect one focused example here. The plural "Ready-to-run Examples" or "Comprehensive Plugin Examples" would set better expectations.
Quick fix:
| The example below demonstrates plugin loading via Conversation and plugin management utilities (install, list, update, uninstall). | |
| ## Ready-to-run Examples |
4 participants
Documents the new example introduced in OpenHands/software-agent-sdk#2031 (examples/05_skills_and_plugins/03_local_plugin_install/main.py) by extending the Plugins guide.
This branch name intentionally matches the agent-sdk PR branch so the agent-sdk CI workflow '[Optional] Docs example' can checkout the docs changes.