amp icon indicating copy to clipboard operation
amp copied to clipboard

Confusing diagram in README

Open Nek- opened this issue 2 years ago • 6 comments

Context: image

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

Nek- avatar Sep 26 '22 08:09 Nek-

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!

kelunik avatar Sep 26 '22 20:09 kelunik

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)

Nek- avatar Sep 26 '22 20:09 Nek-

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 avatar Sep 26 '22 20:09 kelunik

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

Nek- avatar Sep 26 '22 20:09 Nek-

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

kelunik avatar Sep 26 '22 21:09 kelunik

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

JadRho avatar Oct 21 '22 06:10 JadRho