search

amphp / amp

A non-blocking concurrency framework for PHP applications. 🐘
https://amphp.org/amp
MIT License
4.25k stars 257 forks source link

Confusing diagram in README #400

Open Nek- opened 2 years ago

Nek- commented 2 years ago

Context:

image

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

kelunik commented 2 years ago

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- commented 2 years ago

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 commented 2 years ago

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.

Nek- commented 2 years ago

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

kelunik commented 2 years ago

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

JadRho commented 2 years ago

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