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

README Improvements #10

Open
5 tasks
kylecarbs opened this issue Mar 20, 2024 · 0 comments
Open
5 tasks

README Improvements #10

kylecarbs opened this issue Mar 20, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@kylecarbs
Copy link
Member

I know the README is WIP re: comment at the bottom, but here is some inspiration for things we can do when it's being rewritten:

  • Compare help output from Cobra to Serpent. If we had screenshots side-by-side, that would be very helpful. As I recall, this was one of the primary drivers for creation.
  • Add a "Migrating" section. Assumingly, we want people to migrate their CLI from Cobra if they'd gain the benefits. I think(?) we did this incrementally, but I may be incorrect.
  • A logo would be nice for some flashiness. I'm happy to create one when the time arises.
  • Explicitly state that this replaces Cobra and Viper. Viper was created to solve the lack of an environment and YAML config, but in our experience, it falls short.
  • More examples. It might be worth pointing directly to coder/coder for an example, since that CLI is massive.
@coder-labeler coder-labeler bot added the documentation Improvements or additions to documentation label Mar 20, 2024
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