text-lint (#131)

This commit is contained in:
Dean Eigenmann 2020-05-25 14:18:39 +02:00 committed by GitHub
parent 93dc975914
commit 7355f4cff0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 4130 additions and 36 deletions

7
.textlintrc Normal file
View File

@ -0,0 +1,7 @@
{
"filters": {},
"rules": {
"no-empty-section": true,
"footnote-order": true
}
}

View File

@ -27,8 +27,7 @@ title: 13/3RD-PARTY-USAGE
* [Collectibles](#collectibles) * [Collectibles](#collectibles)
* [Iubenda](#iubenda) * [Iubenda](#iubenda)
5. [Changelog](#changelog) 5. [Changelog](#changelog)
6. [Acknowledgments](#acknowledgments) 6. [Copyright](#copyright)
7. [Copyright](#copyright)
## Abstract ## Abstract
@ -118,8 +117,6 @@ If Iubenda fails Status users won't be able to navigate to app's privacy policy.
| :-----: | ------- | | :-----: | ------- |
| [0.1.0](https://github.com/status-im/specs/blob/master/docs/draft/9-3rd-party.md) | Initial Release | | [0.1.0](https://github.com/status-im/specs/blob/master/docs/draft/9-3rd-party.md) | Initial Release |
## Acknowledgments
## Copyright ## Copyright
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

View File

@ -17,7 +17,7 @@ title: 6/PAYLOADS
This specifications describes how the payload of each message in Status looks This specifications describes how the payload of each message in Status looks
like. It is primarily centered around chat and chat-related use cases. like. It is primarily centered around chat and chat-related use cases.
The payloads aims be flexible enough to support messaging but also cases The payloads aims to be flexible enough to support messaging but also cases
described in the [Status Whitepaper](https://status.im/whitepaper.pdf) as well described in the [Status Whitepaper](https://status.im/whitepaper.pdf) as well
as various clients created using different technologies. as various clients created using different technologies.
@ -50,7 +50,6 @@ as various clients created using different technologies.
- [MembershipUpdateMessage and MembershipUpdateEvent](#membershipupdatemessage-and-membershipupdateevent) - [MembershipUpdateMessage and MembershipUpdateEvent](#membershipupdatemessage-and-membershipupdateevent)
- [Upgradability](#upgradability) - [Upgradability](#upgradability)
- [Security Considerations](#security-considerations) - [Security Considerations](#security-considerations)
- [Design rationale](#design-rationale)
## Introduction ## Introduction
@ -351,9 +350,6 @@ There are two ways to upgrade the protocol without breaking compatibility:
- -
## Design rationale
## Copyright ## Copyright
Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/). Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).

View File

@ -5,5 +5,3 @@ nav_order: 2
has_children: true has_children: true
permalink: /specs/draft permalink: /specs/draft
--- ---
# Draft specifications

View File

@ -5,5 +5,3 @@ permalink: /specs/raw
nav_order: 2 nav_order: 2
has_children: true has_children: true
--- ---
# Raw specifications

View File

@ -34,7 +34,6 @@ In this specification we explain what Status account is, and how trust is establ
- [Public channels](#public-channels) - [Public channels](#public-channels)
- [Private 1:1 messages](#private-11-messages) - [Private 1:1 messages](#private-11-messages)
- [Initial Key Exchange](#initial-key-exchange) - [Initial Key Exchange](#initial-key-exchange)
- [Contact Request](#contact-request)
- [Bundles](#bundles) - [Bundles](#bundles)
- [Contact Verification](#contact-verification) - [Contact Verification](#contact-verification)
- [Identicon](#identicon) - [Identicon](#identicon)
@ -140,8 +139,6 @@ This can be done in the following ways:
### Initial Key Exchange ### Initial Key Exchange
#### Contact Request
#### Bundles #### Bundles
- An X3DH prekey bundle is defined as ([code](https://github.com/status-im/status-go/messaging/chat/protobuf/encryption.pb.go)): - An X3DH prekey bundle is defined as ([code](https://github.com/status-im/status-go/messaging/chat/protobuf/encryption.pb.go)):
``` ```

View File

@ -17,7 +17,7 @@ title: 6/PAYLOADS
This specifications describes how the payload of each message in Status looks This specifications describes how the payload of each message in Status looks
like. It is primarily centered around chat and chat-related use cases. like. It is primarily centered around chat and chat-related use cases.
The payloads aim to be flexible enough to support messaging but also cases The payloads aims to be flexible enough to support messaging but also cases
described in the [Status Whitepaper](https://status.im/whitepaper.pdf) as well described in the [Status Whitepaper](https://status.im/whitepaper.pdf) as well
as various clients created using different technologies. as various clients created using different technologies.
@ -49,7 +49,6 @@ as various clients created using different technologies.
- [MembershipUpdateMessage and MembershipUpdateEvent](#membershipupdatemessage-and-membershipupdateevent) - [MembershipUpdateMessage and MembershipUpdateEvent](#membershipupdatemessage-and-membershipupdateevent)
- [Upgradability](#upgradability) - [Upgradability](#upgradability)
- [Security Considerations](#security-considerations) - [Security Considerations](#security-considerations)
- [Design rationale](#design-rationale)
- [Changelog](#changelog) - [Changelog](#changelog)
- [Version 0.3](#version-03) - [Version 0.3](#version-03)
@ -333,8 +332,6 @@ There are two ways to upgrade the protocol without breaking compatibility:
- -
## Design rationale
## Changelog ## Changelog
### Version 0.3 ### Version 0.3

View File

@ -21,10 +21,6 @@ In this specification, we describe how Status relates with EIPs.
- [Table of Contents](#table-of-contents) - [Table of Contents](#table-of-contents)
- [Introduction](#introduction) - [Introduction](#introduction)
- [Components](#components) - [Components](#components)
- [Security Considerations](#security-considerations)
- [Design Rationale](#design-rationale)
- [Footnotes](#footnotes)
- [Acknowledgments](#acknowledgments)
## Introduction ## Introduction
@ -236,11 +232,3 @@ Description: Allows the storing and retrieving of nodes through merkle trees sto
Used for: Finding Waku nodes. Used for: Finding Waku nodes.
Related: - Related: -
Sourcecode: - Sourcecode: -
## Security Considerations
## Design Rationale
## Footnotes
## Acknowledgments

View File

@ -5,5 +5,3 @@ nav_order: 1
has_children: true has_children: true
permalink: /specs/stable permalink: /specs/stable
--- ---
# Stable specifications

4114
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -4,9 +4,13 @@
"remark-cli": "^6.0.1", "remark-cli": "^6.0.1",
"remark-lint": "^6.0.2", "remark-lint": "^6.0.2",
"remark-preset-lint-recommended": "^3.0.2", "remark-preset-lint-recommended": "^3.0.2",
"remark-validate-links": "^10.0.0" "remark-validate-links": "^10.0.0",
"textlint": "^11.6.3",
"textlint-rule-footnote-order": "^1.0.3",
"textlint-rule-no-empty-section": "^1.1.0"
}, },
"scripts": { "scripts": {
"textlint": "textlint docs/",
"lint": "remark ." "lint": "remark ."
}, },
"remarkConfig": { "remarkConfig": {