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.

Sign up for GitHub

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

Jump to bottom

README: illustrate architecture with diagram #106

Open
achille-roussel opened this issue Mar 4, 2024 · 0 comments
Open

README: illustrate architecture with diagram #106

achille-roussel opened this issue Mar 4, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@achille-roussel
Copy link
Contributor

achille-roussel commented Mar 4, 2024 •
edited
Loading

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.
@Pryz Pryz added the documentation Improvements or additions to documentation label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
2 participants
@achille-roussel @Pryz