#
pezkuwi_sdk_docs/
lib.rs

    1//! # Pezkuwi SDK Docs
    2//!
    3//! The Pezkuwi SDK Developer Documentation.
    4//!
    5//! This crate is a *minimal*, *always-accurate* and low level source of truth about Pezkuwi-SDK.
    6//! For more high level docs, please go to [docs.pezkuwi.com](https://docs.pezkuwichain.io).
    7//!
    8//! ## Getting Started
    9//!
    10//! We suggest the following reading sequence:
    11//!
    12//! - Start by learning about [`pezkuwi_sdk`], its structure and context.
    13//! - Then, head over to the [`guides`]. This modules contains in-depth guides about the most
    14//!   important user-journeys of the Pezkuwi SDK.
    15//! 	- Whilst reading the guides, you might find back-links to [`reference_docs`].
    16//! - [`external_resources`] for a list of 3rd party guides and tutorials.
    17//! - Finally, <https://paritytech.github.io> is the parent website of this crate that contains the
    18//!   list of further tools related to the Pezkuwi SDK.
    19//!
    20//! ## Information Architecture
    21//!
    22//! This section paints a picture over the high-level information architecture of this crate.
    23#![doc = simple_mermaid::mermaid!("../../mermaid/IA.mmd")]
    24#![warn(rustdoc::broken_intra_doc_links)]
    25#![warn(rustdoc::private_intra_doc_links)]
    26// Frame macros reference features which this crate does not have
    27#![allow(unexpected_cfgs)]
    28#![doc(html_favicon_url = "https://pezkuwichain.io/favicon.ico")]
    29#![doc(
    30	html_logo_url = "https://raw.githubusercontent.com/paritytech/pezkuwi-sdk/master/docs/images/Pezkuwi_Logo_Horizontal_Pink_White.png"
    31)]
    32#![doc(issue_tracker_base_url = "https://github.com/pezkuwichain/pezkuwi-sdk/issues")]
    33
    34/// Meta information about this crate, how it is built, what principles dictates its evolution and
    35/// how one can contribute to it.
    36pub mod meta_contributing;
    37
    38/// A list of external resources and learning material about Pezkuwi SDK.
    39pub mod external_resources;
    40
    41/// In-depth guides about the most common components of the Pezkuwi SDK. They are slightly more
    42/// high level and broad than [`reference_docs`].
    43pub mod guides;
    44
    45/// An introduction to the Pezkuwi SDK. Read this module to learn about the structure of the SDK,
    46/// the tools that are provided as a part of it, and to gain a high level understanding of each.
    47pub mod pezkuwi_sdk;
    48/// Reference documents covering in-depth topics across the Pezkuwi SDK. It is suggested to read
    49/// these on-demand, while you are going through the [`guides`] or other content.
    50pub mod reference_docs;