docs: an overview document for dart_frog_cli

[wamynobe]

Description

Honestly, I was very confused when I first learned how team uses mason cli and bundles, so I think we should guide other contributors when they want to know how the project is using bricks to generate bundles. and use these bundles to generate necessary files for each command in dart_frog_cli. For example, when I edited the server.dart file in dev_server_runner brick, even though I ran tool/generate_bundles.sh, there was no indication that I had to edit the path to the brick folder in there for the commands in the cli to actually work. In the end I was still able to find the answer myself but it would take time for others. If possible, an overview document would be recommended. Thank you team for such a great Dart project.

Requirements

• [ ] Requirements go here

[alestiago]

Hi @wamynobe sorry for the late reply, and thank you for opening an issue 💙 !

I do agree with you, I believe the repository should have better documentation regarding contributing to changes associated to the template generation.

Maybe we can add a section to our existing CONTRIBUTING file. Here is some other CONTRIBUTING documentation for Very Good Core, a template that gets used by Very Good CLI when creating a new flutter application, it might serve as inspiration.

Would you be interesting in contributing? If so, once you make a Pull Request the team might be able to assist you on landing it in!