Polkadot Wiki

The Source of Truth for Polkadot

• Contributing to Documentation
• Running Locally
  • Build
• Style and Configuration Guide
  • Formatting
  • Automation
    • Deployments
    • GitHub Actions
  • Conditional Rendering
  • Mkdocs Macros
    • RPC Macro Example
• Internationalization
• License

The Polkadot Wiki is the central source of truth for Polkadot. It is a community-focused initiative led by
Web3 Foundation to keep an up-to-date resource on the best information for learning, building, or maintaining
on Polkadot.

Contributing to Documentation

The Technical Education team at Web3 Foundation
are the primary maintainers of the Wiki and will review all issues and pull requests created on this
repository. If you notice typos or grammatical errors, please feel free to create pull requests with
these corrections directly. Larger contributions may start as issues to test the waters on the
subject with the maintainers. It is generally preferable to create a pull request over an issue to
propose a change to the Wiki content.

Running Locally

• Make sure python (Python 3.12+), pip and mkdocs are installed and configured in your path
• It’s recommended to use a virtual environment, as is common practice
• Ensure you are in the polkadot-wiki directory

1. Install dependencies

    pip install -r requirements.txt

2. Once installed, run the serve command:

    # Set ENABLE_RPC to true if you plan to work with RPC macros
    ENABLE_RPC=false mkdocs serve

Build

🟣 Building the Polkadot Wiki:

# Set ENABLE_RPC to true if you plan to work with RPC macros
ENABLE_RPC=false mkdocs build

Formatting

See the Conditional Rendering and
Mkdocs Macros sections for additional details regarding how to
properly format syntax for elements outside of the standard markdown library.

Automation

Deployments

The Polkadot Wiki is built in a CI job, where it is then deployed on Netlify. Each commit to master triggers a new build and production deployment.

Pull request previews are enabled, meaning a temporary deployment via Netlify is generated for each PR.

After these jobs are successfully completed, the CICD production workflow will automatically deploy
prod to the public site when the PR is merged to master: Polkadot Wiki.

GitHub Actions

Conditional Rendering

The Polkadot Wiki does not support conditional rendering. If needed, represent multiple chains (i.e, Polkadot and Kusama) using the tab layout specified here on the Mkdocs Material documentation.

Mkdocs Macros

Mkdocs macros allow the use of Jinja2 templates and custom Python functions to allow for custom data fetching and rendering within Mkdocs. All current macros can be found in: macros/.

RPC Macro Example

For example, the rpc macro can be used in the following manner, with each field representing the input for the function signature respectively.

1. rpc macro function signature:

def rpc(network, module, call, default_value, is_constant=False, readable="")

1. Example Usage:

## Number of Nominators
{{ rpc("polkadot", "Staking", "CounterForNominators", 36793, is_constant=false) }}

1. Different types of readable, depending on usage and network:
   • Percentage
   • Human Readable / Human Readable Kusama (rounds to nearest 100)
   • Blocks to days (converts blocks to days)
   • Precise DOT / KSM (returns an unrounded number with full precision)

Internationalization

License

The Polkadot Wiki is licensed under the GPL-3.0 free software license.