Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove noise from the template list #5437

Merged
merged 14 commits into from
Sep 3, 2024
45 changes: 17 additions & 28 deletions docs/sdk/src/polkadot_sdk/templates.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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:
//!
//! - <https://github.com/paritytech/polkadot-sdk-minimal-template>
//! - <https://github.com/paritytech/polkadot-sdk-solochain-template>
//! - <https://github.com/paritytech/polkadot-sdk-parachain-template>
//!
//! ## 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):
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
//! 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):
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
// A parachain template ready to be connected to a relay-chain, such as [Paseo]
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
//! (https://github.com/paseo-network/.github), Kusama or Polkadot.
//!
//! Note that these templates are mirrored automaticall from [this]
kianenigma marked this conversation as resolved.
Show resolved Hide resolved
//! (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
//!
Expand Down
Loading