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

Add diagrams to improve the Cauliframework documentation #177

Open
pstued opened this issue Mar 11, 2019 · 2 comments
Open

Add diagrams to improve the Cauliframework documentation #177

pstued opened this issue Mar 11, 2019 · 2 comments
Labels
proposal Proposing a new feature.

Comments

@pstued
Copy link
Member

pstued commented Mar 11, 2019

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

@pstued pstued added the proposal Proposing a new feature. label Mar 11, 2019
@Shukuyen
Copy link
Collaborator

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
Copy link
Member

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

Here is one where cauli is part of the app.

architecture-2

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
proposal Proposing a new feature.
Projects
None yet
Development

No branches or pull requests

3 participants