From 39f87a27e59a117254a341bb634a580034608623 Mon Sep 17 00:00:00 2001 From: Paul Bellamy Date: Wed, 13 May 2015 11:43:58 +0100 Subject: [PATCH] Add ToC to how-it-works docs page --- site/how-it-works.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/site/how-it-works.md b/site/how-it-works.md index 64acdddb..486a5d18 100644 --- a/site/how-it-works.md +++ b/site/how-it-works.md @@ -5,6 +5,14 @@ layout: default ## How does it work? + * [Overview](#overview) + * [Encapsulation](#encapsulation) + * [Topology](#topology) + * [Crypto](#crypto) + * [Further reading](#further-reading) + +## Overview + A weave network consists of a number of 'peers' - weave routers residing on different hosts. Each peer has a name, which tends to remain the same over restarts, a human friendly nickname for use in @@ -374,6 +382,6 @@ contained in the set. The window spans at least 2^20 message sequence numbers, and hence any re-ordering between the most recent ~1 million messages is handled without dropping messages. -### Further reading +### Further reading More details on the inner workings of weave can be found in the [architecture documentation](https://github.com/weaveworks/weave/blob/master/docs/architecture.txt).