DRAFT: Doc plan v2

[lisa-parity]

Substrate Builders Handbook

About this guide

The Substrate Builders Handbook is a simplified entry point that describes how to build application-optimized blockchain using the Substrate and FRAME developer tools. In this guide, you’ll learn how to build an application first as a standalone blockchain using a node template, then as a parallel chain that can connect to a relay chain using a parachain template.

Intended audience

This handbook assumes that you are a new developer without any prior experience working with Substrate or FRAME, but that you are aware that these tools exist. This guide touches on some concepts related to Polkadot—like why you would convert your standalone chain to a parachain—but it isn’t intended to teach you about Polkadot or how to manage your application after you’ve built and tested it. Instead, you’ll see links to other resources where applicable.

What’s in this guide

The Substrate Builders Handbook provides a road map to help you learn how to build applications using Substrate and FRAME. It is intended to supplement other documentation and resources such as the Polkadot wiki and the Hacker’s Guide to the Polkadot Galaxy. It includes both conceptual and procedural information, but the goal is to keep things simple.

Where to find more

There are many other sources of information—including videos, presentations, and coding demonstrations—to complement the information in this handbook.

Substrate at a glance

• What is Substrate?
• What is FRAME?
• Why use Substrate and FRAME?
• What is a Substrate node?
• Why build a custom runtime?

Building applications at a glance

• What is a node? (Consists of client outer node services and runtime)
• What are the client services? (In general, the client libraries provide the blockchain infrastructure, such as peer discovery, gossiping transactions, and importing blocks.)
• What’s in the runtime? (The runtime provides the core logic of the application. and the interfaces that enable the client services to communicate with it. Building an application, a purpose-driven blockchain, is primarily a matter of creating a custom runtime.)
• What are pallets? (Discrete units of logic that implement some useful functionality.)
• What are the templates?
• What can you build?

Learn

• Welcome to Substrate
• Blockchain technology and decentralized apps
• Architecture and Rust libraries
• Networks and nodes
• Runtime components and execution
• Transactions and blocks
• Accounts
• Storage abstractions
• Consensus
• Cross-consensus messages

Install

• Rust toolchain
• Linux
• macOS
• Windows
• Developer tools
• Troubleshoot Rust issues

Build

• Prepare a working environment
• Start a local development node
• Explore existing pallets
• Import an existing pallet
• Macros and basic scaffolding
• Shared and custom types
• Storage values and maps
• Events
• Errors
• Public and private functions
• Call origins
• Pallet coupling
• Randomness
• Consensus options
• Offchain operations
• Construct the runtime
• Metadata and front-end development
• Convert a standalone chain to a parachain
• Build a deterministic parachain runtime

Test

• Unit test
• Debug
• Benchmark
• Connect to a local relay chain
• Select collators
• Set up a simulated network
• Prepare to launch
• Deploy a parachain on Rococo

Deploy

• Deployment options
• Prepare to deploy
• Auctions and crowdloans
• Acquire a Kusama or Polkadot slot -Deploy on Kusama or Polkadot
• Test runtime snapshots
• Add HRMP channels
• Upgrade a parachain
• Maintain network operations

[har00ga]

Think this ticket is related to #1906? If not though let me know