Introduce Polkadot-Sdk developer_hub

.github/workflows/docs.yml

@@ -0,0 +1,34 @@
+name: Rust Docs
+
+on:
+  push:
+    branches: [kiz-developer-hub]
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      # Setup protoc
+      - name: Set up Protocol Buffers
+        uses: arduino/setup-protoc@v1
+
+      - name: Setup Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          override: true
+          components: rust-docs
+          target: wasm32-unknown-unknown
+
+      - name: Generate docs
+        run: cargo doc -p developer-hub -p sp-io -p sp-runtime -p frame -p frame-support --no-deps
+
+      - name: Deploy
+        uses: JamesIves/github-pages-deploy-action@v4
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: target/doc # The folder the action should deploy.

.gitignore

@@ -29,7 +29,7 @@ artifacts
 bin/node-template/Cargo.lock
 nohup.out
 polkadot_argument_parsing
-polkadot.*
+polkadot
 pwasm-alloc/Cargo.lock
 pwasm-libc/Cargo.lock
 release-artifacts

.gitlab/pipeline/build.yml

@@ -125,7 +125,7 @@ build-rustdoc:
         find "$path" -name '*.html' | xargs -I {} -P "$(nproc)" bash -c 'process_file "$@"' _ {}
       }
       inject_simple_analytics "./crate-docs"
-    - echo "<meta http-equiv=refresh content=0;url=polkadot_service/index.html>" > ./crate-docs/index.html
+    - echo "<meta http-equiv=refresh content=0;url=developer_hub/index.html>" > ./crate-docs/index.html
 
 build-implementers-guide:
   stage: build

Cargo.toml

