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

Documentation checkup #12

Open
4 tasks
NiclasvanEyk opened this issue Jul 4, 2023 · 0 comments
Open
4 tasks

Documentation checkup #12

NiclasvanEyk opened this issue Jul 4, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation
Milestone

Comments

@NiclasvanEyk
Copy link
Owner

NiclasvanEyk commented Jul 4, 2023

  • Every subcommand has an associated GIF demonstrating its usage
  • Maybe switch to https://www.terminalizer.com if it renders better / more representative GIFs
  • The GIFs are not too fast (right now they are) and none have errors. Ideally, this could be checked during CI (snapshots or exit codes?)
  • Final read through, if everything is up-to-date and makes sense / was actually implemented the way it is described
@NiclasvanEyk NiclasvanEyk added this to the 1.0.0 milestone Jul 4, 2023
@NiclasvanEyk NiclasvanEyk added the documentation Improvements or additions to documentation label Jul 4, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant