docs: Add multiple marketplace registrations section to plugins guide#406
Draft
jpshackelford wants to merge 1 commit intomainfrom
Draft
docs: Add multiple marketplace registrations section to plugins guide#406jpshackelford wants to merge 1 commit intomainfrom
jpshackelford wants to merge 1 commit intomainfrom
Conversation
- Document auto_load strategies (auto-load vs on-demand) - Explain plugin@marketplace reference syntax (matches Claude Code) - Add expandable example code block - Include MarketplaceRegistration field reference table Related: OpenHands/software-agent-sdk#2495
Contributor
all-hands-bot
left a comment
all-hands-bot
left a comment
There was a problem hiding this comment.
🟢 Good taste - Accurate documentation verified against SDK source. The feature is pragmatic, examples are real and will auto-sync, and structure is clear. Two minor wording refinements suggested below to match source code exactly.
| | Field | Type | Description | | ||
| |-------|------|-------------| | ||
| | `name` | `str` | Identifier for this marketplace registration | | ||
| | `source` | `str` | Plugin source: `github:owner/repo`, git URL, or local path | |
Contributor
There was a problem hiding this comment.
🟡 Suggestion: Change "Plugin source" to "Marketplace source" to match the actual field description in the SDK code.
Suggested change
| | `source` | `str` | Plugin source: `github:owner/repo`, git URL, or local path | | |
| | `source` | `str` | Marketplace source: `github:owner/repo`, git URL, or local path | |
| |-------|------|-------------| | ||
| | `name` | `str` | Identifier for this marketplace registration | | ||
| | `source` | `str` | Plugin source: `github:owner/repo`, git URL, or local path | | ||
| | `ref` | `str \| None` | Optional branch, tag, or commit for the marketplace repo | |
Contributor
There was a problem hiding this comment.
🟡 Suggestion: Clarify that ref only applies to git sources (not local paths) to match the SDK field description.
Suggested change
| | `ref` | `str \| None` | Optional branch, tag, or commit for the marketplace repo | | |
| | `ref` | `str \| None` | Optional branch, tag, or commit (only for git sources) | |
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
Documents the new multiple marketplace registrations feature added in OpenHands/software-agent-sdk#2495.
Changes
Adds a new "Multiple Marketplace Registrations" section to
sdk/guides/plugins.mdxthat covers:auto_load="all"vsauto_load=None(on-demand)plugin-name@marketplace-nameformat (matches Claude Code's plugin syntax)Related