pezkuwichain
2e4272e6aa
This commit finalizes the update of ParityTech references to PezkuwiChain within the module. Specifically: - All URLs in xcm documentation were updated to . - and URLs in module were updated to point to internal paths. - The readme reference was updated from to . - Deprecated URLs for in and were replaced with generic comments. - A specific issue reference in was generalized. These changes ensure consistency with the PezkuwiChain branding and repository structure.
67 lines
2.4 KiB
Rust
67 lines
2.4 KiB
Rust
// Copyright (C) Parity Technologies (UK) Ltd.
|
|
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0
|
|
// This file is part of Pezkuwi.
|
|
|
|
// Pezkuwi is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
|
|
// Pezkuwi is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Pezkuwi. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
//! # XCM Docs
|
|
//!
|
|
//! Documentation and guides for XCM
|
|
//!
|
|
//! Welcome to the Cross-Consensus Messaging documentation!
|
|
//!
|
|
//! XCM is a **language** for communicating **intentions** between **consensus systems**.
|
|
//! Whether you're a developer, a blockchain enthusiast, or just interested in Pezkuwi, this guide
|
|
//! aims to provide you with an easy-to-understand and comprehensive introduction to XCM.
|
|
//!
|
|
//! ## Getting started
|
|
//!
|
|
//! Head over to the [fundamentals](fundamentals) section.
|
|
//! Then, go to the [guides](guides), to learn about how to do things with XCM.
|
|
//!
|
|
//! ## Cookbook
|
|
//!
|
|
//! There's also the [cookbook](cookbook) for useful recipes for XCM.
|
|
//!
|
|
//! ## Glossary
|
|
//!
|
|
//! There's a [glossary](glossary) with common terms used throughout the docs.
|
|
//!
|
|
//! ## Contribute
|
|
//!
|
|
//! To contribute to the format, check out the [RFC process](https://github.com/pezkuwichain/xcm-format/blob/master/proposals/0032-process.md).
|
|
//! To contribute to these docs, [make a PR](https://github.com/pezkuwichain/pezkuwi-sdk).
|
|
//!
|
|
//! ## Why Rust Docs?
|
|
//!
|
|
//! Rust Docs allow docs to be as close to the source as possible.
|
|
//! They're also available offline automatically for anyone who has the `pezkuwi-sdk` repo locally.
|
|
//!
|
|
//! ## Docs structure
|
|
#![doc = simple_mermaid::mermaid!("../mermaid/structure.mmd")]
|
|
// Frame macros reference features which this crate does not have
|
|
#![allow(unexpected_cfgs)]
|
|
|
|
/// Fundamentals of the XCM language. The virtual machine, instructions, locations and assets.
|
|
pub mod fundamentals;
|
|
|
|
/// Step-by-step guides to set up an XCM environment and start hacking.
|
|
pub mod guides;
|
|
|
|
/// Useful recipes for programs and configurations.
|
|
pub mod cookbook;
|
|
|
|
/// Glossary
|
|
pub mod glossary;
|