docs: streamline install section and add community overview#2561
Merged
Conversation
- Shorten README.md install section to single uv command + link to installation guide for alternatives and troubleshooting - Add explicit 'Initialize a project' step to README Get Started - Remove duplicate Troubleshooting section from README - Reorder 'Make it your own' card on docs landing page so extensions and presets are explained before the stats - Update Community nav-card to link to new community overview - Create docs/community/overview.md landing page (aligned with reference/overview.md) - Create dedicated install sub-pages: pipx, one-time (uvx), air-gapped - Update docs/installation.md to lead with persistent uv install and link to sub-pages instead of duplicating content - Update docs/toc.yml with new pages - Remove stale EOF file
Contributor
There was a problem hiding this comment.
Pull request overview
This PR streamlines the project’s installation documentation and improves docs navigation by introducing dedicated install sub-pages and a new Community overview landing page, while simplifying the README “Get Started” flow.
Changes:
- Condensed README installation guidance to a single recommended
uv tool installcommand + link to the full Installation Guide, and added an explicitspecify initstep. - Expanded the docs IA: new install sub-pages (pipx, one-time uvx, air-gapped) and a new Community overview page; updated
docs/toc.ymlanddocs/index.mdnavigation. - Removed duplicated troubleshooting content from README/docs in favor of linking to the air-gapped guide.
Show a summary per file
| File | Description |
|---|---|
| README.md | Streamlines install instructions and reorders “Get Started” steps; removes embedded troubleshooting content. |
| docs/toc.yml | Adds new install pages and a Community overview entry to the DocFX TOC. |
| docs/installation.md | Updates installation guide to lead with persistent uv tool install and link out to sub-pages. |
| docs/install/pipx.md | Adds pipx-based installation instructions. |
| docs/install/one-time.md | Adds one-time uvx usage instructions. |
| docs/install/air-gapped.md | Adds consolidated enterprise/air-gapped installation instructions (including GCM note). |
| docs/index.md | Updates landing page copy and Community nav-card to point to the new overview page. |
| docs/community/overview.md | Adds a Community landing page linking to extensions/presets/walkthroughs/friends. |
| EOF | Removes a stale file. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 8/9 changed files
- Comments generated: 3
| - [📋 Detailed Process](#-detailed-process) | ||
| - [🔍 Troubleshooting](#-troubleshooting) | ||
| - [💬 Support](#-support) | ||
| - [ Support](#-support) |
| ``` | ||
|
|
||
| ## 💬 Support | ||
| ## Support |
Comment on lines
+55
to
+56
| - name: Overview | ||
| href: community/overview.md |
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
Streamlines the README install section and improves docs navigation.
README.md
uv tool installcommand + link to installation guidespecify init) that was previously missing between install and constitutiondocs/install/air-gapped.md)Docs landing page (
docs/index.md)New pages
docs/community/overview.md— community landing page (aligned withreference/overview.md)docs/install/pipx.md— pipx installation guidedocs/install/one-time.md— one-time uvx usagedocs/install/air-gapped.md— enterprise/air-gapped installationUpdated
docs/installation.md— leads with persistentuv tool install(consistent with README), links to sub-pages, usesspecifyin examples instead ofuvx --from ...docs/toc.yml— added community overview + new install sub-pagesCleanup
EOFfile