Crate polkadot_sdk_docs

Polkadot SDK Docs

The Polkadot SDK Developer Documentation.

This crate is a minimal, always-accurate and low level source of truth about Polkadot-SDK. For more high level docs, please go to docs.polkadot.com.

Getting Started

We suggest the following reading sequence:

• Start by learning about polkadot_sdk, its structure and context.
• Then, head over to the guides. This modules contains in-depth guides about the most important user-journeys of the Polkadot SDK.
  • Whilst reading the guides, you might find back-links to reference_docs.
• external_resources for a list of 3rd party guides and tutorials.
• Finally, https://paritytech.github.io is the parent website of this crate that contains the list of further tools related to the Polkadot SDK.

Information Architecture

This section paints a picture over the high-level information architecture of this crate.

flowchart
    dot[docs.polkadot.com] --> devhub[polkadot_sdk_docs]

    devhub --> polkadot_sdk
    devhub --> reference_docs
    devhub --> guides
	devhub --> external_resources

    polkadot_sdk --> substrate
    polkadot_sdk --> frame
    polkadot_sdk --> xcm
	polkadot_sdk --> templates

Modules

external_resources

A list of external resources and learning material about Polkadot SDK.

guides

In-depth guides about the most common components of the Polkadot SDK. They are slightly more high level and broad than reference_docs.

meta_contributing

Meta information about this crate, how it is built, what principles dictates its evolution and how one can contribute to it.

polkadot_sdk

An introduction to the Polkadot SDK. Read this module to learn about the structure of the SDK, the tools that are provided as a part of it, and to gain a high level understanding of each.

reference_docs

Reference documents covering in-depth topics across the Polkadot SDK. It is suggested to read these on-demand, while you are going through the guides or other content.