Skip to content
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

Providing a more visual description of how some of the examples fit together. #2761

Closed
freemansoft opened this issue Jul 21, 2023 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@freemansoft
Copy link
Contributor

freemansoft commented Jul 21, 2023

Describe what scenario you think is uncovered by the existing examples/articles
The examples would be better training documents if they had diagrams. I can submit a PR with a couple of png diagrams for examples if you are interested. Currently have diagrams for counter, random_number and todo.

Describe why existing examples/articles do not cover this case
The examples have good comments but not great entry points prior to the code.

Additional context
I created diagrams for the examples to help me understand how they go together. Random number and counter are essentially the same application with completely different approaches. The Todo application has a lot more moving parts. I intend to create a video using the diagrams so they won't go to waste if you don't want them in the repo.

Riverpods Todo Example

Here is a video using similar drawings to explain the Counter and Random Number examples. Explaining Riverpod on Flutter using two examples from the Riverpod repository

Here is a video using this drawing to explain how the Todo example uses Riverpod

@freemansoft freemansoft added documentation Improvements or additions to documentation needs triage labels Jul 21, 2023
@rrousselGit
Copy link
Owner

Hello!

If we want to add diagrams, I'd use Riverpod_graph for this.
If that's not readable enough, the package should be updated accordingly

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants