Repository navigation
Document template files in README.md #10927
Description
Excerpt from #9882 (by @Hixie):
Before we add more files to the template, I think we should make sure the template contains a README that documents, for each file in the template:
- What the file is for
- Why you would edit that file
- How to verify that the edits are valid
- How to test the file
The template is growing really big and it's not at all clear why some of these files are part of the user code and not just part of the framework.
Activity
mit-mit commentedon Jun 23, 2017
I have an early draft of this here; feel free to use as inspiration
mit-mit@05b6445
mravn-google commentedon Jan 9, 2018
Being done in external document.
mravn-google commentedon Jan 9, 2018
Didn't intend to close.
Piinks commentedon Apr 30, 2026
This issue from 2017 was previously identified as being handled in external documentation. Since then, the Flutter CLI and its templates have matured, and the generated files themselves now include extensive comments. Additionally, the official documentation at docs.flutter.dev provides comprehensive guides on project structure. As this concern has been addressed through other channels, we are closing this issue. If there is more work to do here, please let us know by filing a new issue with up to date information. Thanks!
github-actions commentedon May 14, 2026
This thread has been automatically locked since there has not been any recent activity after it was closed. If you are still experiencing a similar issue, please open a new bug, including the output of
flutter doctor -vand a minimal reproduction of the issue.