Coretime Guides Rework (Omninode Considerations) (#5946)

* Start refactor * add todo * install instructions for chain_spec_builder and polkadot-parachain * remove chain spec * initial ideas * initial complete draft * change cargo install to crates.io * add most missing instructions * add instructions for patch file * cosmetic adjustment * random * polish * fix command * add finishing details * Apply suggestions from code review Co-authored-by: Radha <[email protected]> * Add info on block/state pruning * improve writing * Update docs/build/build-guides-template-basic.md Co-authored-by: Radha <[email protected]> --------- Co-authored-by: Radha <[email protected]>
w3f · Sep 13, 2024 · 49011a5 · 49011a5
1 parent 1261c41
commit 49011a5
Show file tree

Hide file tree

Showing 3 changed files with 243 additions and 118 deletions.
diff --git a/docs/build/build-guides-coretime-start.md b/docs/build/build-guides-coretime-start.md
@@ -20,8 +20,7 @@ Polkadot. These guides are **not** production ready due to the moving nature of
 
 ## Using the Polkadot SDK
 
-At first glance, the Polkadot SDK can be rather overwhelming, and in a way it is - it packs a lot of
-tech into one place. The Polkadot SDK used to be overarching **three** repositories:
+The Polkadot SDK is comprised of **three** important repositories:
 
 - [**Polkadot**](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/index.html#polkadot) -
   Which for a time, included both the client implementation and runtime, until the runtime was moved
@@ -38,9 +37,9 @@ tech into one place. The Polkadot SDK used to be overarching **three** repositor
 
 :::info What is a task?
 
-You might see the term "task" referenced quite a bit, but in most cases, it refers to a process
-utilizing Polkadot's compute. This could be a parachain or any other computational process, provided
-that it adheres to the Polkadot protocol.
+You might see the term "task" referenced often in place of "parachain". In most cases, it refers to a
+process utilizing the relay chain's compute. This could be a parachain or any other computational
+process, provided that it adheres to the Polkadot protocol interface.
 
 The full definition can be found [here](../learn/learn-agile-coretime.md#task).
 
@@ -106,7 +105,9 @@ PC-->DEP
 ### Install dependencies
 
 Make sure you have everything you need for your target system
-[here.](./build-guides-install-deps.md)
+[here.](./build-guides-install-deps.md).
+
+Be sure you also install the `polkadot-parachain` and `chain-spec-builder` binaries, as they needed to start and run your chain!
 
 ### Deployment Example - Adder Collator
 

diff --git a/docs/build/build-guides-install-deps.md b/docs/build/build-guides-install-deps.md
@@ -418,3 +418,25 @@ active toolchain
 nightly-x86_64-unknown-linux-gnu (overridden by +toolchain on the command line)
 rustc 1.63.0-nightly (e7144
 ```
+
+## Install `polkadot-parachain` and `chain-spec-builder`
+
+The `polkadot-parachain` can be used a universal collator instance for running most of the
+parachains (an
+["omninode beta"](https://forum.polkadot.network/t/polkadot-parachain-omni-node-gathering-ideas-and-feedback/7823)).
+It can be installed as follows:
+
+```sh
+cargo install --git https://github.com/paritytech/polkadot-sdk --tag polkadot-v1.15.1 --force polkadot-parachain-bin
+```
+
+`chain-spec-builder` is how you will generate chain specifications for your network. It requires a
+`wasm` runtime bundle to generate the chain specification from.
+
+It can be installed as follows:
+
+> Note that chain-spec-builder only works with select Polkadot SDK versions (`<v1.13.0`)
+
+```sh
+cargo install staging-chain-spec-builder
+```