search

labdao / openlab-cli

Openlab - decentralised bioinformatics services - from the command line.
https://cli.openlab.tools
MIT License
19 stars 3 forks source link

improvement: autorecord example workflows #53

Open blahah opened 2 years ago

blahah commented 2 years ago

oclif already allows for including example commands in command classes, and we use these to render the interface documentation.

We previously produced some animated recordings of workflows with the CLI and had overwhelmingly positive feedback.

We should use the tooling introduced in #21, like the cli.api.json interface definition, and the docs/render.js script, to generate recorded examples from the code at build time. This will mean we always have nice up to date workflow recordings, which is great for users. It also means we can quickly check the workflow recordings to make sure all the key workflows are behaving as expected, as part of code review.

NiklasTR commented 2 years ago

really great idea - I think animations about the tool functionality are going to be key for scientific user adoption