mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 19:17:58 +00:00
Kian Paimani
29369a4e7c
Does the following: - Add a reference doc page named `frame_runtime_types`, which explains what types like `RuntimeOrigin`, `RuntimeCall` etc are. - On top of it, it adds a reference doc page called `frame_origin` which explains a few important patterns that we use around origins - And finally brushes up `#[frame::origin]` docs. - Updates the theme, sidebar and favicon to look like: <img width="1728" alt="Screenshot 2024-02-20 at 12 16 00" src="https://github.com/paritytech/polkadot-sdk/assets/5588131/6d60a16b-2081-411b-8869-43b91920cca9"> All of this was inspired by https://substrate.stackexchange.com/questions/10992/how-do-you-find-the-public-key-for-the-medium-spender-track-origin/10993 closes https://github.com/paritytech/polkadot-sdk-docs/issues/45 closes https://github.com/paritytech/polkadot-sdk-docs/issues/43 contributes / overlaps with https://github.com/paritytech/polkadot-sdk/pull/2638 cc @liamaharon deprecation companion: https://github.com/substrate-developer-hub/substrate-docs/pull/2131 pba-content companion: https://github.com/Polkadot-Blockchain-Academy/pba-content/pull/977 --------- Co-authored-by: Radha <86818441+DrW3RK@users.noreply.github.com> Co-authored-by: Sebastian Kunert <skunert49@gmail.com> Co-authored-by: Gonçalo Pestana <g6pestana@gmail.com> Co-authored-by: Liam Aharon <liam.aharon@hotmail.com>
47 lines
2.2 KiB
Rust
47 lines
2.2 KiB
Rust
//! # Polkadot SDK Docs
|
|
//!
|
|
//! The Polkadot SDK Developer Documentation.
|
|
//!
|
|
//! This crate is a *minimal*, but *always-accurate* source of information for those wishing to
|
|
//! build on the Polkadot SDK.
|
|
//!
|
|
//! > **Work in Progress**: This crate is under heavy development. Expect content to be moved and
|
|
//! > changed. Do not use links to this crate yet. See [`meta_contributing`] for more information.
|
|
//!
|
|
//! ## Getting Started
|
|
//!
|
|
//! We suggest the following reading sequence:
|
|
//!
|
|
//! - Start by learning about the the [`polkadot_sdk`], its structure and context.
|
|
//! - Then, head over 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`].
|
|
//! - 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.
|
|
#![doc = simple_mermaid::mermaid!("../../mermaid/IA.mmd")]
|
|
#![warn(rustdoc::broken_intra_doc_links)]
|
|
#![warn(rustdoc::private_intra_doc_links)]
|
|
#![doc(html_favicon_url = "https://polkadot.network/favicon-32x32.png")]
|
|
#![doc(
|
|
html_logo_url = "https://europe1.discourse-cdn.com/standard21/uploads/polkadot2/original/1X/eb57081e2bb7c39e5fcb1a98b443e423fa4448ae.svg"
|
|
)]
|
|
#![doc(issue_tracker_base_url = "https://github.com/paritytech/polkadot-sdk/issues")]
|
|
|
|
/// Meta information about this crate, how it is built, what principles dictates its evolution and
|
|
/// how one can contribute to it.
|
|
pub mod meta_contributing;
|
|
|
|
/// In-depth guides about the most common components of the Polkadot SDK. They are slightly more
|
|
/// high level and broad than reference docs.
|
|
pub mod guides;
|
|
/// 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.
|
|
pub mod polkadot_sdk;
|
|
/// 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.
|
|
pub mod reference_docs;
|