cli icon indicating copy to clipboard operation
cli copied to clipboard

Reducing documentation redundancy?

Open protosam opened this issue 3 years ago • 0 comments

Due to the nature of using github.com/spf13/cobra, the cli is already self-documenting and following some of the practices outlined by guides like clig.dev.

It seems like maintaining README.md is a duplicate effort and I propose that we should trim README.md down to:

  • discussing the self documenting functionality of the cli, to teach users to navigate it
  • explain that it parities the API functions
  • aim to make mention of functionality that extends beyond what you get from the API

protosam avatar Mar 30 '22 21:03 protosam