Format the README.md files (#4688)

Co-authored-by: Oliver Tale-Yazdi <[email protected]>

.github/workflows/checks-quick.yml

@@ -117,6 +117,7 @@ jobs:
           CONFIG: .github/.markdownlint.yaml
         run: |
           echo "Checking markdown formatting. More info: docs/contributor/markdown_linting.md"
+          echo "To fix potential erros, you can run 'markdownlint --config .github/.markdownlint.yaml -f --ignore target .' locally."
           markdownlint --config "$CONFIG" --ignore target .
   check-umbrella:
     runs-on: ubuntu-latest

templates/minimal/README.md

@@ -6,24 +6,25 @@
 <img height="70px" alt="Polkadot SDK Logo" src="https://github.com/paritytech/polkadot-sdk/raw/master/docs/images/Polkadot_Logo_Horizontal_Pink_Black.png#gh-light-mode-only"/>
 
 > This is a minimal template for creating a blockchain based on Polkadot SDK.
-> 
+>
 > This template is automatically updated after releases in the main [Polkadot SDK monorepo](https://github.com/paritytech/polkadot-sdk).
 
 </div>
 
 🤏 This template is a minimal (in terms of complexity and the number of components) template for building a blockchain node.
 
-🔧 Its runtime is configured of a single custom pallet as a starting point, and a handful of ready-made pallets such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).
+🔧 Its runtime is configured of a single custom pallet as a starting point, and a handful of ready-made pallets
+such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).
 
 👤 The template has no consensus configured - it is best for experimenting with a single node network.
 
 ## Template Structure
 
 A Polkadot SDK based project such as this one consists of:
 
-- 💿 a [Node](./node/README.md) - the binary application.
-- 🧮 the [Runtime](./runtime/README.md) - the core logic of the blockchain.
-- 🎨 the [Pallets](./pallets/README.md) - from which the runtime is constructed.
+* 💿 a [Node](./node/README.md) - the binary application.
+* 🧮 the [Runtime](./runtime/README.md) - the core logic of the blockchain.
+* 🎨 the [Pallets](./pallets/README.md) - from which the runtime is constructed.
 
 ## Getting Started
 
@@ -62,9 +63,9 @@ docker run --rm polkadot-sdk-minimal-template --dev
 
 Development chains:
 
-- 🧹 Do not persist the state.
-- 💰 Are preconfigured with a genesis state that includes several prefunded development accounts.
-- 🧑‍⚖️ Development accounts are used as `sudo` accounts.
+* 🧹 Do not persist the state.
+* 💰 Are preconfigured with a genesis state that includes several prefunded development accounts.
+* 🧑‍⚖️ Development accounts are used as `sudo` accounts.
 
 ### Connect with the Polkadot-JS Apps Front-End
 
@@ -84,12 +85,16 @@ available on [IPFS](https://dotapps.io/).
 
 ➡️ Any pull requests should be directed to this [source](https://github.com/paritytech/polkadot-sdk/tree/master/templates/minimal).
 
-😇 Please refer to the monorepo's [contribution guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md) and [Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CODE_OF_CONDUCT.md).
+😇 Please refer to the monorepo's
+[contribution guidelines](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md) and
+[Code of Conduct](https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CODE_OF_CONDUCT.md).
 
 ## Getting Help
 
 🧑‍🏫 To learn about Polkadot in general, [Polkadot.network](https://polkadot.network/) website is a good starting point.
 
-🧑‍🔧 For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are the Polkadot SDK documentation resources.
+🧑‍🔧 For technical introduction, [here](https://github.com/paritytech/polkadot-sdk#-documentation) are
+the Polkadot SDK documentation resources.
 
-👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and [Substrate StackExchange](https://substrate.stackexchange.com/).
+👥 Additionally, there are [GitHub issues](https://github.com/paritytech/polkadot-sdk/issues) and
+[Substrate StackExchange](https://substrate.stackexchange.com/).

templates/minimal/node/README.md

@@ -2,13 +2,17 @@
 
 ℹ️ A node -  in Polkadot - is a binary executable, whose primary purpose is to execute the [runtime](../runtime/README.md).
 
-🔗 It communicates with other nodes in the network, and aims for [consensus](https://wiki.polkadot.network/docs/learn-consensus) among them.
+🔗 It communicates with other nodes in the network, and aims for
+[consensus](https://wiki.polkadot.network/docs/learn-consensus) among them.
 
 ⚙️ It acts as a remote procedure call (RPC) server, allowing interaction with the blockchain.
 
-👉 Learn more about the architecture, and a difference between a node and a runtime [here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/wasm_meta_protocol/index.html).
+👉 Learn more about the architecture, and a difference between a node and a runtime
+[here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/wasm_meta_protocol/index.html).
 
 👇 Here are the most important files in this node template:
 
-- [`chain_spec.rs`](./src/chain_spec.rs): A chain specification is a source code file that defines the chain's initial (genesis) state.
-- [`service.rs`](./src/service.rs): This file defines the node implementation. It's a place to configure consensus-related topics. In favor of minimalism, this template has no consensus configured.
+- [`chain_spec.rs`](./src/chain_spec.rs): A chain specification is a source code file that defines the chain's
+initial (genesis) state.
+- [`service.rs`](./src/service.rs): This file defines the node implementation.
+It's a place to configure consensus-related topics. In favor of minimalism, this template has no consensus configured.

templates/minimal/pallets/README.md

@@ -1,9 +1,13 @@
 # Pallets
 
-ℹ️ A pallet is a unit of encapsulated logic, with a clearly defined responsibility. A pallet is analogous to a module in the runtime.
+ℹ️ A pallet is a unit of encapsulated logic, with a clearly defined responsibility. A pallet is analogous to a
+module in the runtime.
 
 💁 In this template, there is a simple custom pallet based on the FRAME framework.
 
-👉 Learn more about FRAME [here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/frame_runtime/index.html).
+👉 Learn more about FRAME
+[here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/frame_runtime/index.html).
 
-🧑‍🏫 Please refer to [this guide](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/guides/your_first_pallet/index.html) to learn how to write a basic pallet.
+🧑‍🏫 Please refer to
+[this guide](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/guides/your_first_pallet/index.html)
+to learn how to write a basic pallet.

templates/minimal/runtime/README.md

@@ -1,8 +1,10 @@
 # Runtime
 
-ℹ️ The runtime (in other words, a state transition function), refers to the core logic of the blockchain that is responsible for
-validating blocks and executing the state changes they define.
+ℹ️ The runtime (in other words, a state transition function), refers to the core logic of the blockchain that is
+responsible for validating blocks and executing the state changes they define.
 
-💁 The runtime in this template is constructed using ready-made FRAME pallets that ship with [Polkadot SDK](https://github.com/paritytech/polkadot-sdk), and a [template for a custom pallet](../pallets/README.md).
+💁 The runtime in this template is constructed using ready-made FRAME pallets that ship with
+[Polkadot SDK](https://github.com/paritytech/polkadot-sdk), and a [template for a custom pallet](../pallets/README.md).
 
-👉 Learn more about FRAME [here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/frame_runtime/index.html).
+👉 Learn more about FRAME
+[here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/frame_runtime/index.html).