cauliframework / cauli

Debug Networking
https://cauli.works
MIT License
28 stars 5 forks source link

Add diagrams to improve the Cauliframework documentation #177

Open pstued opened 5 years ago

pstued commented 5 years ago

What do you think if we define a diagram style which we then can use to describe Cauli itself and the shipped Florets?

I think by doing this it's more simple to communicate the effects of the individual components.

I was inspired by Moya and would propose something like the following:

Screen Shot 2019-03-11 at 19 12 16


Screen Shot 2019-03-11 at 19 12 22


Screen Shot 2019-03-11 at 19 12 28


Let me know what you think. If you want to make counterproposal, feel free to use the attached pages file.

Cauli diagrams.zip

Shukuyen commented 5 years ago

I like Overview 2 most. Maybe annotate that the purple box is Cauli?

Would you add the florets to this graph or make new ones? For example we could extend the graph horizontally from "Storage" to the right and have another node called "Displayable Florets" there. This could also make the graph too complex for a quick glance, however.

brototyp commented 5 years ago

Firstly: Thank you very much for your time in this. I really like that you put effort into this.

Overview

I like version two better than the first. Do we need to explain, that cauli is in the end actually a part of the application?

Here is one with an updated Cauli color. ![architecture](https://user-images.githubusercontent.com/113456/54387185-076d7580-469b-11e9-9232-58c9846b3181.jpg)
Here is one where cauli is part of the app. ![architecture-2](https://user-images.githubusercontent.com/113456/54387647-3f28ed00-469c-11e9-8671-a681ba0fcd76.jpg)

Floret specific

I love to use the same visual language to explain how the florets work. For the Inspector floret maybe we should actually have a box for the floret itself? I am not sure. What do you think?