Update documentation with VHS generated GIFs#88
Merged
Conversation
jmaupetit
force-pushed
the
update-docs-with-vhs
branch
from
e21e998 to
3afb172
Compare
Thanks to VHS, we now script every documentation example by generating a GIF that shows the command output.
jmaupetit
force-pushed
the
update-docs-with-vhs
branch
from
3afb172 to
5aac2e5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
We need a way to keep output command examples up-to-date and developer friendly.
Proposal
We've added VHS, scriptable terminal recorder, to the project's development dependencies. We've developed a script (tape) per documentation example to generate a GIF we can integrate.