Revise Commands documentation to not be CLI-centered
Open
exp/novice
kind/enhancement
status/deferred
topic/docs-ipfs
- Dominant language
- Go
- Stars
- 17.1k
- Forks
- 3.2k
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 11
Description
#### Version information: next
#### Type: Enhancement
#### Priority: P5
#### Description:
This is a note for something that I should eventually revise. Since we now autogenerate documentation directly from the code (https://github.com/ipfs/ipfs-http-api-docs), we should aim to have `Commands` documentation provide descriptions which serve for both CLI and HTTP API (which are the same thing at the end). Of course, the CLI user should find them as useful as before.
This applies only to the things that are used for the auto-generation:
- `Helptext.Tagline`
- `Arguments.Description`
- `Options.Description`
The CLI-centered descriptions are a minority so this is a minor issue anyway.
Contributor guide
Assessment
This issue has not been assessed yet.