Feedback on documentation

[abdallahshaban557]

Hi Thomas,

I wanted to share with you some feedback that I had as I was going through your documentation. Lots of this might also just be my own Bias, but wanted to at least give you my perspective on flutter-it.dev new documentation!

What I liked:

1. Having the Umbrella flutter_it package is nice, since I can more naturally use the parts of your ecosystem that makes sense to me without having to worry about another install command.
2. You explain the relationship between your packages well. Makes it easier to now draw an understanding between them all.
3. I like your explanation of the registration types for get_it. I think that you need to explain a bit more that there are 3 flavors of what type of getIt instances you can use and then break them down. Some context setting would help here.

What I felt needed a bit more clarification:

1. I think for me even though the explanations are better, the differences between watch_it and listen_it is still a little fuzzy to me as a new comer to your ecosystem.
2. In your "see it in action" - I think the examples for 3. and 4. don't fully explain the power of these packages IMO. It might also just be overkill to mention ALL of these together in the landing page. I can see that maybe get it and watch it as a start are good to get people in the door.
3. In your getting started, you have one for EACH package, I think it would be a lot easier if you have a getting started that takes you through a whole use case - even like building a simple counter app - just to give anyone using these packages together an idea of how to do it correctly.
4. Also, I like getting started guides that have completely self contained code snippets that you can copy and paste and you get working code out of - including specific on where these files need to be placed in your project.
5. Even in the getting started page, you include pretty in depth "gotchas" that feel a bit out of place to me, here is an example in the getting started for get it.

Best practice: Use registerSingleton() if your object will be used anyway and doesn't require significant resources to create - it's the simplest approach. Only use registerLazySingleton() when you need to delay expensive initialization or for services not always needed.

7. I think unifying all the getting started ones with just using flutter_it will simplify what dependencies I have to use. Right now, there is a mix in there depending on which package you end up starting with. And from what I understand, it seems like you mostly definetely always would use get_it + another package.

Hope this is helpful!

[escamoteur]

I totally get that and it's ony list that flutter_it gets a full sort of code lab.
On the other side it's a construction kit. You can. Use almost all of the packages completely independently of each other. Only watch_it makes only really sense if used with get_it.

But I will absolut make the getting started even simpler.
Thanks a lot for the feedback.
Did you manage to try watch_it or just studying documentation?

[abdallahshaban557]

I did try it, and it was really simple to use! I really like that I can initialized singletons ANYWHERE in my app!

[escamoteur]

@abdallahshaban557 I have seen now what you meant with the intro to get_it, I have overhauled it please see
https://flutter-it.dev/documentation/get_it/getting_started#when-to-use-which-registration-type

I think this structure is better now

[dabblingwithcode]

@escamoteur The docs are incredibly extensive! I did not read everything yet, but I found "Side Effects with Handlers" now very understandable - and I lerant some new things about handlers, so thank you!
Although trivial, I've seen in other docs a "Setting up an LLM" section - that might be a nice to have.