Skip to content
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.

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

Revise Commands documentation to not be CLI-centered #3387

Open
hsanjuan opened this issue Nov 15, 2016 · 1 comment
Open

Revise Commands documentation to not be CLI-centered #3387

hsanjuan opened this issue Nov 15, 2016 · 1 comment
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

Comments

@hsanjuan
Copy link
Contributor

hsanjuan commented Nov 15, 2016

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.

@hsanjuan hsanjuan added exp/novice Someone with a little familiarity can pick up topic/docs-ipfs Topic docs-ipfs kind/enhancement A net-new feature or improvement to an existing feature labels Nov 15, 2016
@hsanjuan hsanjuan added this to the Improve Developer Experience milestone Nov 15, 2016
@Kubuxu Kubuxu added the status/deferred Conscious decision to pause or backlog label Nov 28, 2016
@whyrusleeping
Copy link
Member

Hrm... unsure about this. We often put example cli command invocations in the helptext, thats hard to have apply to both HTTP and CLI

@daviddias daviddias added docs and removed docs labels Oct 1, 2019
@ajnavarro ajnavarro mentioned this issue Aug 24, 2022
72 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Projects
None yet
Development

No branches or pull requests

4 participants