polkadot_sdk_docs/guides/
mod.rs

1//! # Polkadot SDK Docs Guides
2//!
3//! This crate contains a collection of guides that are foundational to the developers of
4//! Polkadot SDK. They are common user-journeys that are traversed in the Polkadot ecosystem.
5//!
6//! The main user-journey covered by these guides is:
7//!
8//! * [`your_first_pallet`], where you learn what a FRAME pallet is, and write your first
9//!   application logic.
10//! * [`your_first_runtime`], where you learn how to compile your pallets into a WASM runtime.
11//! * [`your_first_node`], where you learn how to run the said runtime in a node.
12//!
13//! > By this step, you have already launched a full Polkadot-SDK-based blockchain!
14//!
15//! Once done, feel free to step up into one of our templates: [`crate::polkadot_sdk::templates`].
16//!
17//! [`your_first_pallet`]: crate::guides::your_first_pallet
18//! [`your_first_runtime`]: crate::guides::your_first_runtime
19//! [`your_first_node`]: crate::guides::your_first_node
20//!
21//! Other guides are related to other miscellaneous topics and are listed as modules below.
22
23/// Write your first simple pallet, learning the most most basic features of FRAME along the way.
24pub mod your_first_pallet;
25
26/// Write your first real [runtime](`crate::reference_docs::wasm_meta_protocol`),
27/// compiling it to [WASM](crate::polkadot_sdk::substrate#wasm-build).
28pub mod your_first_runtime;
29
30/// Running the given runtime with a node. No specific consensus mechanism is used at this stage.
31pub mod your_first_node;
32
33/// How to enhance a given runtime and node to be cumulus-enabled, run it as a parachain
34/// and connect it to a relay-chain.
35// pub mod your_first_parachain;
36
37/// How to enable storage weight reclaiming in a parachain node and runtime.
38pub mod enable_pov_reclaim;
39
40/// How to enable Async Backing on parachain projects that started in 2023 or before.
41pub mod async_backing_guide;
42
43/// How to enable metadata hash verification in the runtime.
44pub mod enable_metadata_hash;
45
46/// How to enable elastic scaling on a parachain.
47pub mod enable_elastic_scaling;
48
49/// How to parameterize parachain forking in relation to relay chain forking.
50pub mod handling_parachain_forks;
polkadot_sdk_docs/guides/mod.rs

polkadot_sdk_docs/guides/
mod.rs
