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

Confusing diagram in README #400

Open
Nek- opened this issue Sep 26, 2022 · 6 comments
Open

Confusing diagram in README #400

Nek- opened this issue Sep 26, 2022 · 6 comments

Comments

@Nek-
Copy link

Nek- commented Sep 26, 2022

Context:
image

Both diagrams are just exactly the same rendered differently, if it should explain something, no user can actually understand anything.

@kelunik
Copy link
Member

kelunik commented Sep 26, 2022

I wouldn't call it wrong, but it might be confusing. What's pictured here is some tasks and their dependencies. The dependencies will stay the same whether executed sequentially or concurrently. We're open to suggestions on how to improve this!

@Nek-
Copy link
Author

Nek- commented Sep 26, 2022

I re-read many times to be sure, but now I understand what you call dependencies vs flow. Still I think some improvement can be done here ^^ . (maybe adding a flow arrow)

@kelunik
Copy link
Member

kelunik commented Sep 26, 2022

The diagram is currently gone in the v3 documentation, because I didn't want to write any rewrite rules / content import, yet (other than the READMEs). As said, we're open to suggestions, we just wanted something visual there to catch attention and give a very high level view what the library allows its users to do.

@kelunik kelunik changed the title Documentation: the first diagram on the readme is wrong Confusing diagram in README Sep 26, 2022
@Nek-
Copy link
Author

Nek- commented Sep 26, 2022

Since it's gone in v3 I think we just can close this issue.

@kelunik
Copy link
Member

kelunik commented Sep 26, 2022

We could, but we actually prefer to bring it back in an improved version, so let's keep it open.

@kelunik kelunik added the v2.x label Oct 16, 2022
@JadRho
Copy link

JadRho commented Oct 21, 2022

Maybe just adding a XY axis to the current diagram is enough.
The Y would be time
And X would be "perceived paralelism"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

3 participants