docs: extract installation guide from README into docs/installation/ - #27
Merged
Khelan Modi (khelanmodi) merged 1 commit intoJun 3, 2026
Conversation
Signed-off-by: Rayhan Hossain <hossain.rayhan@outlook.com>
Khelan Modi (khelanmodi)
self-requested a review
June 3, 2026 22:08
Khelan Modi (khelanmodi)
approved these changes
Jun 3, 2026
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
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
The
README.mdhad grown to ~350 lines, with ~300 of those dedicated to install/uninstall/troubleshooting content. This PR extracts that content into a dedicateddocs/installation/tree so the root README focuses on what the kit is and points to the install docs for the how.No content was rewritten — sections were moved verbatim and the per-OS guides were lifted as-is from the README.
What changed
README.md— Installation section reduced from ~300 lines to a short summary + per-OS table + a single link to the docs index:New
docs/installation/tree:README.mdmacos.mdlinux.mdwindows.mdwhat-gets-installed.mdrequirements-and-flags.mdverify.mduninstall.mdtroubleshooting.mdmanual-install.mdskills-only.mdplugin-marketplaces.mdupdating.mdWhat did not change
install.sh,install.ps1) — kept at repo root because the published curl one-liners hardcoderaw.githubusercontent.com/.../main/install.sh.Verification
#verify-it-worked→docs/installation/verify.md, etc.).verify.mdin the same folder.../../README.mdand../../skills/...paths so they still resolve from the new location.grep -r '#verify-it-worked\|#troubleshooting\|#uninstall' .returns no broken references.