docs Create CLI documentation

Create CLI documentation

Open moklidia opened this issue 2 years ago • 4 comments

Also, please note the update to the CLI documentation (i.e. on GitHub). We currently do not have a https://docs.uffizzi.com/cli page

Aug 04 '22 15:08 moklidia

@gadkins What format should we use for CLI documentation? Can it be just the man format?

Aug 04 '22 15:08 moklidia

For now, instead of creating a CLI documentation page, point users to the CLI repository

Aug 08 '22 15:08 moklidia

For all help commands, change this URL to https://github.com/UffizziCloud/uffizzi_cli

Screen Shot 2022-08-08 at 11 24 12 AM

Aug 08 '22 16:08 gadkins

@moklidia @the38th

See the preview deployment in this PR for the format to use when adding CLI documentation: https://github.com/UffizziCloud/docs/pull/68

Specifically, here is the uffizzi preview command as an example: https://docs-uffizzi-pz5gn1el3-uffizzi.vercel.app/references/cli/preview/

Aug 16 '22 03:08 gadkins