Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create "The Flutter Framework Book" #5

Open
ArturAssisComp opened this issue Oct 29, 2024 · 2 comments · May be fixed by #7
Open

Create "The Flutter Framework Book" #5

ArturAssisComp opened this issue Oct 29, 2024 · 2 comments · May be fixed by #7

Comments

@ArturAssisComp
Copy link

Inspired by the rust-lang, I think that we should create good documentation books to help guiding users and contributors. As you can see here, in the rust-lang, there are already a lot of good documentation books which help a lot the new users/contributors to get used to the structure of the project, the architecture, the main classes, etc, in such a way that they can contribute or use the project much faster. Another benefit of having such a book is to centralize all the information necessary to contribute to the framework in only one place (which is not what happens now).

I think we should create an equivalent of Rust Compiler Development Guide for Flutter Framework internals. With that in hands, any Flutter developer (who already knows dart) could much easier get into the Framework internals and fix bugs, implement functionalities, etc, without depend on the Flutter Google team.

I still do not have the necessary deep knowledge of the Framework internals (actually, I am only a Flutter developer with ~1 year of xp) to do this task without mentorship, but, with mentorship from some expert in the Framework, I can do the grunt work of writing this book.

Only to give an idea of what content this book could have, below are some ideas not necessarily in any specific order:

  • Getting started
  • First steps
    • Building
    • Running
    • Debugging
    • High level Overview (explains all the ecosystem: engine, dart, flutter, ... very clearly: this does a good job)
    • Philosophy (the philosophy of the framework: what it aims to be, what problems it aims to solve, next architectural decisions, why dart was chosen, etc).
  • High Level Framework Internals
    • Architecture
    • Element A...
    • Element B...
  • Framework Internals (I do not know the framework internals very well yet, thus I cannot make good suggestions here) ==> Here, we can have more deep details about some specific parts of the framework.
    • Topic A
    • Topic B...
    • Constraint Algorithm
    • Widget ...
  • Contributing ==> Here we can have a more practical thing, with code examples.
    • Generic rules to contribute (PRs, code style, etc)
    • Walkthrough on a typical contribution
    • Fixing a bug
    • Implementing a test
    • Implementing a widget
    • Porting to a new device
    • Suggesting a new design
    • Profiling

So, what do you think, @matthew-carroll ?

@ArturAssisComp
Copy link
Author

Ok, can I start a draft PR on this with the skeleton of the "book"? Initially, I will try to gather some documentations that are already in the Flutter repository and which can be used to help new contributors. And then, the book can be incremented little by little.

@matthew-carroll
Copy link
Contributor

Sure. Thanks for getting started on that. Let's place that work under /documentation/book/ in the Nest repository.

Looking forward to what you come up with!

CC @jezell

@ArturAssisComp ArturAssisComp linked a pull request Oct 30, 2024 that will close this issue
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants