From 7dff1d1faa6d092c1b32006b1a6215ca5dd3e00b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bastian=20K=C3=B6cher?= Date: Tue, 4 Jun 2024 09:45:53 +0200 Subject: [PATCH] Format the README.md files (#4688) Co-authored-by: Oliver Tale-Yazdi --- .github/workflows/checks-quick.yml | 1 + templates/minimal/README.md | 27 ++++++++++++++++----------- templates/minimal/node/README.md | 12 ++++++++---- templates/minimal/pallets/README.md | 10 +++++++--- templates/minimal/runtime/README.md | 10 ++++++---- 5 files changed, 38 insertions(+), 22 deletions(-) diff --git a/.github/workflows/checks-quick.yml b/.github/workflows/checks-quick.yml index 7a10d8e0949fe..e7d9ce1ef7865 100644 --- a/.github/workflows/checks-quick.yml +++ b/.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 diff --git a/templates/minimal/README.md b/templates/minimal/README.md index 3194642f3f82a..583ba62420401 100644 --- a/templates/minimal/README.md +++ b/templates/minimal/README.md @@ -6,14 +6,15 @@ Polkadot SDK Logo > 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). ๐Ÿค 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. @@ -21,9 +22,9 @@ 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/). diff --git a/templates/minimal/node/README.md b/templates/minimal/node/README.md index 04a916f5053b4..9fd22f081a89e 100644 --- a/templates/minimal/node/README.md +++ b/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. diff --git a/templates/minimal/pallets/README.md b/templates/minimal/pallets/README.md index 26003638e9acb..9fabe64a3e79a 100644 --- a/templates/minimal/pallets/README.md +++ b/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. diff --git a/templates/minimal/runtime/README.md b/templates/minimal/runtime/README.md index 2fdfef8bc35b1..9aded8740cb0f 100644 --- a/templates/minimal/runtime/README.md +++ b/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).