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

Transition to Docusaurus 3 #5391

Closed
wants to merge 8 commits 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: 2 additions & 2 deletions .vscode/snippets.code-snippets
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@
// }
"Polkadot braces": {
"prefix": "pol",
"body": ["{{ polkadot: :polkadot }}"],
"body": ["\{\{ polkadot: :polkadot }}"],
"description": "Polkadot wiki conditional rendering for Polkadot strings"
},
"Kusama braces": {
"prefix": "pol",
"body": ["{{ kusama: :kusama }}"],
"body": ["\{\{ kusama: :kusama }}"],
"description": "Polkadot wiki conditional rendering for Kusama strings"
}
}
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -206,13 +206,14 @@ command. After these jobs are completed, the CICD production workflow will autom
The two Wikis support conditional rendering depending on which Wiki is being deployed. This is
useful for mirrored pages with most content in common but have minor differences. To use this
functionality, surround Kusama specific content with
`{{ kusama: KUSAMA_SPECIFIC_CONTENT :kusama }}`, and polkadot specific content with
`{{ polkadot: POLKADOT_SPECIFIC_CONTENT :polkadot }}`.
`\{\{ kusama: KUSAMA_SPECIFIC_CONTENT :kusama }}`, and polkadot specific content with
`\{\{ polkadot: POLKADOT_SPECIFIC_CONTENT :polkadot }}`.

For example the syntax:

```markdown
The {{ polkadot: Polkdadot Wiki :polkadot }} {{ kusama: Kusama Guide :kusama }} is a great resource!
The \{\{ polkadot: Polkdadot Wiki :polkadot }}\{\{ kusama: Kusama Guide :kusama }} is a great
resource!
```

Will render:
Expand Down Expand Up @@ -257,20 +258,20 @@ that will not be modified by the prettier command:
Always wrap RPC components in conditional rendering & keep them on new lines:

```
{{ polkadot: <RPC network="polkadot" path="query.staking.validatorCount" defaultValue={297}/> :polkadot }}
{{ kusama: <RPC network="kusama" path="query.staking.validatorCount" defaultValue={297}/> :kusama }}
\{\{ polkadot: <RPC network="polkadot" path="query.staking.validatorCount" defaultValue={297}/> :polkadot }}
\{\{ kusama: <RPC network="kusama" path="query.staking.validatorCount" defaultValue={297}/> :kusama }}
```

To add grammar without added spacing, place the grammar inside the conditional brackets:

```
The validator count followed by a period is
{{ polkadot: <RPC network="polkadot" path="query.staking.validatorCount" defaultValue={297}/>. :polkadot }}
{{ kusama: <RPC network="kusama" path="query.staking.validatorCount" defaultValue={297}/>. :kusama }}
\{\{ polkadot: <RPC network="polkadot" path="query.staking.validatorCount" defaultValue={297}/>. :polkadot }}
\{\{ kusama: <RPC network="kusama" path="query.staking.validatorCount" defaultValue={297}/>. :kusama }}

The validator count in parentheses is
{{ polkadot: (<RPC network="polkadot" path="query.staking.validatorCount" defaultValue={297}/>) :polkadot }}
{{ kusama: (<RPC network="kusama" path="query.staking.validatorCount" defaultValue={297}/>) :kusama }}
\{\{ polkadot: (<RPC network="polkadot" path="query.staking.validatorCount" defaultValue={297}/>) :polkadot }}
\{\{ kusama: (<RPC network="kusama" path="query.staking.validatorCount" defaultValue={297}/>) :kusama }}
```

Failing to follow this schema can results in unexpected formatting, such as added line-breaks or
Expand Down
4 changes: 2 additions & 2 deletions components/Http-Request-Sample.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ The component can be used in Docusaurus markdown
by adding the following lines anywhere within the file.

import Http from "./../../components/Http-Request-Sample"
{{ polkadot: <Http url="https://polkadot.api.subscan.io/api/scan/block" hash="0x68a27df5a52ff2251df2cc8368f7dcefb305a13bb3d89b65c8fb070f23877f2c" color="#e6007a">Polkadot</Http> :polkadot }}
{{ kusama: <Http url="https://kusama.api.subscan.io/api/scan/block" hash="0x8019e80a0b97ee827b3bd8be1ac3d0fe4e9978d7b5594c0afb109d3ff8cf3465" color="#000000">Kusama</Http> :kusama }}
\{\{ polkadot: <Http url="https://polkadot.api.subscan.io/api/scan/block" hash="0x68a27df5a52ff2251df2cc8368f7dcefb305a13bb3d89b65c8fb070f23877f2c" color="#e6007a">Polkadot</Http> :polkadot }}
\{\{ kusama: <Http url="https://kusama.api.subscan.io/api/scan/block" hash="0x8019e80a0b97ee827b3bd8be1ac3d0fe4e9978d7b5594c0afb109d3ff8cf3465" color="#000000">Kusama</Http> :kusama }}
*/

