Rust doc user journey: CLI

[kianenigma]

I think this is a great example of a page that should have been entirely documented in rust-docs: it is almost entirely copy-pasted, and extremely hard to maintain: https://docs.substrate.io/reference/command-line-tools/node-template/

We should focus on the documentation of the crate https://paritytech.github.io/substrate/master/sc_cli/index.html and improve it such that this page can act as the single source of truth for CLI args.

This crate should be linked in #11.

[CrackTheCode016]

As a note (and this is probably already obvious), a lot of pallets, in general, contain super valuable docs ranging from the intention of the pallet to individual extrinsics.

Not sure off the top of my head, but grabbing that as a part of the docs wouldn't be a terrible idea (with added context in some cases)

[kianenigma]

All such docs are accessible in http://paritytech.github.io/ and #9, is that what you mean?

[kianenigma]

I tried to take a stab at this in paritytech/substrate#14581, but the experience is still pretty rubbish.

[kianenigma]

It seems like in each chain, we expect to run a struct Cli of some sort, with a run and subcommands fields.

The run command gets the same set of arguments in each chain, defined here: https://paritytech.github.io/substrate/master/sc_cli/commands/struct.RunCmd.html
the subcommand is different per chain, such as:

https://paritytech.github.io/substrate/master/node_template/cli/enum.Subcommand.html
https://paritytech.github.io/substrate/master/node_cli/enum.Subcommand.html