search

google / go-licenses

A lightweight tool to report on the licenses used by a Go package and its dependencies. Highlight! Versioned external URL to licenses can be found at the same time.
Apache License 2.0
833 stars 125 forks source link

Reduce doc and CLI usage maintenance cost #122

Open Bobgy opened 2 years ago

Bobgy commented 2 years ago

Goal: users should be able to find full documentation in both CLI usage and from github documentation.

Problem: doc for both are duplicated, problems:

  1. some information is only available in one place
  2. duplicated efforts needed to maintain docs must be applied to both places

Proposal

  1. Include all the info into CLI usage docstring.
  2. Generate markdown CLI reference using https://github.com/spf13/cobra/blob/master/doc/md_docs.md.
  3. Remove non-quickstart necessary information from README.md and just link to the generated reference doc.

Context: this is an idea generated when updating docs for v1.1 https://github.com/google/go-licenses/pull/111.