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
+9 -9
View File
@@ -1,13 +1,13 @@
# Executive Module
The Executive module acts as the orchestration layer for the runtime. It dispatches incoming
extrinsic calls to the respective modules in the runtime.
The Executive module acts as the orchestration layer for the runtime. It dispatches incoming extrinsic calls to the
respective modules in the runtime.
## Overview
The executive module is not a typical pallet providing functionality around a specific feature.
It is a cross-cutting framework component for the FRAME. It works in conjunction with the
[FRAME System module](https://docs.rs/frame-system/latest/frame_system/) to perform these cross-cutting functions.
The executive module is not a typical pallet providing functionality around a specific feature. It is a cross-cutting
framework component for the FRAME. It works in conjunction with the [FRAME System
module](https://docs.rs/frame-system/latest/frame_system/) to perform these cross-cutting functions.
The Executive module provides functions to:
@@ -26,7 +26,8 @@ The Executive module provides the following implementations:
## Usage
The default Substrate node template declares the [`Executive`](https://docs.rs/frame-executive/latest/frame_executive/struct.Executive.html) type in its library.
The default Substrate node template declares the
[`Executive`](https://docs.rs/frame-executive/latest/frame_executive/struct.Executive.html) type in its library.
### Example
@@ -46,9 +47,8 @@ pub type Executive = executive::Executive<
### Custom `OnRuntimeUpgrade` logic
You can add custom logic that should be called in your runtime on a runtime upgrade. This is
done by setting an optional generic parameter. The custom logic will be called before
the on runtime upgrade logic of all modules is called.
You can add custom logic that should be called in your runtime on a runtime upgrade. This is done by setting an optional
generic parameter. The custom logic will be called before the on runtime upgrade logic of all modules is called.
```rust
#