search

qri-io / qri

you're invited to a data party!
https://qri.io
GNU General Public License v3.0
1.11k stars 66 forks source link

future docs package improvements #1784

Open ramfox opened 3 years ago

ramfox commented 3 years ago

1) We have a few commands that are specific to devs and that we aren't necessarily trying to advertise to the public. The main one that comes to mind is qri logbook, which is great for debugging, but would just take up oxygen in the docs for folks that are actually looking for qri log. We should have a mechanism for specifically not adding certain commands into the documentation.

2) The "table of contents" portion of the cli commands page should be generated from our code. It not longer reflects the generated commands. Edited by hand for this latest release, but we should probably be generating these from code as well.

3) should we add to the make api-spec command, renaming and moving the temp/open_api_spec.yaml file into api/open_api_3.yaml?

dustmop commented 3 years ago

The help text for each command declared in cmd/ is used to generate the docs on the website. However, each command contains the repeated "Options inherited from parent commands" for flags such as --no-prompt. Might be worth changing the generator so that it only shows this text once, rather than always repeating it.