celestia-node cmd: Add better/more thorough descriptions to CLI commands/flags

We need to revisit our current descriptions for commands/flags available on the celestia binary and double check to ensure they are thorough enough.

Oct 11 '21 09:10 renaynay

Currently:

  init        Initialization for Celestia Node. Passed flags have persisted effect.
  keys        Manage your bridge node account keys
  start       Starts Node daemon. First stopping signal gracefully stops the Node and second terminates it.

Apr 26 '22 14:04 renaynay

Hi @renaynay can I get more clarity on how do you want to ensure they're thorough? Happy to submit a PR, I'm just lacking some context on the desired outcome here.

Jul 14 '22 19:07 YazzyYaz

Hey @YazzyYaz , sorry for not giving you more context, i realise i just tagged you without much explanation. I think it would be nice if you could review our command line flags as they are and see if there are descriptions that aren't explanatory enough, or if we have confusing naming, etc. Is that okay?

Jul 15 '22 11:07 renaynay

@renaynay Some Notes:

https://github.com/celestiaorg/celestia-node/blob/main/cmd/flags_node.go#L30 should show what the default path is.
https://github.com/celestiaorg/celestia-node/blob/main/cmd/flags_node.go#L25 should show what the default path is.
https://github.com/celestiaorg/celestia-node/blob/main/cmd/flags_core.go#L26 should explain more what a default core node is.
https://github.com/celestiaorg/celestia-node/blob/main/cmd/flags_key.go#L15 should read Directs the node's keyring signer to use the key prefixed with the given name.

Jul 18 '22 17:07 YazzyYaz

Grooming 01/11/2022:

Plan to finish before start ITN

Nov 01 '22 15:11 Bidon15

a little out of date and we've done lots of work on flags, --help etc, so closing and we can re-open for specific commands that maybe cause confusion as they arrive

Dec 12 '23 09:12 ramin