[GH-ISSUE #1908] [FR] Improve documentation under `appflowy_flutter` #749

New issue

Closed

opened 2026-03-23 20:40:34 +00:00 by mirror · 2 comments

mirror commented

2026-03-23 20:40:34 +00:00

Owner

Originally created by @AmanNegi on GitHub (Mar 2, 2023).
Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/1908

Issue

The documentation in the appflowy/frontend/appflowy_flutter is not helpful (it's the default documentation generated when a Flutter Project is created). It would be beneficial to update the documentation and mention the following details:

What appflowy_flutter is used for (web, mobile, desktop, Linux, etc)?
How to set up the project on your system to work on the appflowy_flutter.
Preferred IDE Setup just like mentioned in appflowy/frontend/appflowy_tauri

Impact

All Developers getting started with contributing to the Flutter part of the AppFlowy application.

Additional Context

No response

Originally created by @AmanNegi on GitHub (Mar 2, 2023). Original GitHub issue: https://github.com/AppFlowy-IO/AppFlowy/issues/1908 ## Issue The documentation in the `appflowy/frontend/appflowy_flutter` is not helpful (it's the default documentation generated when a Flutter Project is created). It would be beneficial to update the documentation and mention the following details: - What `appflowy_flutter` is used for (web, mobile, desktop, Linux, etc)? - How to set up the project on your system to work on the `appflowy_flutter`. - Preferred IDE Setup just like mentioned in `appflowy/frontend/appflowy_tauri` ![image](https://user-images.githubusercontent.com/37607224/222317323-5477f8be-1ab3-4556-9e0b-0f9f69b4a4a9.png) ### Impact All Developers getting started with contributing to the Flutter part of the AppFlowy application. ### Additional Context _No response_

mirror

2026-03-23 20:40:34 +00:00

closed this issue
added the
documentation
label

mirror commented

2026-03-23 20:40:35 +00:00

Author

Owner

@AmanNegi commented on GitHub (Mar 2, 2023):

Hey there, I would love to work on this task as well.. 😊

I just need help with the following part:

What appflowy_flutter is used for (web, mobile, desktop, Linux, etc)?

@AmanNegi commented on GitHub (Mar 2, 2023): Hey there, I would love to work on this task as well.. 😊 I just need help with the following part: > What appflowy_flutter is used for (web, mobile, desktop, Linux, etc)?

mirror commented

2026-03-23 20:40:36 +00:00

Author

Owner

@LucasXu0 commented on GitHub (Mar 2, 2023):

Hey, @AmanNegi. Thanks. I assigned it to you.

What appflowy_flutter is used for (web, mobile, desktop, Linux, etc)?

For now, appflowy_flutter supports desktop platforms, like macOS, Linux and Windows. And we plan to support the mobile platform in the next quarter.

Here's the reference for you. https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/environment-setup

@LucasXu0 commented on GitHub (Mar 2, 2023): Hey, @AmanNegi. Thanks. I assigned it to you. > What appflowy_flutter is used for (web, mobile, desktop, Linux, etc)? For now, appflowy_flutter supports desktop platforms, like macOS, Linux and Windows. And we plan to support the mobile platform in the next quarter. Here's the reference for you. https://appflowy.gitbook.io/docs/essential-documentation/contribute-to-appflowy/software-contributions/environment-setup

mirror referenced this issue

2026-03-23 21:37:15 +00:00

[PR #749] [MERGED] Feat: transaction to json #4312