Skip to content

improvement: autorecord example workflows #53

@blahah

Description

@blahah

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.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions