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

Workflows rewrite kdoc isn't helpful enough when starting from scratch #780

Open
zach-klippenstein opened this issue Mar 15, 2019 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation kotlin points: 2

Comments

@zach-klippenstein
Copy link
Collaborator

Internal feedback has been that the existing kdocs on the new workflows is not comprehensive enough to figure out how to use it.

Some of said feedback:

Documentation needs to be written for library users (app authors), but at every iteration of the API the documentation is instead some kind of platonic description of internal architecture with no indication of how to use it.

it’s frustrating that every time I sit down to pick up a new version of the API I face the same problem of literally not being able to make sense of it without a guided tour

so, here’s one quick thing that you should be able to easily point out and document: in 0.8.0, how do I get an instance of a workflow?
like, my first one. a “root”.
I can tell you I’ve looked at Workflow, WorkflowContext, WorkflowAction. so if it’s one of those, please plant a big flag on it and point to it from the others, b/c I’ve missed it somehow

@zach-klippenstein zach-klippenstein added bug Something isn't working points: 2 labels Mar 15, 2019
@zach-klippenstein zach-klippenstein added the documentation Improvements or additions to documentation label Jun 13, 2020
@zach-klippenstein
Copy link
Collaborator Author

Docs, not 1.0 blocker.

@rjrjr rjrjr transferred this issue from square/workflow May 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation kotlin points: 2
Projects
None yet
Development

No branches or pull requests

2 participants