dispatchrun / dispatch-py

Python package to develop applications with Dispatch.
https://pypi.org/project/dispatch-py/
Apache License 2.0
54 stars 3 forks source link

README: illustrate architecture with diagram #106

Open achille-roussel opened 6 months ago

achille-roussel commented 6 months ago

This issue is a follow-up to the feedback we got on the Python SDK, in particular:

The other thing I could imagine would be a simple diagram (e.g. Draw.io) showing how the code is in my file, but "this section A runs on your machine", and then "this section B runs on Dispatch servers, possibly across multiple servers, even after failures".

A picture is worth a thousand words, adding a diagram will go a very long way in helping readers form mental models about how they can leverage the product.