Revise Commands documentation to not be CLI-centered #3387
Labels
exp/novice
Someone with a little familiarity can pick up
kind/enhancement
A net-new feature or improvement to an existing feature
status/deferred
Conscious decision to pause or backlog
topic/docs-ipfs
Topic docs-ipfs
Milestone
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.
The text was updated successfully, but these errors were encountered: