New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Reduce doc and CLI usage maintenance cost #122

Open

Bobgy opened this issue Apr 10, 2022 · 0 comments

Assignees

Collaborator

Bobgy commented Apr 10, 2022 •

edited

Loading

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

Problem: doc for both are duplicated, problems:

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

Proposal

Include all the info into CLI usage docstring.
Generate markdown CLI reference using https://github.com/spf13/cobra/blob/master/doc/md_docs.md.
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 #111.

Bobgy self-assigned this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment