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

README: highlight technical and brand terms #105

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

README: highlight technical and brand terms #105

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

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

One (opinionated) suggestion I would make would be to highlight the Dispatch terms, e.g. in bold or italic text, to make it clear that it's a product specific term (or maybe is a computer science term I never saw, but anyway). For example, "durable coroutine", or "stateful function". And I would try to clearly add definitions for those terms.

This is not about changing the content but simply improving the form of our documentation, the intent being to guide readers through the text better.

@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