mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 14:37:57 +00:00
Juan Girini
a310df263d
This PR is a continuation of https://github.com/paritytech/polkadot-sdk/pull/2102 and part of an initiative started here https://hackmd.io/@romanp/rJ318ZCEp What has been done: - The content under `docs/*` (with the exception of `docs/mermaid`) has been moved to `docs/contributor/` - Developer Hub has been renamed to Polkadot SDK Docs, and the crate has been renamed from `developer-hub` to `polkadot-sdk-docs` - The content under `developer-hub/*` has been moved to `docs/sdk` --- Original PR https://github.com/paritytech/polkadot-sdk/pull/2565, it has been close due to too many rebase conflicts --------- Co-authored-by: Serban Iorga <serban@parity.io> Co-authored-by: Chevdor <chevdor@users.noreply.github.com> Co-authored-by: Egor_P <egor@parity.io> Co-authored-by: Bastian Köcher <git@kchr.de>
44 lines
2.2 KiB
Rust
44 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 [`crate::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")]
|
|
#![allow(rustdoc::invalid_html_tags)] // TODO: remove later. https://github.com/paritytech/polkadot-sdk-docs/issues/65
|
|
#![allow(rustdoc::bare_urls)] // TODO: remove later. https://github.com/paritytech/polkadot-sdk-docs/issues/65
|
|
#![warn(rustdoc::broken_intra_doc_links)]
|
|
#![warn(rustdoc::private_intra_doc_links)]
|
|
|
|
/// 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;
|