@@ -8,6 +8,7 @@ license = "GPL-3.0-only"
 resolver = "2"
 
 members = [
+	"developer-hub",
 	"bridges/bin/runtime-common",
 	"bridges/modules/grandpa",
 	"bridges/modules/messages",
@@ -185,7 +186,6 @@ members = [
 	"polkadot/xcm/xcm-simulator/fuzzer",
 	"substrate/bin/minimal/node",
 	"substrate/bin/minimal/runtime",
-	"substrate",
 	"substrate/bin/node-template/node",
 	"substrate/bin/node-template/pallets/template",
 	"substrate/bin/node-template/runtime",
@@ -467,8 +467,7 @@ default-members = [ "polkadot", "substrate/bin/node/cli" ]
 panic = "unwind"
 opt-level = 3
 
-# make sure dev builds with backtrace do
-# not slow us down
+# make sure dev builds with backtrace do not slow us down
 [profile.dev.package.backtrace]
 inherits = "release"
 

cumulus/parachain-template/runtime/src/lib.rs

@@ -513,8 +513,7 @@ impl pallet_parachain_template::Config for Runtime {
 
 // Create the runtime by composing the FRAME pallets that were previously configured.
 construct_runtime!(
-	pub enum Runtime
-	{
+	pub struct Runtime {
 		// System support stuff.
 		System: frame_system = 0,
 		ParachainSystem: cumulus_pallet_parachain_system = 1,

cumulus/parachains/pallets/collective-content/src/mock.rs

@@ -96,9 +96,7 @@ impl WeightInfo for CCWeightInfo {
 // Build test environment.
 pub fn new_test_ext() -> sp_io::TestExternalities {
 	let t = RuntimeGenesisConfig::default().build_storage().unwrap().into();
-	let mut ext = sp_io::TestExternalities::new(t);
-	ext.execute_with(|| System::set_block_number(1));
-	ext
+	sp_io::TestExternalities::new(t)
 }
 
 #[cfg(feature = "runtime-benchmarks")]

cumulus/parachains/runtimes/collectives/collectives-polkadot/src/fellowship/migration.rs

@@ -238,7 +238,6 @@ pub mod tests {
 
 		let t = frame_system::GenesisConfig::<Runtime>::default().build_storage().unwrap();
 		let mut ext = sp_io::TestExternalities::new(t);
-		ext.execute_with(|| System::set_block_number(1));
 		ext.execute_with(|| {
 			assert_eq!(MemberCount::<Runtime, Fellowship>::get(0), 0);
 			Migration::<Runtime, Fellowship>::on_runtime_upgrade();

developer-hub/Cargo.toml

@@ -0,0 +1,61 @@
+[package]
+name = "developer-hub"
+description = "The one stop shop for developers of the polakdot-sdk"
+license = "GPL-3.0-or-later WITH Classpath-exception-2.0"
+homepage = "paritytech.github.io"
+repository.workspace = true
+authors.workspace = true
+edition.workspace = true
+# This crate is not publish-able to crates.io for now because of docify.
+publish = false
+version = "0.0.1"
+
+[dependencies]
+# Needed for all FRAME-based code
+parity-scale-codec = { version = "3.0.0", default-features = false }
+scale-info = { version = "2.6.0", default-features = false }
+frame = { path = "../substrate/frame", features = ["runtime", "experimental"] }
+pallet-examples = { path = "../substrate/frame/examples" }
+pallet-default-config-example = { path = "../substrate/frame/examples/default-config" }
+
+# How we build docs in rust-docs
+simple-mermaid = { git = "https://github.com/kianenigma/simple-mermaid.git", branch = "main" }
+docify = "0.2.6"
+
+# Polkadot SDK docs, typically all should only be scope such that we can link to their doc item.
+
+node-cli = { package = "staging-node-cli", path = "../substrate/bin/node/cli" }
+kitchensink-runtime = { path = "../substrate/bin/node/runtime" }
+chain-spec-builder = { package = "staging-chain-spec-builder", path = "../substrate/bin/utils/chain-spec-builder" }
+subkey = { path = "../substrate/bin/utils/subkey" }
+
+sc-network = { path = "../substrate/client/network" }
+sc-rpc-api = { path = "../substrate/client/rpc-api" }
+sc-rpc = { path = "../substrate/client/rpc" }
+sc-client-db = { path = "../substrate/client/db" }
+sc-cli = { path = "../substrate/client/cli" }
+sc-consensus-aura = { path = "../substrate/client/consensus/aura" }
+sc-consensus-babe = { path = "../substrate/client/consensus/babe" }
+sc-consensus-grandpa = { path = "../substrate/client/consensus/grandpa" }
+sc-consensus-beefy = { path = "../substrate/client/consensus/beefy" }
+sc-consensus-manual-seal = { path = "../substrate/client/consensus/manual-seal" }
+sc-consensus-pow = { path = "../substrate/client/consensus/pow" }
+substrate-wasm-builder = { path = "../substrate/utils/wasm-builder" }
+
+sp-io = { path = "../substrate/primitives/io" }
+sp-api = { path = "../substrate/primitives/api" }
+sp-core = { path = "../substrate/primitives/core" }
+sp-keyring = { path = "../substrate/primitives/keyring" }
+sp-runtime = { path = "../substrate/primitives/runtime" }
+
+[dev-dependencies]
+cumulus-pallet-aura-ext = { path = "../cumulus/pallets/aura-ext" }
+cumulus-pallet-parachain-system = { path = "../cumulus/pallets/parachain-system", features = [
+	"parameterized-consensus-hook",
+] }
+parachain-info = { package = "staging-parachain-info", path = "../cumulus/parachains/pallets/parachain-info" }
+pallet-aura = { path = "../substrate/frame/aura" }
+pallet-timestamp = { path = "../substrate/frame/timestamp" }
+
+parity-scale-codec = "3.6.5"
+scale-info = "2.9.0"

developer-hub/headers/toc.html

@@ -0,0 +1,53 @@
+<script>
+	window.addEventListener("DOMContentLoaded", (event) => {
+	// if the crate is one that starts with `developer_hub`
+	let crate_name = document.querySelector("#main-content > div > h1 > a:nth-child(1)");
+	if (!crate_name.textContent.startsWith("developer_hub")) {
+		console.log("skipping -- not `developer_hub`");
+	}
+
+    let sidebar = document.querySelector(".sidebar");
+    let headers = document.querySelectorAll("#main-content h2, #main-content h3, #main-content h4");
+	console.log(`detected developer_hub: headers: ${headers.length}`);
+
+    let toc = document.createElement("div");
+    toc.classList.add("table-of-contents");
+	toc.appendChild(document.createElement("h2").appendChild(document.createTextNode("Table of Contents")).parentNode);
+
+	// the first two headers are always junk
+    headers.forEach(header => {
+        let link = document.createElement("a");
+        link.href = "#" + header.id;
+        link.textContent = header.textContent;
+        link.className = header.tagName.toLowerCase();
+        toc.appendChild(link);
+    });
+
+    sidebar.insertBefore(toc, sidebar.firstChild);
+	console.log("injecting ToC");
+});
+</script>
+<style>
+.table-of-contents {
+    margin-bottom: 1em;
+    padding: 0.5em;
+}
+
+.table-of-contents a {
+    display: block;
+    margin: 0.2em 0;
+}
+
+.table-of-contents .h2 {
+    font-weight: bold;
+    margin-left: 0;
+}
+
+.table-of-contents .h3 {
+    margin-left: 1em;
+}
+
+.table-of-contents .h4 {
+    margin-left: 2em;
+}
+</style>