xcm_docs/lib.rs
1// Copyright (C) Parity Technologies (UK) Ltd.
2// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
3// This file is part of Polkadot.
4
5// Polkadot is free software: you can redistribute it and/or modify
6// it under the terms of the GNU General Public License as published by
7// the Free Software Foundation, either version 3 of the License, or
8// (at your option) any later version.
9
10// Polkadot is distributed in the hope that it will be useful,
11// but WITHOUT ANY WARRANTY; without even the implied warranty of
12// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13// GNU General Public License for more details.
14
15// You should have received a copy of the GNU General Public License
16// along with Polkadot. If not, see <http://www.gnu.org/licenses/>.
17
18//! # XCM Docs
19//!
20//! Documentation and guides for XCM
21//!
22//! Welcome to the Cross-Consensus Messaging documentation!
23//!
24//! XCM is a **language** for communicating **intentions** between **consensus systems**.
25//! Whether you're a developer, a blockchain enthusiast, or just interested in Polkadot, this guide
26//! aims to provide you with an easy-to-understand and comprehensive introduction to XCM.
27//!
28//! ## Getting started
29//!
30//! Head over to the [fundamentals](fundamentals) section.
31//! Then, go to the [guides](guides), to learn about how to do things with XCM.
32//!
33//! ## Cookbook
34//!
35//! There's also the [cookbook](cookbook) for useful recipes for XCM.
36//!
37//! ## Glossary
38//!
39//! There's a [glossary](glossary) with common terms used throughout the docs.
40//!
41//! ## Contribute
42//!
43//! To contribute to the format, check out the [RFC process](https://github.com/paritytech/xcm-format/blob/master/proposals/0032-process.md).
44//! To contribute to these docs, [make a PR](https://github.com/paritytech/polkadot-sdk).
45//!
46//! ## Why Rust Docs?
47//!
48//! Rust Docs allow docs to be as close to the source as possible.
49//! They're also available offline automatically for anyone who has the `polkadot-sdk` repo locally.
50//!
51//! ## Docs structure
52#![doc = simple_mermaid::mermaid!("../mermaid/structure.mmd")]
53// Frame macros reference features which this crate does not have
54#![allow(unexpected_cfgs)]
55
56/// Fundamentals of the XCM language. The virtual machine, instructions, locations and assets.
57pub mod fundamentals;
58
59/// Step-by-step guides to set up an XCM environment and start hacking.
60pub mod guides;
61
62/// Useful recipes for programs and configurations.
63pub mod cookbook;
64
65/// Glossary
66pub mod glossary;