Simplify readme#901
Closed
meonkeys wants to merge 5 commits into
Closed
Conversation
Just a suggestion. I started this patch to fix the duplication of the words "creation and maintenance of software related to" and then ended up rewriting the whole thing, mostly based on the (IMHO better) wording I found at https://magpie.apache.org .
This is a readme, not an architecture showcase. I pared it down to more of a "quick start" type of doc. Lots of the text is duplicated in gory detail elsewhere in the docs / skills. "Public marketplace skill" didn't mean anything special to me so I went with just "in testing" (when I said "Testers welcome!"). I didn't find the unfamiliar "adoption" terminology helpful either. Culled, and replaced with the much more standard (IMHO) "install". If we really want to use new/nonstandard words, we should include a glossary. After making changes I ran doctoc. I used doctoc v2.5.0. fix apache#899
Member
|
please fix the prek/conflicts |
potiuk
added a commit
to potiuk/magpie
that referenced
this pull request
Jul 19, 2026
…l (adopt alias) Folds the top-level README simplification from apache#901 (by @meonkeys) into the 0.2.0 marketplace work, and shifts the primary term to 'install' now that marketplace installation exists: - Keeps Adam's simplified Install / Usage / Update / Skill-families structure. - Install section covers both paths: agent marketplace (easiest, nothing committed) and the committed snapshot via /magpie-setup. - 'install' is the primary verb/command; '/magpie-setup adopt' stays an alias; 'Adopt a Magpie' remains the landing-page slogan; 'adopter'/'adopter repo' kept as the ecosystem noun. - Repoints inbound doc links from the removed README#adopting-the-framework anchor to README#install and updates their labels. Supersedes the standalone apache#901 (its Fix apache#899 goal already merged via apache#905). Credit to @meonkeys for the simplification.
Member
|
Thanks @meonkeys — this simplification is a real improvement, and I've folded it into #907 (the 0.2.0 marketplace PR), where the README also gains the marketplace install path and leads with "install" (with "adopt" kept as an alias and "Adopt a Magpie" as the slogan). Your Install/Usage/Update structure is preserved. Since #899 (this PR's |
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
2 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
Fix #899.
This PR builds on #898. Please merge that one first, or if that one won't be merged just LMK and I'll rebase on
main. Because of this, the "Files changed" tab won't make sense. You can review only the changes for this PR at meonkeys@ba9bce0Type of change
.claude/skills/<name>/) — eval fixtures updated belowtools/<system>/*.md)tools/*/withpyproject.toml)docs/,README.md,CONTRIBUTING.md)projects/_template/)prek, workflows, validators)After making changes I ran doctoc. I used doctoc v2.5.0.
Test plan
not applicable
RFC-AI-0004 compliance
not applicable, AFAICT
Linked issues
None. This is a drive-by PR but I'll stick around to absorb feedback, discuss, improve, etc.
Notes for reviewers (optional)
I joined the
#magpieSlack channel in case you want to ping me in there. My handle ismeonkeysin there as well.