Skip to content

Commit e363409

Browse files
committed
Add flow diagrams to all package getting started pages
- Added get-it-flow.svg to get_it getting started - Added watch-it-flow.svg to watch_it getting started - Added command-it-flow.svg to command_it getting started - Consistent with listen_it which already has listen-it-flow.svg - Visual diagrams help explain data flow in each package
1 parent 778789c commit e363409

File tree

3 files changed

+6
-0
lines changed

3 files changed

+6
-0
lines changed

docs/documentation/command_it/getting_started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ This documentation is currently being restructured and will soon match the compr
1717

1818
command_it is a way to manage your state based on `ValueListenable` and the `Command` design pattern. Sounds scary uh? Ok lets try it a different way. A `Command` is an object that wraps a function that can be executed by calling the command, therefore decoupling your UI from the wrapped function.
1919

20+
![command_it Data Flow](/images/command-it-flow.svg)
21+
2022
It's not that easy to define what exactly state management is (see https://medium.com/super-declarative/understanding-state-management-and-why-you-never-will-dd84b624d0e ). For me it's how the UI triggers processes in the model/business layer of your app and how to get back the results of these processes to display them. For both aspects `command_it` offers solution plus some nice extras. So in a way it offers the same that BLoC does but in a more logical way.
2123

2224
>This readme might seem very long, but it will guide you easily step by step through all features of `command_it`.

docs/documentation/get_it/getting_started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ next:
2929
- Manage app-wide state (view models, managers, BLoCs)
3030
- Easily swap implementations for testing
3131

32+
![get_it Data Flow](/images/get-it-flow.svg)
33+
3234
> Join our support Discord server: [https://discord.gg/ZHYHYCM38h](https://discord.gg/ZHYHYCM38h)
3335
3436
---

docs/documentation/watch_it/getting_started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ next:
2727
- Navigate or show dialogs in response to data changes
2828
- Display command progress (loading spinners, error messages, success states)
2929

30+
![watch_it Data Flow](/images/watch-it-flow.svg)
31+
3032
> Join our support Discord server: [https://discord.gg/ZHYHYCM38h](https://discord.gg/ZHYHYCM38h)
3133
3234
---

0 commit comments

Comments
 (0)