docs: document the extension model + allow external/own-repo organizations#638
Merged
Conversation
…tions Make "external / own-repo" a first-class home for organizations (as it already is for adapters), and add one guide explaining every way Magpie can be extended. - docs/extending.md (new): what you can extend (skill, tool/adapter, capability contract, organization, project config, user config), the three homes each can live in (in-tree / your adopter repo / external repo) with a trade-off table, and who typically owns each (project / organization / individual). Reiterates discovery-not-installation (§13). - AGENTS.md: the organization resolution order now includes an adopter-local / external org home — `.apache-magpie-overrides/organizations/<org>/` — so `organization:` need not name an in-tree org. - organizations/README.md: new "three homes" note for an organization (in-tree / adopter repo / org's own repo) + the resolution order. - docs/adapters/authoring.md: "two homes" → "three homes" (adds the adopter-repo override home) for consistency. - Wire-in: docs/index.md "Extend Magpie" row; vendor-neutrality + adapter registry link the new guide. Generated-by: Claude Code (Opus 4.8)
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
1 participant
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.
What
Makes external / own-repo a first-class home for organizations (it
already was for adapters), and adds one guide explaining every way Magpie
can be extended.
New:
docs/extending.mdThe map of extensibility:
organization, project config, user config.
your adopter repo (
.apache-magpie-overrides/) / an external repo —with a trade-off table (travels-with, licence, best-when).
Convention change
AGENTS.md— the organization resolution order now includes anadopter-local / external home:
project.md → organizations/<org>/ (in-tree) → .apache-magpie-overrides/organizations/<org>/ (adopter-local/external) → framework default. Soorganization:need not name an in-treeorg — you can keep your org adapter in your repo or vendor it from the
org's own repo.
Consistency + wiring
organizations/README.md— "three homes" note for an organization +resolution order.
docs/adapters/authoring.md— "two homes" → "three homes" (adds theadopter-repo override home).
docs/index.mdgains an "Extend Magpie" row;vendor-neutrality.mdand the adapter registry link the new guide.
Verification
doctoc, markdownlint, lychee (all links/anchors resolve), placeholder
check — green. No skill/tool/validator changes (the org resolution is a
runtime contract agents follow; adopter-local orgs live in adopter repos,
not validated by the framework validator).
🤖 Generated with Claude Code