function WebRequest({children, url, hash, color}) {
Expand Down
2 changes: 1 addition & 1 deletion components/Voluntary-Locking.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ function VoluntaryLocking() {

useEffect(() => {
// This is a hack to get the document type.
// It is required because the standard {{ polkadot/kusama: :polkadot/kusama}}
// It is required because the standard \{\{ polkadot/kusama: :polkadot/kusama}}
// can't be used to render a table (can't put a <table> in a <p>).
// So, we use the same component for Polkadot and Kusama and figure it out here.
const title = document.title;
Expand Down
42 changes: 21 additions & 21 deletions docs/build/build-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem"; import Doc

<DocCardList />

{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} is a blockchain protocol with two
\{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }} is a blockchain protocol with two
goals: providing **shared security** among all connected parachains and allowing all connected
chains to **interoperate** by using [XCM](../learn/learn-xcm.md). With the advent of
[PDKs](../build/build-parachains.md#parachain-development-kit) like
Expand All @@ -21,9 +21,9 @@ takes to develop and launch a new chain has dropped significantly. While before,
to launch a new chain, now it may only take weeks or even days, depending on your goals.

This guide will walk you through the steps you can take today to get started building your vision
with {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }}. It will explain the difference
between a [parachain](../learn/learn-parachains.md) and a smart contract in deciding which best fits
your architectural needs.
with \{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }}. It will explain the
difference between a [parachain](../learn/learn-parachains.md) and a smart contract in deciding
which best fits your architectural needs.

This build guide provides three different tracks:

Expand All @@ -33,8 +33,8 @@ This build guide provides three different tracks:

:::tip Keep reading to find out more, or visit each respective track

Keep in mind that these tracks are merely suggestive, and there are many ways to utilize
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }}, Substrate, and their various
Keep in mind that these tracks are merely suggestive, and there are many ways to utilize \{\{
polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }}, Substrate, and their various
developmental components. For more inspiration, look at the
[open source projects](./build-open-source.md) featured here in the wiki!

