From f1c34b7c10aed120b57a05b991baef32d4f4ee61 Mon Sep 17 00:00:00 2001 From: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Wed, 21 Aug 2024 19:54:08 +0200 Subject: [PATCH 1/7] Remove some noise from the template list --- docs/sdk/src/polkadot_sdk/templates.rs | 45 ++++++++++---------------- 1 file changed, 17 insertions(+), 28 deletions(-) diff --git a/docs/sdk/src/polkadot_sdk/templates.rs b/docs/sdk/src/polkadot_sdk/templates.rs index e87eb9c2bc8a..69eceb52782e 100644 --- a/docs/sdk/src/polkadot_sdk/templates.rs +++ b/docs/sdk/src/polkadot_sdk/templates.rs @@ -7,34 +7,23 @@ //! //! ## Internal //! -//! The following [templates](https://github.com/paritytech/polkadot-sdk/blob/master/templates) are -//! maintained as a part of the `polkadot-sdk` repository: -//! -//! - `minimal_template_node`/[`minimal_template_runtime`]: A minimal template that contains the -//! least amount of features to be a functioning blockchain. Suitable for learning, development -//! and testing. This template is not meant to be used in production. -//! - `solochain_template_node`/[`solochain_template_runtime`]: Formerly known as -//! "substrate-node-template", is a white-labeled substrate-based blockchain (aka. solochain) that -//! contains moderate features, such as a basic consensus engine and some FRAME pallets. This -//! template can act as a good starting point for those who want to launch a solochain. -//! - `parachain_template_node`/[`parachain_template_runtime`]: A parachain template ready to be -//! connected to a test relay-chain. -//! -//! These templates are always kept up to date, and are mirrored to external repositories for easy -//! forking: -//! -//! - -//! - -//! - -//! -//! ## External Templates -//! -//! Noteworthy templates outside of this repository. -//! -//! - [`extended-parachain-template`](https://github.com/paritytech/extended-parachain-template): A -//! parachain template that contains more built-in functionality such as assets and NFTs. -//! - [`frontier-parachain-template`](https://github.com/paritytech/frontier-parachain-template): A -//! parachain template for launching EVM-compatible parachains. +//! The following templates are maintained as a part of the `polkadot-sdk` repository: +//! +//! - [`minimal-template`](https://github.com/paritytech/polkadot-sdk-minimal-template): +//! A minimal template that contains the least amount of features to be a functioning blockchain. +//! Suitable for learning and testing. +//! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-solochain-template): +//! Formerly known as "substrate-node-template", is a white-labeled substrate-based blockchain +//! (aka. solochain) that contains moderate features, such as a basic consensus engine and some +//! FRAME pallets. This template can act as a good starting point for those who want to launch +//! a solochain. +//! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-solochain-template): +// A parachain template ready to be connected to a relay-chain, such as [Paseo] +//! (https://github.com/paseo-network/.github), Kusama or Polkadot. +//! +//! Note that these templates are mirrored automaticall from [this] +//! (https://github.com/paritytech/polkadot-sdk/blob/master/templates) directory of polkadot-sdk, +//! therefore any changes to them should be made as a PR to this repo. //! //! ## OpenZeppelin //! From b3fa68facf4d1c5dc76fac46e710b81d5eeed30a Mon Sep 17 00:00:00 2001 From: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Wed, 21 Aug 2024 21:25:58 +0200 Subject: [PATCH 2/7] Update docs/sdk/src/polkadot_sdk/templates.rs Co-authored-by: Javier Viola <363911+pepoviola@users.noreply.github.com> --- docs/sdk/src/polkadot_sdk/templates.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sdk/src/polkadot_sdk/templates.rs b/docs/sdk/src/polkadot_sdk/templates.rs index 69eceb52782e..f5686828a02a 100644 --- a/docs/sdk/src/polkadot_sdk/templates.rs +++ b/docs/sdk/src/polkadot_sdk/templates.rs @@ -21,7 +21,7 @@ // A parachain template ready to be connected to a relay-chain, such as [Paseo] //! (https://github.com/paseo-network/.github), Kusama or Polkadot. //! -//! Note that these templates are mirrored automaticall from [this] +//! Note that these templates are mirrored automatically from [this] //! (https://github.com/paritytech/polkadot-sdk/blob/master/templates) directory of polkadot-sdk, //! therefore any changes to them should be made as a PR to this repo. //! From f0972f95434bc9e6d2888941bb5f4ce25ed41c92 Mon Sep 17 00:00:00 2001 From: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Fri, 23 Aug 2024 12:51:40 +0100 Subject: [PATCH 3/7] Fix mistakes. --- docs/sdk/src/polkadot_sdk/templates.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sdk/src/polkadot_sdk/templates.rs b/docs/sdk/src/polkadot_sdk/templates.rs index f5686828a02a..96fb98c5e647 100644 --- a/docs/sdk/src/polkadot_sdk/templates.rs +++ b/docs/sdk/src/polkadot_sdk/templates.rs @@ -12,12 +12,12 @@ //! - [`minimal-template`](https://github.com/paritytech/polkadot-sdk-minimal-template): //! A minimal template that contains the least amount of features to be a functioning blockchain. //! Suitable for learning and testing. -//! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-solochain-template): +//! - [`solochain-template`](https://github.com/paritytech/polkadot-sdk-solochain-template): //! Formerly known as "substrate-node-template", is a white-labeled substrate-based blockchain //! (aka. solochain) that contains moderate features, such as a basic consensus engine and some //! FRAME pallets. This template can act as a good starting point for those who want to launch //! a solochain. -//! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-solochain-template): +//! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-parachain-template): // A parachain template ready to be connected to a relay-chain, such as [Paseo] //! (https://github.com/paseo-network/.github), Kusama or Polkadot. //! From 4f8ec159a1faefbc7359088c87d2e3c93d54d102 Mon Sep 17 00:00:00 2001 From: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Mon, 26 Aug 2024 08:16:12 +0100 Subject: [PATCH 4/7] Fix mistakes. --- docs/sdk/src/polkadot_sdk/templates.rs | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/sdk/src/polkadot_sdk/templates.rs b/docs/sdk/src/polkadot_sdk/templates.rs index a0907815b5a3..e08dde206662 100644 --- a/docs/sdk/src/polkadot_sdk/templates.rs +++ b/docs/sdk/src/polkadot_sdk/templates.rs @@ -21,9 +21,8 @@ // A parachain template ready to be connected to a relay-chain, such as [Paseo] //! (https://github.com/paseo-network/.github), Kusama or Polkadot. //! -//! Note that these templates are mirrored automatically from [this] -//! (https://github.com/paritytech/polkadot-sdk/blob/master/templates) directory of polkadot-sdk, -//! therefore any changes to them should be made as a PR to this repo. +//! Note that these templates are mirrored automatically from [this](https://github.com/paritytech/polkadot-sdk/blob/master/templates) +//! directory of polkadot-sdk, therefore any changes to them should be made as a PR to this repo. //! //! ## OpenZeppelin //! From 8d1760ef679d834b66f095dea2229a3080a84004 Mon Sep 17 00:00:00 2001 From: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:26:27 +0100 Subject: [PATCH 5/7] Update docs/sdk/src/polkadot_sdk/templates.rs Co-authored-by: Alexandru Vasile <60601340+lexnv@users.noreply.github.com> --- docs/sdk/src/polkadot_sdk/templates.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sdk/src/polkadot_sdk/templates.rs b/docs/sdk/src/polkadot_sdk/templates.rs index e08dde206662..73e6bf7f9647 100644 --- a/docs/sdk/src/polkadot_sdk/templates.rs +++ b/docs/sdk/src/polkadot_sdk/templates.rs @@ -18,7 +18,7 @@ //! FRAME pallets. This template can act as a good starting point for those who want to launch //! a solochain. //! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-parachain-template): -// A parachain template ready to be connected to a relay-chain, such as [Paseo] +//! A parachain template ready to be connected to a relay-chain, such as [Paseo] //! (https://github.com/paseo-network/.github), Kusama or Polkadot. //! //! Note that these templates are mirrored automatically from [this](https://github.com/paritytech/polkadot-sdk/blob/master/templates) From 5961ed6c3f578d20d1e2d3ad853ff80154a03952 Mon Sep 17 00:00:00 2001 From: command-bot <> Date: Fri, 30 Aug 2024 17:10:35 +0000 Subject: [PATCH 6/7] ".git/.scripts/commands/fmt/fmt.sh" --- docs/sdk/src/polkadot_sdk/templates.rs | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/sdk/src/polkadot_sdk/templates.rs b/docs/sdk/src/polkadot_sdk/templates.rs index 73e6bf7f9647..0f989ba3fd05 100644 --- a/docs/sdk/src/polkadot_sdk/templates.rs +++ b/docs/sdk/src/polkadot_sdk/templates.rs @@ -9,20 +9,20 @@ //! //! The following templates are maintained as a part of the `polkadot-sdk` repository: //! -//! - [`minimal-template`](https://github.com/paritytech/polkadot-sdk-minimal-template): -//! A minimal template that contains the least amount of features to be a functioning blockchain. -//! Suitable for learning and testing. -//! - [`solochain-template`](https://github.com/paritytech/polkadot-sdk-solochain-template): -//! Formerly known as "substrate-node-template", is a white-labeled substrate-based blockchain -//! (aka. solochain) that contains moderate features, such as a basic consensus engine and some -//! FRAME pallets. This template can act as a good starting point for those who want to launch -//! a solochain. -//! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-parachain-template): +//! - [`minimal-template`](https://github.com/paritytech/polkadot-sdk-minimal-template): A minimal +//! template that contains the least amount of features to be a functioning blockchain. Suitable +//! for learning and testing. +//! - [`solochain-template`](https://github.com/paritytech/polkadot-sdk-solochain-template): +//! Formerly known as "substrate-node-template", is a white-labeled substrate-based blockchain +//! (aka. solochain) that contains moderate features, such as a basic consensus engine and some +//! FRAME pallets. This template can act as a good starting point for those who want to launch a +//! solochain. +//! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-parachain-template): //! A parachain template ready to be connected to a relay-chain, such as [Paseo] //! (https://github.com/paseo-network/.github), Kusama or Polkadot. //! -//! Note that these templates are mirrored automatically from [this](https://github.com/paritytech/polkadot-sdk/blob/master/templates) -//! directory of polkadot-sdk, therefore any changes to them should be made as a PR to this repo. +//! Note that these templates are mirrored automatically from [this](https://github.com/paritytech/polkadot-sdk/blob/master/templates) +//! directory of polkadot-sdk, therefore any changes to them should be made as a PR to this repo. //! //! ## OpenZeppelin //! From 57659fc8958de99bf721f625c0c892e908a08e19 Mon Sep 17 00:00:00 2001 From: kianenigma Date: Tue, 3 Sep 2024 08:57:40 +0100 Subject: [PATCH 7/7] fix? --- docs/sdk/src/polkadot_sdk/templates.rs | 4 ++-- docs/sdk/src/reference_docs/cli.rs | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/sdk/src/polkadot_sdk/templates.rs b/docs/sdk/src/polkadot_sdk/templates.rs index 0f989ba3fd05..ab742ad5c3a2 100644 --- a/docs/sdk/src/polkadot_sdk/templates.rs +++ b/docs/sdk/src/polkadot_sdk/templates.rs @@ -18,8 +18,8 @@ //! FRAME pallets. This template can act as a good starting point for those who want to launch a //! solochain. //! - [`parachain-template`](https://github.com/paritytech/polkadot-sdk-parachain-template): -//! A parachain template ready to be connected to a relay-chain, such as [Paseo] -//! (https://github.com/paseo-network/.github), Kusama or Polkadot. +//! A parachain template ready to be connected to a relay-chain, such as [Paseo](https://github.com/paseo-network/.github) +//! , Kusama or Polkadot. //! //! Note that these templates are mirrored automatically from [this](https://github.com/paritytech/polkadot-sdk/blob/master/templates) //! directory of polkadot-sdk, therefore any changes to them should be made as a PR to this repo. diff --git a/docs/sdk/src/reference_docs/cli.rs b/docs/sdk/src/reference_docs/cli.rs index b9cdbd60e959..6f393f267b0d 100644 --- a/docs/sdk/src/reference_docs/cli.rs +++ b/docs/sdk/src/reference_docs/cli.rs @@ -1,7 +1,7 @@ //! # Substrate CLI //! //! Let's see some examples of typical CLI arguments used when setting up and running a -//! Substrate-based blockchain. We use the [`substrate-node-template`](https://github.com/substrate-developer-hub/substrate-node-template) +//! Substrate-based blockchain. We use the [`solochain-template`](https://github.com/paritytech/polkadot-sdk-solochain-template) //! on these examples. //! //! #### Checking the available CLI arguments