Markdown linter (#1309)

* Add markdown linting

- add linter default rules
- adapt rules to current code
- fix the code for linting to pass
- add CI check

fix #1243

* Fix markdown for Substrate
* Fix tooling install
* Fix workflow
* Add documentation
* Remove trailing spaces
* Update .github/.markdownlint.yaml

Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Fix mangled markdown/lists
* Fix captalization issues on known words
This commit is contained in:
Chevdor
2023-09-04 11:02:32 +02:00
committed by GitHub
parent 830fde2a60
commit a30092ab42
271 changed files with 6289 additions and 4450 deletions
+2 -2
View File
@@ -1,4 +1,4 @@
Aura (Authority-round) consensus in substrate.
Aura (Authority-round) consensus in Substrate.
Aura works by having a list of authorities A who are expected to roughly
agree on the current time. Time is divided up into discrete slots of t
@@ -12,4 +12,4 @@ far in the future they are.
NOTE: Aura itself is designed to be generic over the crypto used.
License: GPL-3.0-or-later WITH Classpath-exception-2.0
License: GPL-3.0-or-later WITH Classpath-exception-2.0
+1 -1
View File
@@ -45,4 +45,4 @@ blocks) and will go with the longest one in case of a tie.
An in-depth description and analysis of the protocol can be found here:
<https://research.web3.foundation/en/latest/polkadot/block-production/Babe.html>
License: GPL-3.0-or-later WITH Classpath-exception-2.0
License: GPL-3.0-or-later WITH Classpath-exception-2.0
@@ -1,3 +1,3 @@
RPC api for babe.
License: GPL-3.0-or-later WITH Classpath-exception-2.0
License: GPL-3.0-or-later WITH Classpath-exception-2.0
+1 -1
View File
@@ -1,3 +1,3 @@
Collection of common consensus specific implementations
License: GPL-3.0-or-later WITH Classpath-exception-2.0
License: GPL-3.0-or-later WITH Classpath-exception-2.0
+1 -1
View File
@@ -1,3 +1,3 @@
Generic utilities for epoch-based consensus engines.
License: GPL-3.0-or-later WITH Classpath-exception-2.0
License: GPL-3.0-or-later WITH Classpath-exception-2.0
+2 -2
View File
@@ -1,4 +1,4 @@
Integration of the GRANDPA finality gadget into substrate.
Integration of the GRANDPA finality gadget into Substrate.
This crate is unstable and the API and usage may change.
@@ -36,4 +36,4 @@ number (this is num(signal) + N). When finalizing a block, we either apply
or prune any signaled changes based on whether the signaling block is
included in the newly-finalized chain.
License: GPL-3.0-or-later WITH Classpath-exception-2.0
License: GPL-3.0-or-later WITH Classpath-exception-2.0
@@ -1,3 +1,3 @@
RPC API for GRANDPA.
License: GPL-3.0-or-later WITH Classpath-exception-2.0
License: GPL-3.0-or-later WITH Classpath-exception-2.0
@@ -1,4 +1,4 @@
A manual sealing engine: the engine listens for rpc calls to seal blocks and create forks.
This is suitable for a testing environment.
License: GPL-3.0-or-later WITH Classpath-exception-2.0
License: GPL-3.0-or-later WITH Classpath-exception-2.0
+1 -1
View File
@@ -4,4 +4,4 @@ Some consensus algorithms have a concept of *slots*, which are intervals in
time during which certain events can and/or must occur. This crate
provides generic functionality for slots.
License: GPL-3.0-or-later WITH Classpath-exception-2.0
License: GPL-3.0-or-later WITH Classpath-exception-2.0