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

improvement: autorecord example workflows #53

Open
blahah opened this issue Jul 5, 2022 · 1 comment
Open

improvement: autorecord example workflows #53

blahah opened this issue Jul 5, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@blahah
Copy link
Contributor

blahah commented Jul 5, 2022

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.

@blahah blahah self-assigned this Jul 5, 2022
@blahah blahah added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 5, 2022
@NiklasTR
Copy link
Contributor

NiklasTR commented Jul 5, 2022

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

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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants