From 6ba977e701bcec908b94f3198668ca837a1a6328 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jakub=20Soko=C5=82owski?= Date: Tue, 16 Nov 2021 15:48:05 +0100 Subject: [PATCH] clean up docs headers, add layout to all MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Splits docs to use three different `permalink` paths: - `/raw/` - `/draft/` - `/stable/` Otherwise docs like these clash and only one is accessible: ``` docs/draft/3-whisper-usage.md docs/stable/3-whisper-usage.md ``` ``` docs/draft/6-payloads.md docs/stable/6-payloads.md ``` Signed-off-by: Jakub SokoĊ‚owski --- DEVELOPMENT.md | 5 +++++ STYLE-GUIDELINE.md | 2 +- docs/draft/12-sticker-pack.md | 5 +++-- docs/draft/13-3rd-party.md | 5 +++-- docs/draft/14-DAPP-BROWSER.md | 6 +++--- docs/{stable => draft}/15-notifications.md | 11 +++++++++-- docs/draft/16-keycard.md | 5 +++-- docs/draft/3-whisper-usage.md | 5 +++-- docs/draft/6-payloads.md | 5 +++-- docs/draft/7-group-chat.md | 5 +++-- docs/draft/draft.md | 4 ++-- docs/raw/push-notification-server.md | 5 +++-- docs/raw/raw.md | 4 ++-- docs/{stable => spec}/1-client.md | 3 ++- docs/{stable => spec}/10-waku-usage.md | 3 ++- docs/{stable => spec}/11-waku-mailserver.md | 3 ++- docs/{stable => spec}/2-account.md | 3 ++- docs/{stable => spec}/3-whisper-usage.md | 3 ++- docs/{stable => spec}/4-whisper-mailserver.md | 3 ++- docs/{stable => spec}/5-secure-transport.md | 3 ++- docs/{stable => spec}/6-payloads.md | 3 ++- docs/{stable => spec}/8-eips.md | 3 ++- docs/{stable => spec}/9-ethereum-usage.md | 3 ++- docs/{stable => spec}/stable.md | 4 ++-- wordlist.txt | 1 + 25 files changed, 66 insertions(+), 36 deletions(-) rename docs/{stable => draft}/15-notifications.md (94%) rename docs/{stable => spec}/1-client.md (99%) rename docs/{stable => spec}/10-waku-usage.md (99%) rename docs/{stable => spec}/11-waku-mailserver.md (99%) rename docs/{stable => spec}/2-account.md (99%) rename docs/{stable => spec}/3-whisper-usage.md (99%) rename docs/{stable => spec}/4-whisper-mailserver.md (99%) rename docs/{stable => spec}/5-secure-transport.md (99%) rename docs/{stable => spec}/6-payloads.md (99%) rename docs/{stable => spec}/8-eips.md (99%) rename docs/{stable => spec}/9-ethereum-usage.md (99%) rename docs/{stable => spec}/stable.md (75%) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index b1aab4b..e3da64f 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -1,3 +1,8 @@ +--- +permalink: /development +title: DEVELOPMENT +layout: default +--- # Description This file explains the process of local development for this repository. diff --git a/STYLE-GUIDELINE.md b/STYLE-GUIDELINE.md index 3052da0..f7a6025 100644 --- a/STYLE-GUIDELINE.md +++ b/STYLE-GUIDELINE.md @@ -1,7 +1,7 @@ --- -layout: default permalink: /style-guideline title: STYLE-GUIDELINE +layout: default --- # Style guidelines for Status client specifications diff --git a/docs/draft/12-sticker-pack.md b/docs/draft/12-sticker-pack.md index d1fd838..8351b39 100644 --- a/docs/draft/12-sticker-pack.md +++ b/docs/draft/12-sticker-pack.md @@ -1,7 +1,8 @@ --- -permalink: /spec/12 -parent: Draft specs +permalink: /draft/12 title: 12/IPFS gateway for Sticker Pack +parent: Draft specs +layout: default --- # 12/IPFS gateway for Sticker Pack diff --git a/docs/draft/13-3rd-party.md b/docs/draft/13-3rd-party.md index c366a6d..db40e31 100644 --- a/docs/draft/13-3rd-party.md +++ b/docs/draft/13-3rd-party.md @@ -1,7 +1,8 @@ --- -permalink: /spec/13 -parent: Draft specs +permalink: /draft/13 title: 13/3RD-PARTY-USAGE +parent: Draft specs +layout: default --- # 13/3RD-PARTY diff --git a/docs/draft/14-DAPP-BROWSER.md b/docs/draft/14-DAPP-BROWSER.md index 429e6bf..1afbec5 100644 --- a/docs/draft/14-DAPP-BROWSER.md +++ b/docs/draft/14-DAPP-BROWSER.md @@ -1,10 +1,10 @@ --- -title: Dapp browser API usage +permalink: /draft/14 +title: 14/Dapp browser API usage version: 0.1.0 -permalink: /spec/14 parent: Draft specs -status: Draft authors: +layout: default --- # Dapp browser API usage diff --git a/docs/stable/15-notifications.md b/docs/draft/15-notifications.md similarity index 94% rename from docs/stable/15-notifications.md rename to docs/draft/15-notifications.md index f13ce62..4664b5f 100644 --- a/docs/stable/15-notifications.md +++ b/docs/draft/15-notifications.md @@ -1,11 +1,18 @@ --- -permalink: /spec/15 -parent: Stable specs +permalink: /draft/15 title: 15/NOTIFICATIONS +parent: Stable specs +layout: default --- # 15/NOTIFICATIONS +> Version: 0.1 +> +> Status: Draft +> +> Authors: Eric Dvorsak + ## Local Notifications A client should implement local notifications to offer notifications for any event in the app without the privacy cost and dependency on third party services. This means that the client should run a background service to continuously or periodically check for updates. diff --git a/docs/draft/16-keycard.md b/docs/draft/16-keycard.md index 0215a77..3fabddc 100644 --- a/docs/draft/16-keycard.md +++ b/docs/draft/16-keycard.md @@ -1,11 +1,12 @@ --- +permalink: /draft/16 title: 16/Keycard Usage for Wallet and Chat Keys version: 0.1 -status: Draft +parent: Draft specs authors: Roman Volosovskyi -permalink: /specs/16 redirect_from: - /keycard.html +layout: default --- ## Table of Contents diff --git a/docs/draft/3-whisper-usage.md b/docs/draft/3-whisper-usage.md index 114ebdd..5beb583 100644 --- a/docs/draft/3-whisper-usage.md +++ b/docs/draft/3-whisper-usage.md @@ -1,7 +1,8 @@ --- -permalink: /spec/3 -parent: Draft specs +permalink: /draft/3 title: 3/WHISPER-USAGE +parent: Draft specs +layout: default --- # 3/WHISPER-USAGE diff --git a/docs/draft/6-payloads.md b/docs/draft/6-payloads.md index 01a3c0f..015e9ee 100644 --- a/docs/draft/6-payloads.md +++ b/docs/draft/6-payloads.md @@ -1,7 +1,8 @@ --- -permalink: /spec/6 -parent: Draft specs +permalink: /draft/6 title: 6/PAYLOADS +parent: Draft specs +layout: default --- # 6/PAYLOADS diff --git a/docs/draft/7-group-chat.md b/docs/draft/7-group-chat.md index 46a876a..96db78f 100644 --- a/docs/draft/7-group-chat.md +++ b/docs/draft/7-group-chat.md @@ -1,7 +1,8 @@ --- -permalink: /spec/7 -parent: Draft specs +permalink: /draft/7 title: 7/GROUP-CHAT +parent: Draft specs +layout: default --- # 7/GROUP-CHAT diff --git a/docs/draft/draft.md b/docs/draft/draft.md index f326a40..afa5dc2 100644 --- a/docs/draft/draft.md +++ b/docs/draft/draft.md @@ -1,7 +1,7 @@ --- -layout: default +permalink: /draft/ title: Draft specs nav_order: 2 has_children: true -permalink: /specs/draft +layout: default --- diff --git a/docs/raw/push-notification-server.md b/docs/raw/push-notification-server.md index de53d51..3a9be46 100644 --- a/docs/raw/push-notification-server.md +++ b/docs/raw/push-notification-server.md @@ -1,7 +1,8 @@ --- -permalink: /spec/16 -parent: Stable specs +permalink: /raw/16 title: 16/PUSH-NOTIFICATION-SERVER +parent: Raw specs +layout: default --- # 16/PUSH-NOTIFICATION-SERVER diff --git a/docs/raw/raw.md b/docs/raw/raw.md index 416d1b5..e4ab0d1 100644 --- a/docs/raw/raw.md +++ b/docs/raw/raw.md @@ -1,7 +1,7 @@ --- -layout: default title: Raw specs -permalink: /specs/raw +permalink: /raw/ nav_order: 2 has_children: true +layout: default --- diff --git a/docs/stable/1-client.md b/docs/spec/1-client.md similarity index 99% rename from docs/stable/1-client.md rename to docs/spec/1-client.md index 9b1a691..0e7e263 100644 --- a/docs/stable/1-client.md +++ b/docs/spec/1-client.md @@ -1,7 +1,8 @@ --- permalink: /spec/1 -parent: Stable specs title: 1/CLIENT +parent: Stable specs +layout: default --- # 1/CLIENT diff --git a/docs/stable/10-waku-usage.md b/docs/spec/10-waku-usage.md similarity index 99% rename from docs/stable/10-waku-usage.md rename to docs/spec/10-waku-usage.md index e436ff3..6117119 100644 --- a/docs/stable/10-waku-usage.md +++ b/docs/spec/10-waku-usage.md @@ -1,7 +1,8 @@ --- permalink: /spec/10 -parent: Stable specs title: 10/WAKU-USAGE +parent: Stable specs +layout: default --- # 10/WAKU-USAGE diff --git a/docs/stable/11-waku-mailserver.md b/docs/spec/11-waku-mailserver.md similarity index 99% rename from docs/stable/11-waku-mailserver.md rename to docs/spec/11-waku-mailserver.md index 60d1d36..58e167b 100644 --- a/docs/stable/11-waku-mailserver.md +++ b/docs/spec/11-waku-mailserver.md @@ -1,7 +1,8 @@ --- permalink: /spec/11 -parent: Stable specs title: 11/WAKU-MAILSERVER +parent: Stable specs +layout: default --- # 11/WAKU-MAILSERVER diff --git a/docs/stable/2-account.md b/docs/spec/2-account.md similarity index 99% rename from docs/stable/2-account.md rename to docs/spec/2-account.md index 4fdc3a5..f03c1f1 100644 --- a/docs/stable/2-account.md +++ b/docs/spec/2-account.md @@ -1,7 +1,8 @@ --- permalink: /spec/2 -parent: Stable specs title: 2/ACCOUNT +parent: Stable specs +layout: default --- # 2/ACCOUNT diff --git a/docs/stable/3-whisper-usage.md b/docs/spec/3-whisper-usage.md similarity index 99% rename from docs/stable/3-whisper-usage.md rename to docs/spec/3-whisper-usage.md index 3925250..f9652fd 100644 --- a/docs/stable/3-whisper-usage.md +++ b/docs/spec/3-whisper-usage.md @@ -1,7 +1,8 @@ --- permalink: /spec/3 -parent: Stable specs title: 3/WHISPER-USAGE +parent: Stable specs +layout: default --- # 3/WHISPER-USAGE diff --git a/docs/stable/4-whisper-mailserver.md b/docs/spec/4-whisper-mailserver.md similarity index 99% rename from docs/stable/4-whisper-mailserver.md rename to docs/spec/4-whisper-mailserver.md index e756af0..f435f7f 100644 --- a/docs/stable/4-whisper-mailserver.md +++ b/docs/spec/4-whisper-mailserver.md @@ -1,7 +1,8 @@ --- permalink: /spec/4 -parent: Stable specs title: 4/WHISPER-MAILSERVER +parent: Stable specs +layout: default --- # 4/WHISPER-MAILSERVER diff --git a/docs/stable/5-secure-transport.md b/docs/spec/5-secure-transport.md similarity index 99% rename from docs/stable/5-secure-transport.md rename to docs/spec/5-secure-transport.md index 4299183..29b1d4d 100644 --- a/docs/stable/5-secure-transport.md +++ b/docs/spec/5-secure-transport.md @@ -1,7 +1,8 @@ --- permalink: /spec/5 -parent: Stable specs title: 5/SECURE-TRANSPORT +parent: Stable specs +layout: default --- # 5/SECURE-TRANSPORT diff --git a/docs/stable/6-payloads.md b/docs/spec/6-payloads.md similarity index 99% rename from docs/stable/6-payloads.md rename to docs/spec/6-payloads.md index 1039abb..3937e78 100644 --- a/docs/stable/6-payloads.md +++ b/docs/spec/6-payloads.md @@ -1,7 +1,8 @@ --- permalink: /spec/6 -parent: Stable specs title: 6/PAYLOADS +parent: Stable specs +layout: default --- # 6/PAYLOADS diff --git a/docs/stable/8-eips.md b/docs/spec/8-eips.md similarity index 99% rename from docs/stable/8-eips.md rename to docs/spec/8-eips.md index adb0ee9..1d15f34 100644 --- a/docs/stable/8-eips.md +++ b/docs/spec/8-eips.md @@ -1,7 +1,8 @@ --- permalink: /spec/8 -parent: Stable specs title: 8/EIPS +parent: Stable specs +layout: default --- # 8/EIPS diff --git a/docs/stable/9-ethereum-usage.md b/docs/spec/9-ethereum-usage.md similarity index 99% rename from docs/stable/9-ethereum-usage.md rename to docs/spec/9-ethereum-usage.md index ed3a141..0a3eac8 100644 --- a/docs/stable/9-ethereum-usage.md +++ b/docs/spec/9-ethereum-usage.md @@ -1,7 +1,8 @@ --- permalink: /spec/9 -parent: Stable specs title: 9/ETHEREUM-USAGE +parent: Stable specs +layout: default --- # 9/ETHEREUM-USAGE diff --git a/docs/stable/stable.md b/docs/spec/stable.md similarity index 75% rename from docs/stable/stable.md rename to docs/spec/stable.md index 02de9b4..6c4027f 100644 --- a/docs/stable/stable.md +++ b/docs/spec/stable.md @@ -1,7 +1,7 @@ --- -layout: default +permalink: /spec/ title: Stable specs nav_order: 1 has_children: true -permalink: /specs/stable +layout: default --- diff --git a/wordlist.txt b/wordlist.txt index a46206b..f1bd150 100644 --- a/wordlist.txt +++ b/wordlist.txt @@ -70,6 +70,7 @@ Diffie discoverable DNS DoS +Dvorsak ECDSA ecies ECIES