docs: update the project and flutter setup docs#2534
Conversation
Flutter documentation recommends downloading via VSCode or via the SDK Archive (tar/zip files) rather than cloning the git repository
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThis pull request updates several documentation files to improve setup instructions and version management. The changes add detailed Windows prerequisites—including Visual Studio Community 17.13.0, NuGet CLI setup, and registry tweaks—and revise guidance for Firebase account setup, Flutter version pinning, and general Flutter SDK installation. Instructions for managing multiple Flutter versions via FVM are clarified, and dependency version numbers across various tools are updated. Changes
Possibly related PRs
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
Visit the preview URL for this PR (updated for commit b525646): https://walletrc--pull-2534-merge-jzov5jm9.web.app (expires Fri, 28 Feb 2025 10:31:00 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: f66a4ff03faa546f12f0ae5a841bd9eff2714dcc |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/MULTIPLE_FLUTTER_VERSIONS.md (2)
25-26: Typographical Correction Recommended
The header “pen (or create).zshrcfile” appears to have a typo. Changing “pen” to “open” will improve clarity.
39-41: Minor Grammatical Improvement
Consider revising the heading to “Check if the newly installed Flutter version is accessible from the terminal” by inserting “the” before “newly installed” to improve grammatical correctness.🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: You might be missing the article “the” here.
Context: ..." ``` Save and close. ### 3. Check if newly installed Flutter version is accessible...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
docs/INSTALL_FLUTTER.md (1)
40-41: Formatting Fix Needed for Windows Instructions
The line introducing the Windows instructions contains a double colon at the end. Removing the extra colon will improve consistency and readability.docs/BUILD_RUN_APP.md (1)
110-122: Clear and Consistent Windows Prerequisites InstructionsThe added section for Windows desktop prerequisites is clear and comprehensive. It specifies:
- The requirement of Visual Studio Community 17.13.0 with the Desktop development with C++ workload.
- The necessity of the NuGet CLI installation via winget along with precise PowerShell commands for adding a primary package source.
- How to enable long paths in the Windows registry.
These instructions are consistent with the updates in
docs/PROJECT_SETUP.mdand provide valuable guidance for users on Windows. As a minor nitpick, consider changing "pre-requisites" to "prerequisites" for improved consistency in terminology.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
docs/BUILD_RUN_APP.md(1 hunks)docs/FIREBASE_SETUP.md(1 hunks)docs/FLUTTER_VERSION.md(1 hunks)docs/INSTALL_FLUTTER.md(2 hunks)docs/MULTIPLE_FLUTTER_VERSIONS.md(3 hunks)docs/PROJECT_SETUP.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/MULTIPLE_FLUTTER_VERSIONS.md
[uncategorized] ~39-~39: You might be missing the article “the” here.
Context: ..." ``` Save and close. ### 3. Check if newly installed Flutter version is accessible...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build_and_preview
- GitHub Check: validate_code_guidelines
🔇 Additional comments (13)
docs/FIREBASE_SETUP.md (2)
1-3: Overall Clarity in Firebase Setup Introduction
The introductory lines clearly state the purpose and steps for Firebase configuration. The structure remains user-friendly and the instructions are easy to follow.
12-14: Enhanced Instructions for Disabling GitHub Tracking
The added instruction “Disable github tracking of config files:” along with the dedicated, properly labeled bash code block improves the clarity and formatting of the section. For added value, consider including a brief explanation on why disabling GitHub tracking for these configuration files is recommended (e.g., to avoid accidentally committing sensitive configuration data).docs/FLUTTER_VERSION.md (2)
11-13: Detailed Guidance for Pinning Flutter Version
The expanded explanation with a concrete command sequence for pinning Flutter to version 3.29.0 provides clear guidance. It may be useful to mention that using Flutter Version Manager (FVM) is an alternative approach to overcome the limitations of pinning.
19-20: Clear Deprecation Notice for Direct Version Pinning
The cautionary note effectively communicates that pinning the Flutter version is no longer recommended due to isolation issues and known problems withflutter pub get. This helps users understand potential pitfalls and encourages exploring alternative methods like FVM.docs/MULTIPLE_FLUTTER_VERSIONS.md (3)
1-4: Updated Header Improves Section Clarity
Changing the section header to “Flutter Version Manager (FVM)” makes the recommended approach immediately clear. This update helps users quickly recognize the preferred method for managing multiple Flutter versions.
58-64: Clear Windows FVM Setup Instructions
The detailed steps for installing Chocolatey and FVM on Windows are well presented. The use of a PowerShell code block enhances readability and ensures the instructions are actionable.
78-86: Concise and Clear Linux FVM Instructions
The Linux section efficiently explains how to install FVM using the provided installation script. The clear formatting aids user comprehension and supports consistency with the Windows instructions.docs/INSTALL_FLUTTER.md (2)
9-10: Expanded Flutter SDK Installation Options Enhance Flexibility
The revised text now gives users multiple methods to install the Flutter SDK—including using the VS Code extension, downloading from the SDK Archive, or employing FVM. This expanded guidance improves the documentation’s usefulness for various user preferences.
51-60: Well-Structured Section on Using FVM
The clear segmentation and command block for FVM usage make it easy for users to follow the process of installing and configuring the Flutter SDK via FVM.docs/PROJECT_SETUP.md (4)
18-24: Updated Platform Requirements are Clear and Concise
The updates—including the new version numbers for Android Studio (Ladybug | 2024.2.2), Android SDK Build-Tools (35.0.1), NDK (28.0), Android command line tools (19.0.0), and CMake (3.31.5)—enhance the documentation. These updates reflect the current platform requirements well. Ensure these changes are consistently applied in all related documentation.
25-29: Clear Updates for Additional Tools on Host Platforms
The revised specifications for Xcode and Visual Studio (Community 17.13.0), along with the new requirements for the NuGet CLI and enabling long paths in the Windows registry, add much-needed clarity for users setting up their development environment on various host platforms.
42-52: Comprehensive Dev Container Setup Instructions
The section detailing the Docker and VS Code Dev Container setup is thorough and clear. This guidance ensures that users can easily configure their development environment for web and Android builds.🧰 Tools
🪛 LanguageTool
[grammar] ~46-~46: The correct preposition appears to be “on”.
Context: ...cker-desktop), and if you are using WSL in Windows, please ensure that the [WSL 2 ...(IN_WINDOWS)
55-64: Informative Guidance for Handling GitHub API Rate Limits
The detailed explanation about encountering a 403 error due to GitHub’s API rate limit—as well as the step-by-step instructions for using a personal access token—is excellent. This section should help users troubleshoot common build issues effectively.
smk762
left a comment
smk762
left a comment
There was a problem hiding this comment.
Works as advertised on Linux.
@AndrewDelaney @ShantanuSharma9873 please test windows side and ping in chat if any issues
| ## Use VS Code to install | ||
|
|
||
| 1. Clone Flutter with | ||
| The recommended approach is to install the [Flutter extension for VSCode](https://marketplace.visualstudio.com/items?itemName=Dart-Code.flutter) (or the [Flutter extension for Android Studio/IntelliJ](https://plugins.jetbrains.com/plugin/9212-flutter)) and installing the Flutter SDK via the extension to simplify the process. |
There was a problem hiding this comment.
I do not think it is possible to install the sdk using the extensions. As far as I can make out, one already needs to have the sdk downloaded, then you can set the path to the sdk using the extension.
Edit: You can install flutter using the extension, but you need to be creating a new project as outlined in this guide. This makes it a little unclear if you already have the project open in VS Code, and now you want to d ownload the sdk for the project.
docs/INSTALL_FLUTTER.md
Outdated
| ## Use Flutter Version Manager (FVM) | ||
|
|
||
| The recommended method of handling multiple Flutter versions is to use [FVM](https://fvm.app/documentation/getting-started/installation). | ||
| The recommended method of handling multiple Flutter versions is to use [FVM](https://fvm.app/documentation/getting-started/installation). To install FVM and use the stable version of the Flutter SDK in the current directory, run the following commands: |
There was a problem hiding this comment.
I would recommend changing the wording here to "Should multiple versions of Flutter SDK need to be installed and managed, it is recommended to use FVM".
Reason: Earlier in the guide we refer to the recommended method of installing the SDK, and it may be a little confusing for some if this section to also start off with "The recommended method". The distinction here is the focus on managing multiple versions of Flutter SDK.
docs/INSTALL_FLUTTER.md
Outdated
| The recommended method of handling multiple Flutter versions is to use [FVM](https://fvm.app/documentation/getting-started/installation). To install FVM and use the stable version of the Flutter SDK in the current directory, run the following commands: | ||
|
|
||
| ```bash | ||
| curl -fsSL https://fvm.app/install.sh | bash |
There was a problem hiding this comment.
This command is not directly compatible with windows, as the shell script expects a unix environment. I don't think even having bash setup on Windows allows for this script to be run from the web. Without expecting the user to use WSL, perhaps the is a Windows-friendly method of installing FVM that can be outlined here too?
There was a problem hiding this comment.
I updated this to reference MULTIPLE_FLUTTER_VERSIONS.md instead in b525646
docs/MULTIPLE_FLUTTER_VERSIONS.md
Outdated
| ## Windows TBD | ||
| ## Windows | ||
|
|
||
| The following steps installs [fvm](https://fvm.app/docs/getting_started/installation) as a standalone application and uses it to manage both local and global Flutter SDKs. The recommended approach is to download and install a global version of Flutter SDK and use fvm to manage local Flutter SDKs, but this approach works for most scenarios. |
There was a problem hiding this comment.
Invalid link. I believe it is supposed to be: https://fvm.app/documentation/getting-started/installation
There was a problem hiding this comment.
Thanks for spotting this. I updated the links in b525646
docs/MULTIPLE_FLUTTER_VERSIONS.md
Outdated
| # Handle multiple Flutter versions | ||
|
|
||
| ## FVM | ||
| ## Flutter Version Manager (FVM) |
There was a problem hiding this comment.
I think this section needs to be repurposed. This contains the install insttructions for FVM for unix environments, yet underneath there are sections for each operating system. Perhaps just use this section to provide a description of what FVM is, and leave the installation instructions to the later sections to avoid repetition.
There was a problem hiding this comment.
I modified it to focus on FVM in b525646, seeing as the git-based approach is no longer recommended and is causing issues with the 3.29 release.
4 participants
Summary by CodeRabbit