Reorganize installation docs #11473
Merged
Reorganize installation docs #11473
+544
−220
Conversation
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
These changes work to improve GitHub CLI users experience by bringing: - clarity between official and unofficial installation methods - insight into unofficial installation methods - consistency across supported operating systems
Now that our installation docs more clearly delineate official and unofficial installation methods, the maintainers are more open to contributions from communities.
There was a problem hiding this comment.
Pull Request Overview
This PR reorganizes and standardizes the GitHub CLI installation documentation to improve user experience by clearly distinguishing between official and unofficial installation methods across all supported operating systems.
- Creates dedicated installation documentation files for each platform (Windows, macOS, Linux, source)
- Establishes consistent documentation structure with "Recommended (Official)" and "Community (Unofficial)" sections
- Updates README.md to use structured links to the new platform-specific documentation
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/install_windows.md | New comprehensive Windows installation guide with official (WinGet, binaries) and community methods |
| docs/install_source.md | New source installation documentation with Go requirements and cross-compilation instructions |
| docs/install_macos.md | New macOS installation guide covering official (Homebrew, binaries) and community package managers |
| docs/install_linux.md | Restructured Linux/BSD installation guide with clearer categorization of official vs community methods |
| README.md | Simplified installation section with structured links to platform-specific documentation |
| .github/CONTRIBUTING.md | Updated contribution guidelines to allow community package proposals |
After discussing changes with @BagToad, we talked about consolidating the top-level readme further to reduce the amount of links. Additionally, the Amazon Linux 2 and openSUSE/SUSE sections weren't contained appropriately in the official sections.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
BagToad
reviewed
Aug 11, 2025
BagToad
reviewed
Aug 11, 2025
BagToad
reviewed
Aug 11, 2025
BagToad
reviewed
Aug 11, 2025
BagToad
approved these changes
Aug 11, 2025
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.
Fixes github/cli#934
These changes work to improve GitHub CLI user installation experience by bringing:
With these changes, the GitHub CLI maintainers are open to accepting unofficial community supported installation methods.
One change I want to explain upfront is the removal of KISS linux because the GitHub account has been archived. Unsure if this community is still active, I erred on the side of removing for now.