briggySmalls / archie

Tool for documenting system architecture
https://briggysmalls.github.io/archie
MIT License
2 stars 2 forks source link

Document CLI #23

Closed briggySmalls closed 4 years ago

briggySmalls commented 4 years ago

The first documentation should begin by documenting the CLI.

briggySmalls commented 4 years ago

Cobra comes with a tool to autodocument a CLI built with it. It can output to Markdown files.

I think the quick win would be to deploy a markdown site to GitHub pages using jekyll.