What could be improved

The following is valuable feedback that we got from Google:

Feedback for Flame documentation

1. It needs an introduction.

   • It lacks an explanation of what Flame is, what it does, how developers benefit.
   • The context for the entire ecosystem is missing.

2. It needs context.

   • Each section of the documentation lacks any “why” regarding the need for or use of the particular section.
   • Without context, it makes the information less approachable.

3. It needs conceptualization.

   • Each section lacks context for either Flutter or game development.
   • This could include references to Flutter via link or explanation as well as those for common game development concepts.

4. It needs to be more atomic.

   • Some pages should be sections (especially Components and Effects).
   • These sections, when broken up, would be easier to find.

5. It has links that need correction.

   • Some, like those at the bottom of Collision Detection, need to be fixed.

6. It has URLs that include URL-encoded characters like spaces.

   • All of the examples have URLs with spaces in them. That should be fixed.

7. It has many accessibility issues.

   • The color contrast between text and background is poor.
   • Many links lack usable text. (That is, they just link on the word “here”.)
   • Form labels and alt text are missing in places.

Why should this be improved

Because we want good docs.

Any risks?

No.

More information

If you would like to work on a big specific part we can split it out to a separate issue, if you just want to do a small fix related to this issue there is no need to create a new issue.