Expand Down Expand Up @@ -80,19 +80,19 @@ flowchart TB
end
```

Before diving into the various paths, one can take in developing on
{{ polkadot: Polkadot :polkadot }}, it's important to realize and know key terms that make up the
following sections. Even before considering what kind of application you want to build, it's prudent
to understand what {{ polkadot: Polkadot :polkadot }} _is_ and how {{ kusama: Kusama :kusama }}
relates to it, and what each developmental component can do for you within the Polkadot ecosystem.
Before diving into the various paths, one can take in developing on \{\{ polkadot: Polkadot
:polkadot }}, it's important to realize and know key terms that make up the following sections. Even
before considering what kind of application you want to build, it's prudent to understand what \{\{
polkadot: Polkadot :polkadot }} _is_ and how \{\{ kusama: Kusama :kusama }} relates to it, and what
each developmental component can do for you within the Polkadot ecosystem.

Before diving into any one of these tracks, it is encouraged to read about
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} and its networks in order to gain
context about the application you could make.
Before diving into any one of these tracks, it is encouraged to read about \{\{ polkadot: Polkadot
:polkadot }}\{\{ kusama: Kusama :kusama }} and its networks in order to gain context about the
application you could make.

## Building Parachains

{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} is canonically referred to as the
\{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }} is canonically referred to as the
Relay Chain. It is also considered a _layer zero_ protocol, as it enables the interoperability and
shared security of multiple [parachains](../learn/learn-parachains.md), which are _layer one_
protocols. Parachains connect to a relay chain using the
Expand All @@ -105,8 +105,8 @@ protocols. Parachains connect to a relay chain using the
Throughout this document, you will encounter the term **runtime** or **STF (State Transition
Function)**. Both refer to the same concept, as they define how a particular system, i.e., a
blockchain, should deal with state changes externally and internally. Both of these terms are used
extensively in {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }}, and by association,
Substrate contexts.
extensively in \{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }}, and by
association, Substrate contexts.

:::

Expand Down Expand Up @@ -199,10 +199,10 @@ a parachain or parathread.
#### Parachains Benefits

Parachains contain their own runtime/STF logic and benefit from the shared security and the
cross-consensus messaging provided by the {{ polkadot: Polkadot :polkadot }} relay chain. Parachains
permit high flexibility and customization but require more effort to create and maintain over time.
A production-grade parachain is typically more involved to create due to the complexity involved in
blockchain networks' technical and economic aspects.
cross-consensus messaging provided by the \{\{ polkadot: Polkadot :polkadot }} relay chain.
Parachains permit high flexibility and customization but require more effort to create and maintain
over time. A production-grade parachain is typically more involved to create due to the complexity
involved in blockchain networks' technical and economic aspects.

Parachains grant the creators more space to build the monetary system and other chain aspects from
the ground up. They will allow for a more concise and efficient execution of complex logic than a
Expand Down
8 changes: 4 additions & 4 deletions docs/build/build-hackathon.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ slug: ../build-hackathon
## Join a Hackathon

Web3 Foundation regularly supports developer focused events! Be the first to know by signing up for
the {{ polkadot: [Polkadot newsletter](https://info.polkadot.network/subscribe). :polkadot }}
{{ kusama: [Kusama newsletter](https://kusama.network/newsletter/). :kusama }}
the \{\{ polkadot: [Polkadot newsletter](https://info.polkadot.network/subscribe). :polkadot }}\{\{
kusama: [Kusama newsletter](https://kusama.network/newsletter/). :kusama }}

## Host a Hackathon

As one of our objectives in the Web3 Foundation is promoting the
[Web3 technology stack](https://wiki.polkadot.network/docs/build-open-source), we would like to
support any individual or team who wants to organize a hackathon that gets more developers to
understand {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} and Substrate in your city
or online.
understand \{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }} and Substrate in your
city or online.

We are not only providing technical resources for you, but we can have someone from our team give a
hands-on workshop/presentation about the technology to help participants get started hacking on it
Expand Down
23 changes: 11 additions & 12 deletions docs/build/build-index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,23 @@ keywords: [build, index, tools, resources]
slug: ../build-index
---

Welcome to the builder's section of the {{ polkadot: Polkadot Wiki. :polkadot }}
{{ kusama: Kusama Guide. :kusama }}
Welcome to the builder's section of the \{\{ polkadot: Polkadot Wiki. :polkadot }}\{\{ kusama:
Kusama Guide. :kusama }}

Here, you will discover many development tools and resources in the
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} ecosystem. We are always adding new
tools and frameworks as we learn about them, so if you are working on something that should be
included, please reach out to us on
{{ polkadot: [Element](https://matrix.to/#/#polkadot-watercooler:matrix.org). :polkadot }}
{{ kusama: [Element](https://matrix.to/#/#kusama-watercooler:matrix.org). :kusama }} This section of
the wiki is divided into the following parts:
Here, you will discover many development tools and resources in the \{\{ polkadot: Polkadot
:polkadot }}\{\{ kusama: Kusama :kusama }} ecosystem. We are always adding new tools and frameworks
as we learn about them, so if you are working on something that should be included, please reach out
to us on \{\{ polkadot: [Element](https://matrix.to/#/#polkadot-watercooler:matrix.org). :polkadot
}}\{\{ kusama: [Element](https://matrix.to/#/#kusama-watercooler:matrix.org). :kusama }} This
section of the wiki is divided into the following parts:

## Development Guide

- [Starter's Guide](build-guide.md) - High-level overview on choosing a parachain, parathread, or
smart contract for your project and how to get started.
- [Parachain Development](build-parachains.md) - Tools for building parachains and parathreads.
- [Smart Contracts](build-smart-contracts.md) - Tools to deploy contracts to a
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} parachain.
- [Smart Contracts](build-smart-contracts.md) - Tools to deploy contracts to a \{\{ polkadot:
Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }} parachain.

## Tools & Resources

Expand All @@ -39,7 +38,7 @@ the wiki is divided into the following parts:
### Grants

- [Grants](../general/grants.md) - Information regarding grants and funding sources available in the
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} ecosystem.
\{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }} ecosystem.

### PCPs

Expand Down
25 changes: 12 additions & 13 deletions docs/build/build-integrate-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ keywords: [assets, integration, api, operations]
slug: ../build-integrate-assets
---

The {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} Relay Chain does not natively
support assets beyond {{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }}. This functionality
The \{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }} Relay Chain does not natively
support assets beyond \{\{ polkadot: DOT :polkadot }}\{\{ kusama: KSM :kusama }}. This functionality
exists in parachains. On both Polkadot and Kusama, this parachain is called Asset Hub.

The Asset Hub provides a first-class interface for creating, managing, and using fungible and
Expand Down Expand Up @@ -87,8 +87,8 @@ issue so a developer can help.
### Parachain Node

Using the Asset Hub will require running a parachain node to sync the chain. This is very similar to
running a {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} node, with the addition of
some extra flags. You can follow
running a \{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }} node, with the addition
of some extra flags. You can follow
[these guidelines](https://github.com/paritytech/polkadot-sdk/tree/master/cumulus#asset-hub-) to set
up an Asset Hub node.

Expand Down Expand Up @@ -140,12 +140,11 @@ and type registry.

#### Monitoring of XCM deposits

Thanks to XCM and a growing number of parachains,
{{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }} can exist across several blockchains, which
means the providers need to monitor cross-chain transfers on top of local transfers and
corresponding `balances.transfer` events.
Thanks to XCM and a growing number of parachains, \{\{ polkadot: DOT :polkadot }}\{\{ kusama: KSM
:kusama }} can exist across several blockchains, which means the providers need to monitor
cross-chain transfers on top of local transfers and corresponding `balances.transfer` events.

Currently {{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }} can be sent and received in the
Currently \{\{ polkadot: DOT :polkadot }}\{\{ kusama: KSM :kusama }} can be sent and received in the
Relay Chain either with a [Teleport](https://wiki.polkadot.network/docs/learn-teleport) from
[system parachains](https://wiki.polkadot.network/docs/learn-system-chains) or with a
[Reserve Backed Transfer](https://wiki.polkadot.network/docs/learn-xcm-pallet#transfer-reserve-vs-teleport)
Expand All @@ -156,10 +155,10 @@ events array, filter for any `balances.deposit` event, and apply the appropriate

#### Tracking back XCM information

What has been mentioned earlier should be sufficient to confirm that
{{ polkadot: DOT :polkadot }}{{ kusama: KSM :kusama }} has arrived in a given account via XCM.
However, in some cases, it may be interesting to identify the cross-chain message that emitted the
relevant `balances.deposit` event. This can be done as follows:
What has been mentioned earlier should be sufficient to confirm that \{\{ polkadot: DOT :polkadot
}}\{\{ kusama: KSM :kusama }} has arrived in a given account via XCM. However, in some cases, it may
be interesting to identify the cross-chain message that emitted the relevant `balances.deposit`
event. This can be done as follows:

1. Query the Relay Chain `at` the block the `balances.deposit` event was emitted.
2. Filter for a `messageQueue(Processed)` event, also emitted during block initialization. This
Expand Down
10 changes: 5 additions & 5 deletions docs/build/build-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ keywords: [protocol, integration, structure]
slug: ../build-integration
---

Welcome to the {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} integration guide.
Welcome to the \{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }} integration guide.
This guide will provide all the information you need to get started on your integration. The target
audiences for this guide are wallets and custodians, but it will be useful to any infrastructure
provider such as validators or chain indexers.
Expand All @@ -18,10 +18,10 @@ The guide focuses on Polkadot and Kusama, but the principles will apply to parac
Substrate-based chains. The guide contains four sections:

1. [Protocol Info](build-protocol-info.md): The entry point to the guide. Please read it carefully
as it provides information about {{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }}
that differentiates it from other blockchains. Use this page to check your assumptions.
1. [Assets](build-integrate-assets.md): The guide to integrating assets on
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} into your systems.
as it provides information about \{\{ polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama
}} that differentiates it from other blockchains. Use this page to check your assumptions.
1. [Assets](build-integrate-assets.md): The guide to integrating assets on \{\{ polkadot: Polkadot
:polkadot }}\{\{ kusama: Kusama :kusama }} into your systems.
1. [Node Management](build-node-management.md): This page will guide you to starting and monitoring
a node.
1. [Node Interaction](build-node-interaction.md): This page will teach you to interact with your
Expand Down
4 changes: 2 additions & 2 deletions docs/build/build-light-clients.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ with their applications.

A light client lets you utilize all basic features of the chain such as fetching data and
transferring tokens, but it does not require you to run a full copy of the entire blockchain or
having to trust remote peers. Light clients fetch the required data that they need from a
{{ polkadot: Polkadot :polkadot }}{{ kusama: Kusama :kusama }} node with an associated proof to
having to trust remote peers. Light clients fetch the required data that they need from a \{\{
polkadot: Polkadot :polkadot }}\{\{ kusama: Kusama :kusama }} node with an associated proof to
validate the data.

| Substrate: Full node | Substrate connect: Light client |
Expand Down
Loading