Skip to content
This repository has been archived by the owner on Feb 10, 2021. It is now read-only.

Consider removing detailed explanation of CLI options #23

Open
geigerzaehler opened this issue Apr 21, 2020 · 3 comments
Open

Consider removing detailed explanation of CLI options #23

geigerzaehler opened this issue Apr 21, 2020 · 3 comments

Comments

@geigerzaehler
Copy link

We’re documenting in great detail the options and capabilities of radicle-registry-cli. In a few places we even repeat the --help output of the command. With this we risk the docs getting out of sync and we create an overhead for updating the CLI. We should evaluate whether the repeated documentation provides enough value to outweigh these drawbacks. If not we should consider simplifying the docs.

@geigerzaehler
Copy link
Author

In my opinion listing all possible transaction and the command line options does not enough vaue and should be removed from the “Submit transaction” guide. In the long run we should add man pages to our binaries so that we can document everything in there.

@NunoAlexandre
Copy link
Contributor

I agree with this. that's something I reported when writing those bits even.

I reiterate my suggestion to host the CLI docs here. Then we don't require users to go to the terminal and run help commands for each (sub) command and we provide the docs in a way that is generated and not duplicated.

What do you think?

@geigerzaehler
Copy link
Author

I reiterate my suggestion to host the CLI docs here.

Could you elaborate on how you imagine this to work?

To be clear: I think the value that replicating the documentation has is that potential users (especially developers) get a good grasp of what the CLI can do for them before they download it. The value for users that have the CLI is only marginal. It’s more likely that they explore the help text first and only move to docs on the web if the help does not answer their question.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants