gaspersic/go-ethereum
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[DOCS] massive documentation update (#20229)

Browse Source 
This PR:

- reorganizes all documentation pages so they live in the right category
- removes lots of legacy docs
- contains many improvements to active documentation pages

Geth user documentation is now spread across five major categories:

- Install and Build: installation and compile instructions
- Using Geth: this is for pages about general geth usage.
- For dApp Developers: this is for programming guides and functionality specific
   to dapp development. All the dev guides for mobile framework and Go APIs live here.
- JSON-RPC APIs: this has its own section because there is now a sub-page for
   every name space. I have also added an overview text that explains how to set
   up the API servers.
- For Geth Developers: this is for geth contributors
This commit is contained in:
Felix Lange
2019-11-05 13:46:00 +01:00
committed by GitHub
parent 86b20d897e
commit 7416b05b81
76 changed files with 3537 additions and 4680 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/index.md
View File

@ -1,21 +1,24 @@
---
title: Documentation
title: Geth Documentation
root: ..
---
* User documentation can be found at our [Ethereum User Guide and reference manual](http://ethereum.gitbooks.io/frontier-guide/content/).
* For the API reference and developer documentation head over to the auto generated [GoDoc](https://godoc.org/github.com/ethereum/go-ethereum) documentation.
This is the documentation for the official Ethereum golang implementation. For generic Ethereum-related information (whitepaper, yellow paper, protocol and interface specs, APIs, DAPP development guides, etc) see the [Ethereum main wiki](https://github.com/ethereum/wiki/wiki).
Main entry points:
You have found the user manual for geth, the Go language implementation of Ethereum.
* [Getting Started Guide](./getting-started)
* [Installation Instructions](./install-and-build/installing-geth)
* [Management APIs](./interface/management-apis)
* [Managing Accounts](./interface/managing-your-accounts)
* [Command Line Options](./interface/command-line-options)
* [JSON-RPC Server](./rpc/server)
* [JavaScript Console](./interface/javascript-console)
* [Private Network](./doc/private-network)
* [Developers' Guide](./install-and-build/developers-guide)
* [Whisper v6](./whisper/whisper-overview)
Sidebar lists all pages.
For the Go API reference and developer documentation head over to
[GoDoc](https://godoc.org/github.com/ethereum/go-ethereum).
### Other Ethereum Documentation
For generic Ethereum-related information, check the **[Ethereum
Wiki](https://github.com/ethereum/wiki/wiki)**.
* [Ethereum Whitepaper](https://github.com/ethereum/wiki/wiki/White-Paper)
* [Ethereum Yellow Paper](https://ethereum.github.io/yellowpaper/paper.pdf)
* [Ethereum Improvement Proposals (EIPs)](https://eips.ethereum.org)
* [Peer-to-peer Networking Specifications](https://github.com/ethereum/devp2p/blob/master/README.md)