Repository navigation
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates and restructures the Flutter installation documentation, introducing clearer options for installing via VS Code or manual download, and updating sections on target platforms, upgrades, and troubleshooting. The review feedback suggests minor documentation style adjustments to align with the style guide, specifically avoiding the contraction 'you'd' and removing an unnecessary comma in a two-item list, along with updating its corresponding link reference.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
|
Staged preview of the updated docs.flutter.dev site (updated for commit 58e882c): |
|
Staged preview of the updated flutter.dev site (updated for commit 147adce): |
MuthuGCodes
left a comment
MuthuGCodes
left a comment
There was a problem hiding this comment.
lgtm with a nit comment. Thank you for reorganizing this page, Connie :)
| ::: | ||
|
|
||
| [SDK archive]: /install/archive | ||
| [Install Flutter manually]: /install/manual#install-flutter |
There was a problem hiding this comment.
Should we link it to the top of the manual installation page (https://docs.flutter.dev/install/manual)?
The current link took me directly to the "Install and set up Flutter" section, whereas the option to select the desired OS, in turn the relevant SDK download link, is in the "Choose your development platform" section.
|
We're closing this PR for now and will open a new PR in the near future with a more comprehensive update to the install page as part of a broader effort to improve the overall get started and install experience. |
_Description of what this PR is changing or adding, and why:_ This PR streamlines the Flutter installation documentation and site navigation to make it easier for both new and returning developers to find the right setup path: - **Consolidate `/install` and `/install/custom` onto `/install`:** - Replaces the multi-hop routing flow with a single **Install and set up Flutter** hub at `/install` featuring two side-by-side installation options right at the top: **Install with VS Code** (`/install/quick`) and **Download and install manually** (`/install/manual`). - Includes scannable links for configuring target platforms (Android, iOS, web, Windows, macOS, Linux), setting up editors/IDEs, and managing or troubleshooting an existing Flutter SDK installation. - Removes `sites/docs/src/content/install/custom.md` and redirects `/install/custom` and `/get-started/custom` to `/install`. - **Consolidate `/install/quick` and `/install/with-vs-code` onto `/install/quick`:** - Merges Code OSS-based editor guidance and the `flutter doctor` validation step from `with-vs-code.md` into `/install/quick` (**Install Flutter with VS Code**). - Removes the redundant `Test drive Flutter` tutorial section from the install page so installation and learning (`/learn/pathway`) are clearly separated. - Enables sitemap indexing on `/install/quick`, removes `with-vs-code.md`, and redirects `/install/with-vs-code` to `/install/quick`. - **Polish `/install/manual` and unify next-steps cards:** - Simplifies the SDK archive extraction examples across Windows, macOS, and Linux/ChromeOS. - Adds a **Validate your setup** (`flutter doctor`) section with guidance on expected checkmarks. - Reuses the `setup-next-steps.html` partial across both `/install/quick` and `/install/manual` (with OS-filtered target platform links and a direct link to **Create a new Flutter app**). - **Simplify navigation and header:** - Removes the top-right **Get started** CTA button from the `docs.flutter.dev` header. - Simplifies the top **Get started** sidenav section to **Install Flutter** (`/install/quick`) and **Learn Flutter** (`/learn`), and lists **Overview** (`/install`), **Install with VS Code** (`/install/quick`), and **Install manually** (`/install/manual`) under **Manage install**. _Issues fixed by this PR (if any):_ Fixes #13540 Supersedes #13959 --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Shams Zakhour <[email protected]> Co-authored-by: Parker Lougheed <[email protected]>
Description of what this PR is changing or adding, and why:
Updates
/install(sites/docs/src/content/install/index.md) so users can easily find how to download and install the Flutter SDK:## Choose an installation methodheading so installation appears first in the Table of Contents./install/quick) and Download and install manually (/install/manual) with explicit action buttons (previously, manual SDK download was hidden two clicks deep under Custom setup).## Set up target platforms and IDEssection linking to platform setup guides, IDE setup,/install/custom, and the learning pathway./install/manualin theDownload previous releasesnote and fixes aPATHcode-formatting issue in the troubleshooting cards.Note: The team is also aware that the broader Get Started / Install navigation UX is fragmented across several different entry points (such as the top Get started button, the Get started sidenav section, and Manage install at the bottom of the sidenav). That larger navigation and UI cleanup is out of scope for this PR and will be addressed separately.
Issues fixed by this PR (if any):
Fixes #13540