diff --git a/_config.yml b/_config.yml index 9d7db00164..3894867fe6 100644 --- a/_config.yml +++ b/_config.yml @@ -45,13 +45,13 @@ collections: output: true permalink: docs/:collection/:slug caption: For dApp Developers - frontpage: _dapp/index.md + frontpage: _dapp/native.md sidebar_index: 4 rpc: output: true permalink: docs/:collection/:slug caption: JSON RPC APIs - frontpage: _rpc/index.md + frontpage: _rpc/server.md sidebar_index: 5 developers: output: true @@ -64,7 +64,7 @@ collections: permalink: docs/:collection/:slug caption: Clef sidebar_index: 7 - frontpage: _clef/Overview.md + frontpage: _clef/Tutorial.md whisper: output: true permalink: docs/:collection/:slug diff --git a/_layouts/sidebar.html b/_layouts/sidebar.html index 8ca0d077e3..feffca8cc2 100644 --- a/_layouts/sidebar.html +++ b/_layouts/sidebar.html @@ -2,36 +2,37 @@ layout: default --- -{% assign toplevels = site.collections| where_exp: "item", "item.sidebar_index" | sort:"sidebar_index" %} +{% assign toplevels = site.collections | where_exp: "item", "item.sidebar_index" | sort:"sidebar_index" %}
-
-{% for group in toplevels %} - {% assign frontdoc=group.docs| where_exp: "doc","doc.path == group.frontpage"|first %} - {% unless frontdoc %} - {% assign frontdoc=group.docs[0] %} - {% endunless %} - {% capture target %}{% include link.html url=frontdoc.url %}{% endcapture %} -
- {{ group.caption }} - {% if page.collection == group.label %} - {% for doc in group.docs %} - {% assign classmodifier="" %} - {% if doc.url == page.url %} - {% assign classmodifier="disabled" %} - {% endif %} - {% capture target %}{% include link.html url=doc.url %}{% endcapture %} - {% include title.html doc=doc coll=group %} - {% endfor %} - {% endif %} +
+ {% for group in toplevels %} + {% assign frontdoc=group.docs| where_exp: "doc","doc.path == group.frontpage"|first %} + {% unless frontdoc %} + {% assign frontdoc=group.docs[0] %} + {% endunless %} + {% capture target %}{% include link.html url=frontdoc.url %}{% endcapture %} +
+ {{ group.caption }} + {% if page.collection == group.label %} + {% assign subpages = group.docs | sort_natural:"title" | sort:"sort_key" %} + {% for doc in subpages %} + {% assign classmodifier="" %} + {% if doc.url == page.url %} + {% assign classmodifier="disabled" %} + {% endif %} + {% capture target %}{% include link.html url=doc.url %}{% endcapture %} + {% include title.html doc=doc coll=group %} + {% endfor %} + {% endif %}
-{% endfor %} + {% endfor %}
-{% if page.title %} -

{% include title.html doc=page coll=page.collection %}

-{% endif %} - {{ content }} + {% if page.title %} +

{% include title.html doc=page coll=page.collection %}

+ {% endif %} + {{ content }}
diff --git a/docs/_clef/Rules.md b/docs/_clef/Rules.md index 200d2519f2..9441181716 100644 --- a/docs/_clef/Rules.md +++ b/docs/_clef/Rules.md @@ -1,5 +1,6 @@ --- title: Rules +sort_key: B --- The `signer` binary contains a ruleset engine, implemented with [OttoVM](https://github.com/robertkrimen/otto) diff --git a/docs/_clef/Setup.md b/docs/_clef/Setup.md index f4b083780d..297f8ddea3 100644 --- a/docs/_clef/Setup.md +++ b/docs/_clef/Setup.md @@ -1,5 +1,6 @@ --- title: Advanced setup +sort_key: B --- diff --git a/docs/_clef/Tutorial.md b/docs/_clef/Tutorial.md index a0c4a31aed..513169f682 100644 --- a/docs/_clef/Tutorial.md +++ b/docs/_clef/Tutorial.md @@ -1,5 +1,6 @@ --- title: Tutorial +sort_key: A --- ## Initializing Clef diff --git a/docs/_clef/apis.md b/docs/_clef/apis.md index 1bfad02ab9..1932a87fd7 100644 --- a/docs/_clef/apis.md +++ b/docs/_clef/apis.md @@ -1,5 +1,6 @@ --- title: Communication APIs +sort_key: C --- ### External API diff --git a/docs/_clef/datatypes.md b/docs/_clef/datatypes.md index c38a621e96..75f7e1914f 100644 --- a/docs/_clef/datatypes.md +++ b/docs/_clef/datatypes.md @@ -1,5 +1,6 @@ --- title: Communication data types +sort_key: C --- ## UI Client interface diff --git a/docs/_developers/Code-Review-Guidelines.md b/docs/_developers/Code-Review-Guidelines.md index b346c03f86..cfe6ae85d3 100644 --- a/docs/_developers/Code-Review-Guidelines.md +++ b/docs/_developers/Code-Review-Guidelines.md @@ -1,6 +1,8 @@ --- title: Code Review Guidelines +sort_key: B --- + The only way to get code into go-ethereum is to send a pull request. Those pull requests need to be reviewed by someone. This document is a guide that explains our expectations around PRs for both authors and reviewers. diff --git a/docs/_developers/devguide.md b/docs/_developers/devguide.md index 1247dcf55f..0a26486b32 100644 --- a/docs/_developers/devguide.md +++ b/docs/_developers/devguide.md @@ -1,5 +1,6 @@ --- title: Developer guide +sort_key: A --- **NOTE: These instructions are for people who want to contribute Go source code changes. diff --git a/docs/_developers/issue-handling-workflow.md b/docs/_developers/issue-handling-workflow.md index bc936260ad..9fb2bdc180 100644 --- a/docs/_developers/issue-handling-workflow.md +++ b/docs/_developers/issue-handling-workflow.md @@ -1,7 +1,10 @@ --- -title: Issue handling workflow +title: Issue Handling Workflow +sort_key: B --- + ### (Draft proposal) + Keep the number of open issues under 820 Keep the ratio of open issues per all issues under 13% @@ -51,4 +54,4 @@ We have a weekly or bi-weekly triage meeting. Issues are preselected by [labelli Optional further activities: * Label the issue with the appropriate area/component. -* Add a section to the FAQ or add a wiki page. Link to it from the issue. \ No newline at end of file +* Add a section to the FAQ or add a wiki page. Link to it from the issue. diff --git a/docs/_getting-started/dev-mode.md b/docs/_getting-started/dev-mode.md index dff4f46bc7..f3e95dad59 100644 --- a/docs/_getting-started/dev-mode.md +++ b/docs/_getting-started/dev-mode.md @@ -1,5 +1,6 @@ --- title: Dev mode +sort_key: B --- Geth has a development mode which sets up a single node Ethereum test network with a number of options optimized for developing on local machines. You enable it with the `--dev` argument. diff --git a/docs/_getting-started/index.md b/docs/_getting-started/index.md index eec668f942..99b2aeb4df 100644 --- a/docs/_getting-started/index.md +++ b/docs/_getting-started/index.md @@ -1,6 +1,7 @@ --- title: Getting Started with Geth -permalink: getting-started +permalink: docs/getting-started +sort_key: A --- ## Installing diff --git a/docs/_getting-started/private-net.md b/docs/_getting-started/private-net.md index bde6a73bf5..dd778b0aef 100644 --- a/docs/_getting-started/private-net.md +++ b/docs/_getting-started/private-net.md @@ -1,5 +1,6 @@ --- title: Private Network Tutorial +sort_key: B --- This page describes how to set up a local cluster of nodes, advise how to make it private, diff --git a/docs/_install-and-build/Backup--restore.md b/docs/_install-and-build/Backup--restore.md index e2f1820c0a..8c41794eae 100644 --- a/docs/_install-and-build/Backup--restore.md +++ b/docs/_install-and-build/Backup--restore.md @@ -1,6 +1,8 @@ --- title: Backup & restore +sort_key: C --- + **DO NOT FORGET YOUR PASSWORD** and **BACKUP YOUR KEYSTORE** diff --git a/docs/_install-and-build/Installing-Geth.md b/docs/_install-and-build/Installing-Geth.md index 4bb19b2192..6d74af753f 100644 --- a/docs/_install-and-build/Installing-Geth.md +++ b/docs/_install-and-build/Installing-Geth.md @@ -1,5 +1,6 @@ --- title: Installing Geth +sort_key: A --- You can install the Go implementation of Ethereum using a variety of ways. These include installing it via your favorite package manager; downloading a standalone pre-built bundle; running as a docker container; or building it yourself. This document details all of the possibilities to get you joining the Ethereum network using whatever means you prefer. diff --git a/docs/_install-and-build/cross-compile.md b/docs/_install-and-build/cross-compile.md index 6fcd561d6d..55af4e6652 100644 --- a/docs/_install-and-build/cross-compile.md +++ b/docs/_install-and-build/cross-compile.md @@ -1,5 +1,6 @@ --- title: Cross-Compiling Geth +sort_key: C --- **Note: All of these and much more have been merged into the project Makefile. You can diff --git a/docs/_interface/FAQ.md b/docs/_interface/FAQ.md index c47dd6138c..e9ff954be8 100644 --- a/docs/_interface/FAQ.md +++ b/docs/_interface/FAQ.md @@ -1,5 +1,6 @@ --- title: FAQ +permalink: docs/faq --- **Q.** I noticed my peercount slowly decrease, and now it is at 0. Restarting doesn't get any peers. diff --git a/docs/_rpc/ns-admin.md b/docs/_rpc/ns-admin.md index adf3e92784..d9f713c2b8 100644 --- a/docs/_rpc/ns-admin.md +++ b/docs/_rpc/ns-admin.md @@ -1,5 +1,6 @@ --- title: admin Namespace +sort_key: C --- The `admin` API gives you access to several non-standard RPC methods, which will allow you to have diff --git a/docs/_rpc/ns-debug.md b/docs/_rpc/ns-debug.md index 65ddce39ca..6ba8fc8b73 100644 --- a/docs/_rpc/ns-debug.md +++ b/docs/_rpc/ns-debug.md @@ -1,5 +1,6 @@ --- title: debug Namespace +sort_key: C --- The `debug` API gives you access to several non-standard RPC methods, which will allow you diff --git a/docs/_rpc/ns-eth.md b/docs/_rpc/ns-eth.md index 47b0dba5ad..a0a19f23c3 100644 --- a/docs/_rpc/ns-eth.md +++ b/docs/_rpc/ns-eth.md @@ -1,5 +1,6 @@ --- title: eth Namespace +sort_key: C --- Geth provides several extensions to the standard "eth" JSON-RPC namespace. diff --git a/docs/_rpc/ns-miner.md b/docs/_rpc/ns-miner.md index d91d46a753..f8ca0775d5 100644 --- a/docs/_rpc/ns-miner.md +++ b/docs/_rpc/ns-miner.md @@ -1,5 +1,6 @@ --- title: miner Namespace +sort_key: C --- The `miner` API allows you to remote control the node's mining operation and set various diff --git a/docs/_rpc/ns-personal.md b/docs/_rpc/ns-personal.md index 0a2d4f11ac..a7a55eeb7b 100644 --- a/docs/_rpc/ns-personal.md +++ b/docs/_rpc/ns-personal.md @@ -1,5 +1,6 @@ --- title: personal Namespace +sort_key: C --- The personal API manages private keys in the key store. diff --git a/docs/_rpc/ns-txpool.md b/docs/_rpc/ns-txpool.md index e88d9ab9b2..fd115aa835 100644 --- a/docs/_rpc/ns-txpool.md +++ b/docs/_rpc/ns-txpool.md @@ -1,5 +1,6 @@ --- title: txpool Namespace +sort_key: C --- The `txpool` API gives you access to several non-standard RPC methods to inspect the contents of the diff --git a/docs/_rpc/pubsub.md b/docs/_rpc/pubsub.md index b4f24aacc8..a6de88b06c 100644 --- a/docs/_rpc/pubsub.md +++ b/docs/_rpc/pubsub.md @@ -1,5 +1,6 @@ --- title: Real-time Events +sort_key: B --- Geth v1.4 and later support publish / subscribe using JSON-RPC notifications. This allows diff --git a/docs/_rpc/server.md b/docs/_rpc/server.md index db9ea54514..4906ab4aa4 100644 --- a/docs/_rpc/server.md +++ b/docs/_rpc/server.md @@ -1,5 +1,6 @@ --- title: JSON-RPC Server +sort_key: A --- Geth supports all standard web3 JSON-RPC APIs. You can find documentation for diff --git a/docs/_whisper/Achieving-Darkness.md b/docs/_whisper/Achieving-Darkness.md index 7b171bee74..c76ceb3dfc 100644 --- a/docs/_whisper/Achieving-Darkness.md +++ b/docs/_whisper/Achieving-Darkness.md @@ -1,6 +1,8 @@ --- title: Achieving Darkness +sort_key: B --- + Whisper is designed to be a building block in the next generation of unstoppable ÐApps. It was designed to provide resilience and privacy at considerable expense. At its most secure mode of operation Whisper can theoretically deliver complete darkness. Whisper should also allow the users to configure the level of privacy (how much information it leaks concerning the ÐApp content and ultimately, user activities) as a trade-off for performance. In this article we will discuss the strategy of achieving complete darkness. ### Adversary diff --git a/docs/_whisper/Diagnostic-Tool-wnode.md b/docs/_whisper/Diagnostic-Tool-wnode.md index 56ee1ed2b5..38565f4297 100644 --- a/docs/_whisper/Diagnostic-Tool-wnode.md +++ b/docs/_whisper/Diagnostic-Tool-wnode.md @@ -1,7 +1,7 @@ --- title: Diagnostic tool wnode +sort_key: B --- -# Wnode Wnode (whisper node) is a command-line diagnostic tool. It does not have a nice user interface, because its main purpose is diagnostic, and it's meant to be very light-weight rather than beautiful. Wnode might be used for different purposes, including: diff --git a/docs/_whisper/How-to-Whisper.md b/docs/_whisper/How-to-Whisper.md index 18fdd56e93..c385a7b899 100644 --- a/docs/_whisper/How-to-Whisper.md +++ b/docs/_whisper/How-to-Whisper.md @@ -1,9 +1,11 @@ --- title: How to Whisper +sort_key: B --- + Whisper is a pure identity-based messaging system. Whisper provides a low-level (non-application-specific) but easily-accessible API without being based upon or prejudiced by the low-level hardware attributes and characteristics, particularly the notion of singular endpoints. -This tutorial assumes you've read [p2p 101](../developers/peer-to-peer). If you haven't read it I suggest you read it. This tutorial will guide you to setting up a full p2p server with whisper capabilities. +This tutorial will guide you to setting up a full p2p server with whisper capabilities. Let's quickly cover some of whisper's basic functionality and discuss it in greater detail later. @@ -97,4 +99,4 @@ func main() { select {} } -``` \ No newline at end of file +``` diff --git a/docs/_whisper/Whisper-Overview.md b/docs/_whisper/Whisper-Overview.md index 9977e4bc8e..62cb201075 100644 --- a/docs/_whisper/Whisper-Overview.md +++ b/docs/_whisper/Whisper-Overview.md @@ -1,5 +1,6 @@ --- title: Overview +sort_key: A --- Whisper is a pure identity-based messaging system. Whisper provides a simple low-level API without being based upon or influenced by the low-level hardware attributes and characteristics. Peer-to-peer communication between the nodes of Whisper network uses the underlying [ÐΞVp2p Wire Protocol](https://github.com/ethereum/wiki/wiki/%C3%90%CE%9EVp2p-Wire-Protocol). Whisper was not designed to provide a connection-oriented system, nor for simply delivering data between a pair of particular network endpoints. However, this might be necessary in some very specific cases (e.g. delivering the expired messages in case they were missed), and Whisper protocol will accommodate for that. Whisper is designed for easy and efficient broadcasting, and also for low-level asynchronous communications. It is designed to be a building block in next generation of unstoppable ÐApps. It was designed to provide resilience and privacy at considerable expense. At its most secure mode of operation, Whisper can theoretically deliver 100% darkness. Whisper should also allow the users to configure the level of privacy (how much information it leaks concerning the ÐApp content and ultimately, user activities) as a trade-off for performance. diff --git a/docs/_whisper/Whisper-js-example.md b/docs/_whisper/Whisper-js-example.md index edc8d66e2e..3fb350924f 100644 --- a/docs/_whisper/Whisper-js-example.md +++ b/docs/_whisper/Whisper-js-example.md @@ -1,5 +1,6 @@ --- title: Whisper JavaScript example +sort_key: B --- [This link](https://github.com/gballet/whisper-chat-example) contains a full-fledged example of how to use Whisper in a small chat application. diff --git a/docs/_whisper/Whisper-v6-RPC-API.md b/docs/_whisper/Whisper-v6-RPC-API.md index 70aa01953f..966c367fbd 100644 --- a/docs/_whisper/Whisper-v6-RPC-API.md +++ b/docs/_whisper/Whisper-v6-RPC-API.md @@ -1,5 +1,6 @@ --- title: Whisper RPC API 6.0 +sort_key: C --- This is the proposed API for whisper v6. @@ -782,4 +783,4 @@ curl -X POST --data '{"jsonrpc":"2.0","method":"shh_post","params":[{ "jsonrpc": "2.0", "result": true } -``` \ No newline at end of file +```