AppFlowy-IO / AppFlowy-IO/AppFlowy-Docs

Missing flutter version for MacOS dev setup docs

Open
#204 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
109
Forks
108
PR merge metrics
No merged PRs in 30d

Description

The [issue](https://github.com/AppFlowy-IO/AppFlowy/issues/3154) is from the main AppFlowy repo.

> ### Bug Description
>
> While I was building from source I faced an issue with the Flutter version.
> ### How to Reproduce
>
> While trying to build from source in MacOS using the [link](https://docs.appflowy.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/environment-setup/building-on-macos)
> ### Expected Behavior
>
> A requirement at the top of the build instructions should be available showing the currently supported version of flutter, rust, and other dependencies for a successful build.
> ### Operating System
>
> MacOS
> ### AppFlowy Version(s)
>
> 0.2.8
> ### Screenshots
> Screenshot 2023-08-10 at 1 13 25 PM
> ### Additional Context
>
> _No response_

While the flutter version is not specified in the [docs](https://docs.appflowy.io/docs/documentation/appflowy/from-source/environment-setup/building-on-macos). The script scripts/install_dev_env/install_macos.sh automates the fetching of the flutter version and specifies which version to use.

The flutter version is specifically mentioned in both the [linux](https://docs.appflowy.io/docs/documentation/appflowy/from-source/environment-setup/building-on-linux#install-flutter-three-different-methods) and [windows](https://docs.appflowy.io/docs/documentation/appflowy/from-source/environment-setup/building-on-windows#step-2-install-your-build-environment) doc.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the MacOS build documentation linked in the issue and compare its dependency instructions with scripts/install_dev_env/install_macos.sh, which fetches the Flutter version. Update the documentation to state the supported Flutter version and the other required dependency versions, matching the existing Linux and Windows guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
flutter, shell
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.