mirror of https://github.com/status-im/specs.git
clean up docs headers, add layout to all
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 <jakub@status.im>
This commit is contained in:
parent
d993eb148f
commit
6ba977e701
|
@ -1,3 +1,8 @@
|
||||||
|
---
|
||||||
|
permalink: /development
|
||||||
|
title: DEVELOPMENT
|
||||||
|
layout: default
|
||||||
|
---
|
||||||
# Description
|
# Description
|
||||||
|
|
||||||
This file explains the process of local development for this repository.
|
This file explains the process of local development for this repository.
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
layout: default
|
|
||||||
permalink: /style-guideline
|
permalink: /style-guideline
|
||||||
title: STYLE-GUIDELINE
|
title: STYLE-GUIDELINE
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# Style guidelines for Status client specifications
|
# Style guidelines for Status client specifications
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/12
|
permalink: /draft/12
|
||||||
parent: Draft specs
|
|
||||||
title: 12/IPFS gateway for Sticker Pack
|
title: 12/IPFS gateway for Sticker Pack
|
||||||
|
parent: Draft specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 12/IPFS gateway for Sticker Pack
|
# 12/IPFS gateway for Sticker Pack
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/13
|
permalink: /draft/13
|
||||||
parent: Draft specs
|
|
||||||
title: 13/3RD-PARTY-USAGE
|
title: 13/3RD-PARTY-USAGE
|
||||||
|
parent: Draft specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 13/3RD-PARTY
|
# 13/3RD-PARTY
|
||||||
|
|
|
@ -1,10 +1,10 @@
|
||||||
---
|
---
|
||||||
title: Dapp browser API usage
|
permalink: /draft/14
|
||||||
|
title: 14/Dapp browser API usage
|
||||||
version: 0.1.0
|
version: 0.1.0
|
||||||
permalink: /spec/14
|
|
||||||
parent: Draft specs
|
parent: Draft specs
|
||||||
status: Draft
|
|
||||||
authors:
|
authors:
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# Dapp browser API usage
|
# Dapp browser API usage
|
||||||
|
|
|
@ -1,11 +1,18 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/15
|
permalink: /draft/15
|
||||||
parent: Stable specs
|
|
||||||
title: 15/NOTIFICATIONS
|
title: 15/NOTIFICATIONS
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 15/NOTIFICATIONS
|
# 15/NOTIFICATIONS
|
||||||
|
|
||||||
|
> Version: 0.1
|
||||||
|
>
|
||||||
|
> Status: Draft
|
||||||
|
>
|
||||||
|
> Authors: Eric Dvorsak <eric@status.im>
|
||||||
|
|
||||||
## Local Notifications
|
## 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.
|
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.
|
|
@ -1,11 +1,12 @@
|
||||||
---
|
---
|
||||||
|
permalink: /draft/16
|
||||||
title: 16/Keycard Usage for Wallet and Chat Keys
|
title: 16/Keycard Usage for Wallet and Chat Keys
|
||||||
version: 0.1
|
version: 0.1
|
||||||
status: Draft
|
parent: Draft specs
|
||||||
authors: Roman Volosovskyi <roman@status.im>
|
authors: Roman Volosovskyi <roman@status.im>
|
||||||
permalink: /specs/16
|
|
||||||
redirect_from:
|
redirect_from:
|
||||||
- /keycard.html
|
- /keycard.html
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/3
|
permalink: /draft/3
|
||||||
parent: Draft specs
|
|
||||||
title: 3/WHISPER-USAGE
|
title: 3/WHISPER-USAGE
|
||||||
|
parent: Draft specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 3/WHISPER-USAGE
|
# 3/WHISPER-USAGE
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/6
|
permalink: /draft/6
|
||||||
parent: Draft specs
|
|
||||||
title: 6/PAYLOADS
|
title: 6/PAYLOADS
|
||||||
|
parent: Draft specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 6/PAYLOADS
|
# 6/PAYLOADS
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/7
|
permalink: /draft/7
|
||||||
parent: Draft specs
|
|
||||||
title: 7/GROUP-CHAT
|
title: 7/GROUP-CHAT
|
||||||
|
parent: Draft specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 7/GROUP-CHAT
|
# 7/GROUP-CHAT
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
layout: default
|
permalink: /draft/
|
||||||
title: Draft specs
|
title: Draft specs
|
||||||
nav_order: 2
|
nav_order: 2
|
||||||
has_children: true
|
has_children: true
|
||||||
permalink: /specs/draft
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/16
|
permalink: /raw/16
|
||||||
parent: Stable specs
|
|
||||||
title: 16/PUSH-NOTIFICATION-SERVER
|
title: 16/PUSH-NOTIFICATION-SERVER
|
||||||
|
parent: Raw specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 16/PUSH-NOTIFICATION-SERVER
|
# 16/PUSH-NOTIFICATION-SERVER
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
layout: default
|
|
||||||
title: Raw specs
|
title: Raw specs
|
||||||
permalink: /specs/raw
|
permalink: /raw/
|
||||||
nav_order: 2
|
nav_order: 2
|
||||||
has_children: true
|
has_children: true
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/1
|
permalink: /spec/1
|
||||||
parent: Stable specs
|
|
||||||
title: 1/CLIENT
|
title: 1/CLIENT
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 1/CLIENT
|
# 1/CLIENT
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/10
|
permalink: /spec/10
|
||||||
parent: Stable specs
|
|
||||||
title: 10/WAKU-USAGE
|
title: 10/WAKU-USAGE
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 10/WAKU-USAGE
|
# 10/WAKU-USAGE
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/11
|
permalink: /spec/11
|
||||||
parent: Stable specs
|
|
||||||
title: 11/WAKU-MAILSERVER
|
title: 11/WAKU-MAILSERVER
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 11/WAKU-MAILSERVER
|
# 11/WAKU-MAILSERVER
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/2
|
permalink: /spec/2
|
||||||
parent: Stable specs
|
|
||||||
title: 2/ACCOUNT
|
title: 2/ACCOUNT
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 2/ACCOUNT
|
# 2/ACCOUNT
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/3
|
permalink: /spec/3
|
||||||
parent: Stable specs
|
|
||||||
title: 3/WHISPER-USAGE
|
title: 3/WHISPER-USAGE
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 3/WHISPER-USAGE
|
# 3/WHISPER-USAGE
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/4
|
permalink: /spec/4
|
||||||
parent: Stable specs
|
|
||||||
title: 4/WHISPER-MAILSERVER
|
title: 4/WHISPER-MAILSERVER
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 4/WHISPER-MAILSERVER
|
# 4/WHISPER-MAILSERVER
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/5
|
permalink: /spec/5
|
||||||
parent: Stable specs
|
|
||||||
title: 5/SECURE-TRANSPORT
|
title: 5/SECURE-TRANSPORT
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 5/SECURE-TRANSPORT
|
# 5/SECURE-TRANSPORT
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/6
|
permalink: /spec/6
|
||||||
parent: Stable specs
|
|
||||||
title: 6/PAYLOADS
|
title: 6/PAYLOADS
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 6/PAYLOADS
|
# 6/PAYLOADS
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/8
|
permalink: /spec/8
|
||||||
parent: Stable specs
|
|
||||||
title: 8/EIPS
|
title: 8/EIPS
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 8/EIPS
|
# 8/EIPS
|
|
@ -1,7 +1,8 @@
|
||||||
---
|
---
|
||||||
permalink: /spec/9
|
permalink: /spec/9
|
||||||
parent: Stable specs
|
|
||||||
title: 9/ETHEREUM-USAGE
|
title: 9/ETHEREUM-USAGE
|
||||||
|
parent: Stable specs
|
||||||
|
layout: default
|
||||||
---
|
---
|
||||||
|
|
||||||
# 9/ETHEREUM-USAGE
|
# 9/ETHEREUM-USAGE
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
layout: default
|
permalink: /spec/
|
||||||
title: Stable specs
|
title: Stable specs
|
||||||
nav_order: 1
|
nav_order: 1
|
||||||
has_children: true
|
has_children: true
|
||||||
permalink: /specs/stable
|
layout: default
|
||||||
---
|
---
|
|
@ -70,6 +70,7 @@ Diffie
|
||||||
discoverable
|
discoverable
|
||||||
DNS
|
DNS
|
||||||
DoS
|
DoS
|
||||||
|
Dvorsak
|
||||||
ECDSA
|
ECDSA
|
||||||
ecies
|
ecies
|
||||||
ECIES
|
ECIES
|
||||||
|
|
Loading…
Reference in New Issue