From 8ef27a2e10a21486c3ef832b84ece155e95df798 Mon Sep 17 00:00:00 2001 From: Samuel Hawksby-Robinson Date: Mon, 25 May 2020 09:29:11 +0100 Subject: [PATCH] Update/sequence specs (#130) * re-sequenced new spec numbers resolves GH-127 * re-sequenced new spec numbers resolves GH-127 --- docs/draft/{sticker-pack.md => 12-sticker-pack.md} | 6 +++--- docs/draft/{9-3rd-party.md => 13-3rd-party.md} | 6 +++--- docs/stable/1-client.md | 4 ++-- docs/stable/{9-waku-usage.md => 10-waku-usage.md} | 8 ++++---- .../{10-waku-mailserver.md => 11-waku-mailserver.md} | 8 ++++---- docs/stable/5-secure-transport.md | 2 +- docs/stable/6-payloads.md | 2 +- 7 files changed, 18 insertions(+), 18 deletions(-) rename docs/draft/{sticker-pack.md => 12-sticker-pack.md} (98%) rename docs/draft/{9-3rd-party.md => 13-3rd-party.md} (98%) rename docs/stable/{9-waku-usage.md => 10-waku-usage.md} (99%) rename docs/stable/{10-waku-mailserver.md => 11-waku-mailserver.md} (98%) diff --git a/docs/draft/sticker-pack.md b/docs/draft/12-sticker-pack.md similarity index 98% rename from docs/draft/sticker-pack.md rename to docs/draft/12-sticker-pack.md index b9b6427..93b4378 100644 --- a/docs/draft/sticker-pack.md +++ b/docs/draft/12-sticker-pack.md @@ -1,10 +1,10 @@ --- -permalink: /spec/8 +permalink: /spec/12 parent: Draft specs -title: 8/IPFS gateway for Sticker Pack +title: 12/IPFS gateway for Sticker Pack --- -# 8/IPFS gateway for Sticker Pack +# 12/IPFS gateway for Sticker Pack > Version: 0.1.0 > diff --git a/docs/draft/9-3rd-party.md b/docs/draft/13-3rd-party.md similarity index 98% rename from docs/draft/9-3rd-party.md rename to docs/draft/13-3rd-party.md index 7b79cd0..4e260a6 100644 --- a/docs/draft/9-3rd-party.md +++ b/docs/draft/13-3rd-party.md @@ -1,10 +1,10 @@ --- -permalink: /spec/9 +permalink: /spec/13 parent: Draft specs -title: 9/3RD-PARTY-USAGE +title: 13/3RD-PARTY-USAGE --- -# 9/3RD-PARTY +# 13/3RD-PARTY > Version: 0.1 > diff --git a/docs/stable/1-client.md b/docs/stable/1-client.md index 07e37c1..c67b3f7 100644 --- a/docs/stable/1-client.md +++ b/docs/stable/1-client.md @@ -204,9 +204,9 @@ to use Whisper and/or Waku to communicate with other Status nodes. Once a Whisper and/or Waku node is up and running there are some specific settings required to communicate with other Status nodes. -See [3/WHISPER-USAGE](https://specs.status.im/spec/3) and [9/WAKU-USAGE](https://specs.status.im/spec/9) for more details. +See [3/WHISPER-USAGE](https://specs.status.im/spec/3) and [10/WAKU-USAGE](https://specs.status.im/spec/10) for more details. -For providing an offline inbox, see the complementary [4/WHISPER-MAILSERVER](https://specs.status.im/spec/4) and [10/WAKU-MAILSERVER](https://specs.status.im/spec/10). +For providing an offline inbox, see the complementary [4/WHISPER-MAILSERVER](https://specs.status.im/spec/4) and [11/WAKU-MAILSERVER](https://specs.status.im/spec/11). ### Secure Transport diff --git a/docs/stable/9-waku-usage.md b/docs/stable/10-waku-usage.md similarity index 99% rename from docs/stable/9-waku-usage.md rename to docs/stable/10-waku-usage.md index c3a05bf..9e04353 100644 --- a/docs/stable/9-waku-usage.md +++ b/docs/stable/10-waku-usage.md @@ -1,10 +1,10 @@ --- -permalink: /spec/9 +permalink: /spec/10 parent: Stable specs -title: 9/WAKU-USAGE +title: 10/WAKU-USAGE --- -# 9/WAKU-USAGE +# 10/WAKU-USAGE > Version: 0.1 > @@ -12,7 +12,7 @@ title: 9/WAKU-USAGE > > Authors: Adam Babik , Corey Petty , Oskar Thorén , Samuel Hawksby-Robinson (alphabetical order) -- [Status Waku Usage Specification](#9waku-usage) +- [Status Waku Usage Specification](#10waku-usage) - [Abstract](#abstract) - [Reason](#reason) - [Terminology](#terminology) diff --git a/docs/stable/10-waku-mailserver.md b/docs/stable/11-waku-mailserver.md similarity index 98% rename from docs/stable/10-waku-mailserver.md rename to docs/stable/11-waku-mailserver.md index 5689f25..c71231f 100644 --- a/docs/stable/10-waku-mailserver.md +++ b/docs/stable/11-waku-mailserver.md @@ -1,10 +1,10 @@ --- -permalink: /spec/10 +permalink: /spec/11 parent: Stable specs -title: 10/WAKU-MAILSERVER +title: 11/WAKU-MAILSERVER --- -# 10/WAKU-MAILSERVER +# 11/WAKU-MAILSERVER > Version: 0.1 > @@ -12,7 +12,7 @@ title: 10/WAKU-MAILSERVER > > Authors: Adam Babik , Oskar Thorén , Samuel Hawksby-Robinson (alphabetical order) -- [Status Waku Mailserver Specification](#10waku-mailserver) +- [Status Waku Mailserver Specification](#11waku-mailserver) - [Abstract](#abstract) - [`Mailserver`](#mailserver) - [Archiving messages](#archiving-messages) diff --git a/docs/stable/5-secure-transport.md b/docs/stable/5-secure-transport.md index ecbb1b8..0698634 100644 --- a/docs/stable/5-secure-transport.md +++ b/docs/stable/5-secure-transport.md @@ -77,7 +77,7 @@ Types used in this specification are defined using [Protobuf](https://developers ### Transport Layer -[Whisper](3-whisper-usage.md) and [Waku](9-waku-usage.md) serves as the transport layers for the Status chat protocol. +[Whisper](3-whisper-usage.md) and [Waku](10-waku-usage.md) serves as the transport layers for the Status chat protocol. ### User flow for 1-to-1 communications diff --git a/docs/stable/6-payloads.md b/docs/stable/6-payloads.md index e03cff0..7b90a6f 100644 --- a/docs/stable/6-payloads.md +++ b/docs/stable/6-payloads.md @@ -176,7 +176,7 @@ message StickerMessage { #### Message types -Message types are required to decide how a particular message is encrypted and what metadata needs to be attached when passing a message to the transport layer. For more on this, see [3/WHISPER-USAGE](3-whisper-usage.md) and [9/WAKU-USAGE](9-waku-usage.md). +Message types are required to decide how a particular message is encrypted and what metadata needs to be attached when passing a message to the transport layer. For more on this, see [3/WHISPER-USAGE](3-whisper-usage.md) and [10/WAKU-USAGE](10-waku-usage.md).