Skip to content

Commit

Permalink
Move "Getting Started with Coretime" to new category in Learn (#5895)
Browse files Browse the repository at this point in the history
* move to new category in Learn

* add warning
  • Loading branch information
CrackTheCode016 authored May 16, 2024
1 parent d298c04 commit fe57cee
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 28 deletions.
13 changes: 8 additions & 5 deletions docs/build/build-guides-coretime-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ slug: ../build-guides-coretime-start

:::

:::warning Only for Kusama and testnets!
:::warning Not a production ready guide.

Agile coretime is only for the Kusama and testnet networks at the moment, and is not yet deployed on
Polkadot.
Polkadot. These guides are **not** production ready due to the moving nature of these features.

:::

Expand Down Expand Up @@ -115,7 +115,9 @@ Try out the above by deploying the

## OpenZeppelin Templates & Guides

OpenZeppelin offers a [generic parachain template](https://github.com/OpenZeppelin/polkadot-generic-runtime-template), which has support for:
OpenZeppelin offers a
[generic parachain template](https://github.com/OpenZeppelin/polkadot-generic-runtime-template),
which has support for:

- Proxy Pallet
- Multisig Pallet
Expand All @@ -128,5 +130,6 @@ For more information, check their

## Polkadot SDK Parachain Template

If you wish to the [Polkadot SDK's Parachain template](https://github.com/paritytech/polkadot-sdk/tree/master/templates/parachain), please follow the
[Template to Core guide.](./build-guides-template-basic.md)
If you wish to the
[Polkadot SDK's Parachain template](https://github.com/paritytech/polkadot-sdk/tree/master/templates/parachain),
please follow the [Template to Core guide.](./build-guides-template-basic.md)
16 changes: 9 additions & 7 deletions docs/build/build-guides-template-basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: [coretime, blockspace, parathread, parachain, cores, coretime, agile]
slug: ../build-guides-template-basic
---

:::warning This guide uses Rococo!
:::warning Not a production ready guide.

This guide uses the Rococo testnet. The Kusama relay chain can also be used in place of Rococo, as
coretime is also enabled there. Polkadot will enable agile coretime after it has been thoroughly
Expand Down Expand Up @@ -52,7 +52,8 @@ with the option to "Deregister" to the right:
We can now move on to working with the template. Some essential prerequisites are:

1. **Install** Rust and its associated tooling.
2. **Install** the [Rust nightly version](https://rust-lang.github.io/rustup/concepts/channels.html#working-with-nightly-rust).
2. **Install** the
[Rust nightly version](https://rust-lang.github.io/rustup/concepts/channels.html#working-with-nightly-rust).
3. **Have** a command line, git, and other common development tools.

:::info Install dependencies
Expand Down Expand Up @@ -84,9 +85,10 @@ This tutorial won't go into the specifics of the template, nor will it go into t
FRAME and Substrate. All you need to know is the following:

- `runtime/` - Contains the runtime and business logic. This is how all of your pallets (runtime
modules) are configured. The runtime, once it's compiled as a WebAssembly blob, is uploaded to the state on-chain.
- `node/` - The node implementation takes care of networking and RPC setup. The genesis configuration
(`chain_spec.rs`) is also located here.
modules) are configured. The runtime, once it's compiled as a WebAssembly blob, is uploaded to the
state on-chain.
- `node/` - The node implementation takes care of networking and RPC setup. The genesis
configuration (`chain_spec.rs`) is also located here.

> Pallets are essentially just Rust crates, which are imported as dependencies, as seen in
> `runtime/Cargo.toml`. Read more about
Expand All @@ -100,8 +102,8 @@ definitey a next step after you get used to deploying your parachain on Rococo!

### Configuring Parachain's Chain Spec

Before we generate the binary for our parachain's node, we have a bit of prep to do to our node inside
`node/src/chain_spec.rs`. Namely, there are a few main factors to check off our list:
Before we generate the binary for our parachain's node, we have a bit of prep to do to our node
inside `node/src/chain_spec.rs`. Namely, there are a few main factors to check off our list:

1. **Make** sure that `relay_chain` is set to the target relay chain (`rococo`, in our case)
2. **Make** sure that `para_id` (right below `relay_chain`) is set to your reserved ParaId
Expand Down
33 changes: 17 additions & 16 deletions kusama-guide/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,23 @@ module.exports = {
"learn/learn-agile-coretime",
"learn/learn-guides-coretime-marketplaces",
"learn/learn-guides-coretime-parachains",
{
type: "category",
label: "Advanced Coretime Guides",
description: "More Advanced and Technical Coretime Guides",
link: {
type: 'generated-index',
title: "Advanced Coretime Guides",
description: "Concepts, Implementation and Tutorials on Agile Coretime.",
slug: '/learn-agile-coretime-getting-started',
},
items: [
"build/build-guides-install-deps",
"build/build-guides-coretime-start",
"build/build-guides-template-basic",
"build/build-guides-coretime-troubleshoot"
]
}
],
},
{
Expand Down Expand Up @@ -717,22 +734,6 @@ module.exports = {
"build/build-node-interaction",
],
},
{
type: "category",
label: "Getting Started with Coretime",
link: {
type: 'generated-index',
title: "Getting Started with Coretime",
description: "Learn how to get started with building parachains, solo-chains, and other aspects of protocol development.",
slug: '/build-coretime-index',
},
items: [
"build/build-guides-install-deps",
"build/build-guides-coretime-start",
"build/build-guides-template-basic",
"build/build-guides-coretime-troubleshoot"
],
},
"build/build-smart-contracts",
{
type: "category",
Expand Down

0 comments on commit fe57cee

Please sign in to comment.