-
-
Notifications
You must be signed in to change notification settings - Fork 908
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
Add AsyncValue documentation #3500
Comments
Sounds like this overlaps with the API reference. It's normal IMO that folks have to look at the API reference if they want docs about a very specific thing. |
Yes, it will overlap. |
I don't like the idea of having an overlap with the API reference. If we want to improve AsyncValue's docs, I'd rather update the API reference to have better docs. Then link the AsyncValue's dartdoc page better in the doc. Duplicate content will get out of sync. |
Maybe it is possible to link the api reference with the documentation similar to how Signals does it. |
I'm planning on having a way to extract dartdoc and put it into the website. |
Make riverpod onboarding easier.
AsyncValue is a core feature of riverpod when we use AsyncNotifier / FutureProvider, but is not explained in the documentation.
Currently new user have to look into the api reference or source code to get basic information.
The documentation should contain:
In case information is missing, feel free to add them.
If needed, I can contribute to the docs.
The text was updated successfully, but these errors were encountered: