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

Improve introductory documentation #1219

Closed
littledan opened this issue Nov 30, 2020 · 1 comment · Fixed by #1272
Closed

Improve introductory documentation #1219

littledan opened this issue Nov 30, 2020 · 1 comment · Fixed by #1272
Labels
documentation Additions to documentation
Milestone

Comments

@littledan
Copy link
Member

The API surface is motivated by use cases, and it should be possible to tell a strong user story for each of those use cases in the docs. This could include one usage per class and one usage per method name/category, as the recent presentation does. This could be presented in two ways:

  • In the main page of the documentation, the basics could be explained in a way that's parallel to the presentation
  • The cookbook could include examples of of using each main part of the API
@ptomato ptomato added the documentation Additions to documentation label Nov 30, 2020
@ptomato ptomato added this to the Stage 3 milestone Nov 30, 2020
Ms2ger added a commit that referenced this issue Jan 13, 2021
ptomato pushed a commit that referenced this issue Jan 13, 2021
ptomato added a commit that referenced this issue Jan 13, 2021
* Add some examples to the documentation readme.

Fixes #1219.

* Address code review comments

Co-authored-by: Philip Chimento <[email protected]>
@littledan
Copy link
Member Author

Note that the TAG asked about an explainer in w3ctag/design-reviews#311 (comment) . I'm not really sure whether anything is needed, but a short document of some kind (could be largely copy-pasted from a blog post/with reused wording from the docs) explaining the motivation for the proposal and how Temporal meets it, especially being driven by code samples from the beginning, could be useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants