fix sidebar page order

This commit is contained in:
Felix Lange 2019-11-01 13:16:35 +01:00
parent 52a7bc4267
commit 479a41d040
32 changed files with 72 additions and 36 deletions

View file

@ -45,13 +45,13 @@ collections:
output: true output: true
permalink: docs/:collection/:slug permalink: docs/:collection/:slug
caption: For dApp Developers caption: For dApp Developers
frontpage: _dapp/index.md frontpage: _dapp/native.md
sidebar_index: 4 sidebar_index: 4
rpc: rpc:
output: true output: true
permalink: docs/:collection/:slug permalink: docs/:collection/:slug
caption: JSON RPC APIs caption: JSON RPC APIs
frontpage: _rpc/index.md frontpage: _rpc/server.md
sidebar_index: 5 sidebar_index: 5
developers: developers:
output: true output: true
@ -64,7 +64,7 @@ collections:
permalink: docs/:collection/:slug permalink: docs/:collection/:slug
caption: Clef caption: Clef
sidebar_index: 7 sidebar_index: 7
frontpage: _clef/Overview.md frontpage: _clef/Tutorial.md
whisper: whisper:
output: true output: true
permalink: docs/:collection/:slug permalink: docs/:collection/:slug

View file

@ -2,36 +2,37 @@
layout: default 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" %}
<div class="container" style="padding-top: 24px;"> <div class="container" style="padding-top: 24px;">
<div class="row"> <div class="row">
<div class="col-md-3" id="toc" style="padding-top: 16px;"> <div class="col-md-3" id="toc" style="padding-top: 16px;">
{% for group in toplevels %} {% for group in toplevels %}
{% assign frontdoc=group.docs| where_exp: "doc","doc.path == group.frontpage"|first %} {% assign frontdoc=group.docs| where_exp: "doc","doc.path == group.frontpage"|first %}
{% unless frontdoc %} {% unless frontdoc %}
{% assign frontdoc=group.docs[0] %} {% assign frontdoc=group.docs[0] %}
{% endunless %} {% endunless %}
{% capture target %}{% include link.html url=frontdoc.url %}{% endcapture %} {% capture target %}{% include link.html url=frontdoc.url %}{% endcapture %}
<div class="list-group"> <div class="list-group">
<a class="list-group-item active" href="{{ target |strip }}">{{ group.caption }}</a> <a class="list-group-item active" href="{{ target |strip }}">{{ group.caption }}</a>
{% if page.collection == group.label %} {% if page.collection == group.label %}
{% for doc in group.docs %} {% assign subpages = group.docs | sort_natural:"title" | sort:"sort_key" %}
{% assign classmodifier="" %} {% for doc in subpages %}
{% if doc.url == page.url %} {% assign classmodifier="" %}
{% assign classmodifier="disabled" %} {% if doc.url == page.url %}
{% endif %} {% assign classmodifier="disabled" %}
{% capture target %}{% include link.html url=doc.url %}{% endcapture %} {% endif %}
<a class="list-group-item {{classmodifier}}" href="{{ target |strip }}">{% include title.html doc=doc coll=group %}</a> {% capture target %}{% include link.html url=doc.url %}{% endcapture %}
{% endfor %} <a class="list-group-item {{classmodifier}}" href="{{ target |strip }}">{% include title.html doc=doc coll=group %}</a>
{% endif %} {% endfor %}
{% endif %}
</div> </div>
{% endfor %} {% endfor %}
</div> </div>
<div class="col-md-9" id="content"> <div class="col-md-9" id="content">
{% if page.title %} {% if page.title %}
<h1 class="featurette-heading">{% include title.html doc=page coll=page.collection %}</h1> <h1 class="featurette-heading">{% include title.html doc=page coll=page.collection %}</h1>
{% endif %} {% endif %}
{{ content }} {{ content }}
</div> </div>
</div> </div>
</div> </div>

View file

@ -1,5 +1,6 @@
--- ---
title: Rules title: Rules
sort_key: B
--- ---
The `signer` binary contains a ruleset engine, implemented with [OttoVM](https://github.com/robertkrimen/otto) The `signer` binary contains a ruleset engine, implemented with [OttoVM](https://github.com/robertkrimen/otto)

View file

@ -1,5 +1,6 @@
--- ---
title: Advanced setup title: Advanced setup
sort_key: B
--- ---

View file

@ -1,5 +1,6 @@
--- ---
title: Tutorial title: Tutorial
sort_key: A
--- ---
## Initializing Clef ## Initializing Clef

View file

@ -1,5 +1,6 @@
--- ---
title: Communication APIs title: Communication APIs
sort_key: C
--- ---
### External API ### External API

View file

@ -1,5 +1,6 @@
--- ---
title: Communication data types title: Communication data types
sort_key: C
--- ---
## UI Client interface ## UI Client interface

View file

@ -1,6 +1,8 @@
--- ---
title: Code Review Guidelines 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 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 need to be reviewed by someone. This document is a guide that explains our expectations
around PRs for both authors and reviewers. around PRs for both authors and reviewers.

View file

@ -1,5 +1,6 @@
--- ---
title: Developer guide title: Developer guide
sort_key: A
--- ---
**NOTE: These instructions are for people who want to contribute Go source code changes. **NOTE: These instructions are for people who want to contribute Go source code changes.

View file

@ -1,7 +1,10 @@
--- ---
title: Issue handling workflow title: Issue Handling Workflow
sort_key: B
--- ---
### (Draft proposal) ### (Draft proposal)
Keep the number of open issues under 820 Keep the number of open issues under 820
Keep the ratio of open issues per all issues under 13% 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: Optional further activities:
* Label the issue with the appropriate area/component. * 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. * Add a section to the FAQ or add a wiki page. Link to it from the issue.

View file

@ -1,5 +1,6 @@
--- ---
title: Dev mode 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. 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.

View file

@ -1,6 +1,7 @@
--- ---
title: Getting Started with Geth title: Getting Started with Geth
permalink: getting-started permalink: docs/getting-started
sort_key: A
--- ---
## Installing ## Installing

View file

@ -1,5 +1,6 @@
--- ---
title: Private Network Tutorial 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, This page describes how to set up a local cluster of nodes, advise how to make it private,

View file

@ -1,6 +1,8 @@
--- ---
title: Backup & restore title: Backup & restore
sort_key: C
--- ---
**DO NOT FORGET YOUR PASSWORD** and **BACKUP YOUR KEYSTORE** **DO NOT FORGET YOUR PASSWORD** and **BACKUP YOUR KEYSTORE**
<!-- <!--
@ -68,4 +70,4 @@ geth import <filename>
_See https://github.com/ethereum/wiki/wiki/Blockchain-import-export for more info_ _See https://github.com/ethereum/wiki/wiki/Blockchain-import-export for more info_
And finally: **DO NOT FORGET YOUR PASSWORD** and **BACKUP YOUR KEYSTORE** And finally: **DO NOT FORGET YOUR PASSWORD** and **BACKUP YOUR KEYSTORE**

View file

@ -1,5 +1,6 @@
--- ---
title: Build from source title: Build from source
sort_key: B
--- ---
<!-- TODO: Maybe move? --> <!-- TODO: Maybe move? -->

View file

@ -1,5 +1,6 @@
--- ---
title: Installing Geth 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. 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.

View file

@ -1,5 +1,6 @@
--- ---
title: Cross-Compiling Geth title: Cross-Compiling Geth
sort_key: C
--- ---
**Note: All of these and much more have been merged into the project Makefile. You can **Note: All of these and much more have been merged into the project Makefile. You can

View file

@ -1,5 +1,6 @@
--- ---
title: FAQ title: FAQ
permalink: docs/faq
--- ---
**Q.** I noticed my peercount slowly decrease, and now it is at 0. Restarting doesn't get any peers. **Q.** I noticed my peercount slowly decrease, and now it is at 0. Restarting doesn't get any peers.

View file

@ -1,5 +1,6 @@
--- ---
title: admin Namespace title: admin Namespace
sort_key: C
--- ---
The `admin` API gives you access to several non-standard RPC methods, which will allow you to have The `admin` API gives you access to several non-standard RPC methods, which will allow you to have

View file

@ -1,5 +1,6 @@
--- ---
title: debug Namespace title: debug Namespace
sort_key: C
--- ---
The `debug` API gives you access to several non-standard RPC methods, which will allow you The `debug` API gives you access to several non-standard RPC methods, which will allow you

View file

@ -1,5 +1,6 @@
--- ---
title: eth Namespace title: eth Namespace
sort_key: C
--- ---
Geth provides several extensions to the standard "eth" JSON-RPC namespace. Geth provides several extensions to the standard "eth" JSON-RPC namespace.

View file

@ -1,5 +1,6 @@
--- ---
title: miner Namespace title: miner Namespace
sort_key: C
--- ---
The `miner` API allows you to remote control the node's mining operation and set various The `miner` API allows you to remote control the node's mining operation and set various

View file

@ -1,5 +1,6 @@
--- ---
title: personal Namespace title: personal Namespace
sort_key: C
--- ---
The personal API manages private keys in the key store. The personal API manages private keys in the key store.

View file

@ -1,5 +1,6 @@
--- ---
title: txpool Namespace title: txpool Namespace
sort_key: C
--- ---
The `txpool` API gives you access to several non-standard RPC methods to inspect the contents of the The `txpool` API gives you access to several non-standard RPC methods to inspect the contents of the

View file

@ -1,5 +1,6 @@
--- ---
title: Real-time Events title: Real-time Events
sort_key: B
--- ---
Geth v1.4 and later support publish / subscribe using JSON-RPC notifications. This allows Geth v1.4 and later support publish / subscribe using JSON-RPC notifications. This allows

View file

@ -1,5 +1,6 @@
--- ---
title: JSON-RPC Server title: JSON-RPC Server
sort_key: A
--- ---
Geth supports all standard web3 JSON-RPC APIs. You can find documentation for Geth supports all standard web3 JSON-RPC APIs. You can find documentation for

View file

@ -1,6 +1,8 @@
--- ---
title: Achieving Darkness 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. 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 ### Adversary

View file

@ -1,7 +1,7 @@
--- ---
title: Diagnostic tool wnode 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: 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:

View file

@ -1,9 +1,11 @@
--- ---
title: How to Whisper 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. 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. Let's quickly cover some of whisper's basic functionality and discuss it in greater detail later.
@ -97,4 +99,4 @@ func main() {
select {} select {}
} }
``` ```

View file

@ -1,5 +1,6 @@
--- ---
title: Overview 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. 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.

View file

@ -1,5 +1,6 @@
--- ---
title: Whisper JavaScript example 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. [This link](https://github.com/gballet/whisper-chat-example) contains a full-fledged example of how to use Whisper in a small chat application.

View file

@ -1,5 +1,6 @@
--- ---
title: Whisper RPC API 6.0 title: Whisper RPC API 6.0
sort_key: C
--- ---
This is the proposed API for whisper v6. 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", "jsonrpc": "2.0",
"result": true "result": true
} }
``` ```