DEPRECATED - Polkadot Network Directory

This repository is deprecated in favour of @polkadot-cloud.

Documentation about Chains of the Polkadot and Kusama networks

Install tooling

     chain_foo.yaml   \
     chain_bar.yaml    }    chains.json            }     mdbook
     chain_baz.yaml   /     markdown per chain    /

You can refresh the book using:

 just render

You can automatically watch the changes by using:

 just watch

If you want to serve a page showing the result, in another terminal, you may run:

 just serve

The only content that needs editing are the yaml files under chain_info. Do NOT edit any of the markdown files, your changes will be lost.

You can find template files using:

 find . -name "*.tera"

There are 2 important templates:

templates/one.md.tera: This template is used to convert the input yaml data into a markdown file per chain
templates/summary.md.tera: This template is used to dynamically generate the summary of the book, it takes care of organising parachains under their parent relaychain

During the generation, all the data is aggregated into a json file containing the information about all the chains.