workflow-kotlin icon indicating copy to clipboard operation
workflow-kotlin copied to clipboard

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

Open zach-klippenstein opened this issue 6 years ago • 1 comments
trafficstars

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 avatar Mar 15 '19 22:03 zach-klippenstein

Docs, not 1.0 blocker.

zach-klippenstein avatar Jun 27 '20 00:06 zach-klippenstein