search

nullstone-io / nullstone

Nullstone is a customizable developer platform launched on your cloud accounts.
https://nullstone.io
MIT License
39 stars 1 forks source link

C897 cli docs #114

Closed ssickles closed 1 year ago

ssickles commented 1 year ago

This PR adds a new routine that generates a proper markdown file (docs/CLI.md) based on the commands built for our CLI.

Generating these docs also pointed out a lack of documentation in some places and some opportunities to improve for others. Please review my changes to the commands and make sure they are all correct and that you are ok with the changes.

To generate the CLI.md file, simply run make docs.

ssickles commented 1 year ago

I wasn't familiar with how to do go templates so I opted for the simple path (at least for me). :)

I totally agree that we should add a bunch of examples for each. I wasn't sure where to put that on the CLI command structs.