Feat/docs #60
Feat/docs #60
Conversation
Signed-off-by: meows <b5c6@protonmail.com>
Signed-off-by: meows <b5c6@protonmail.com>
Signed-off-by: meows <b5c6@protonmail.com>
Signed-off-by: meows <b5c6@protonmail.com>
Signed-off-by: meows <b5c6@protonmail.com>
Signed-off-by: meows <b5c6@protonmail.com>
meowsbits
requested review from
ChrisXK and
tzdybal
and removed request for
ChrisXK
|
In general, a part of a larger idea to build and coerce docs for core-geth in a better way. Maybe that can be shared with the core-geth.org website, etc... I moved a lot of the content from the README into the ./docs/core folder for now, into something that might approximate sections of a webpage or pages of a gitbook. Most if not all of this content moved is upstream-duplicating, could use a freshen. Added a focus on How to get started to README, including Docker stuff moar now. Fixed a few links. Updated the comparison table. |
|
|
||
| | Command | Description | | ||
| | :----------: | ------------- | | ||
| | **`geth`** | Our main Ethereum CLI client. It is the entry point into the Ethereum network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `geth --help` and the [CLI Wiki page](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options) for command line options. | |
There was a problem hiding this comment.
Is the link correct? What about options not supported by EF, like --classic?
| | `gethrpctest` | Developer utility tool to support our [ethereum/rpc-test](https://github.com/ethereum/rpc-tests) test suite which validates baseline conformity to the [Ethereum JSON RPC](https://github.com/ethereum/wiki/wiki/JSON-RPC) specs. Please see the [test suite's readme](https://github.com/ethereum/rpc-tests/blob/master/README.md) for details. | | ||
| | `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://github.com/ethereum/wiki/wiki/RLP)) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`). | | ||
| | `puppeth` | a CLI wizard that aids in creating a new Ethereum network. | | ||
|
|
There was a problem hiding this comment.
We should at least mention echaindb and echainspec.
| ## Running `geth` | ||
|
|
||
| Going through all the possible command line flags is out of scope here (please consult our | ||
| [CLI Wiki page](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options)), |
There was a problem hiding this comment.
Again, this link won't include --classic.
| fast-sync quickly to the current state of the network. To do so: | ||
|
|
||
| ``` | ||
| $ geth [|--classic|--social|--ethersocial|--mix|--music|--testnet|--rinkeby|--kotti|--goerli|--mordor] console |
There was a problem hiding this comment.
(Was signifying that no flag is ok too; an optional any of.)
| The `console` subcommand has the exact same meaning as above and they are equally | ||
| useful on the testnet too. Please see above for their explanations if you've skipped here. | ||
|
|
||
| Specifying the `--testnet` flag, however, will reconfigure your `geth` instance a bit: |
There was a problem hiding this comment.
Maybe we should use --mordor instead of --testnet? But on the other hand, testnet is more expressive ;)
|
@tzdybal Agreed on all points; these are all related to content which would now be in |
Improving documentation. Ref #61.