Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add devhub crate #1843

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ members = [
"cumulus/test/runtime",
"cumulus/test/service",
"cumulus/xcm/xcm-emulator",
"devhub",
"polkadot",
"polkadot/cli",
"polkadot/core-primitives",
Expand Down
12 changes: 12 additions & 0 deletions devhub/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
[package]
name = "devhub"
description = "A crate for the Polkadot SDK's reference documentation and tutorials"
license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
homepage = "https://substrate.io"
repository.workspace = true
authors.workspace = true
edition.workspace = true
version = "1.0.0"

# The dependencies are only needed for docs.
[dependencies]
6 changes: 6 additions & 0 deletions devhub/src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
//! # Polkadot SDK Developer Hub
//!
//! The devhub contains reference documentation and a tutorial for building with the Polkadot SDK.

pub mod reference_docs;
pub mod tutorial;
14 changes: 14 additions & 0 deletions devhub/src/reference_docs/extrinsics.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
//! # Extrinsics and Calls
//!
//! **This page is currently under construction.**
//!
//! Reference documentation for the different types of extrinsics and how to construct them.
//!
//! An extrinsic is some data that can be added to a block, and is either signed (a transaction) or
//! unsigned (an inherent).
//!
//! > Note: The term "call", "extrinsic", and "dispatchable" often get mixed together.
//! > Here is a sentence which should help clarify their relationship, and why they are such similar
//! > terms:
//! > **Users submit an **extrinsic** to the blockchain, which is **dispatched** to a Pallet
//! > **call**.**
9 changes: 9 additions & 0 deletions devhub/src/reference_docs/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
//! # Reference Documentation
//!
//! Reference material for common concepts in Substrate.
//!
//! - [Extrinsics](extrinsics)
//! - [Weights](weights)

pub mod extrinsics;
pub mod weights;
5 changes: 5 additions & 0 deletions devhub/src/reference_docs/weights.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
//! # Weights and Benchmarking
//!
//! **This page is currently under construction.**
//!
//! Reference material for how weights and benchmarking works.
3 changes: 3 additions & 0 deletions devhub/src/tutorial/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
//! The Polkadot SDK Master Tutorial

pub mod step1;
3 changes: 3 additions & 0 deletions devhub/src/tutorial/step1.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
//! # Step 1
//!
//! **This module is currently under construction.**
Loading