Files
pezkuwi-subxt/polkadot/roadmap/implementers-guide/README.md
T
Anton Vilhelm Ásgeirsson d2fc1d7c91 Fix links to implementers' guide (#1865)
# Description

In a couple of cases, there were links pointing to the w3f github pages
domain. In other instances, there were links pointing to the old
polkadot repo's github pages. Both of these are now pointing to the
relevant links in
https://paritytech.github.io/polkadot-sdk/book/index.html.

These changes were made specifically because the w3f github pages
returns a 404, and while fixing the links, the old polkadot repo links
were touched up as well even if they do redirect properly.

This shouldn't affect anything as these are documentation link changes
only.
2023-10-12 21:29:10 +02:00

36 lines
845 B
Markdown

# The Polkadot Parachain Host Implementers' Guide
The implementers' guide is compiled from several source files with [`mdBook`](https://github.com/rust-lang/mdBook).
## Hosted build
This is available [here](https://paritytech.github.io/polkadot-sdk/book/).
## Local build
To view it locally from the repo root:
Ensure graphviz is installed:
```sh
brew install graphviz # for macOS
sudo apt-get install graphviz # for Ubuntu/Debian
```
Then install and build the book:
```sh
cargo install mdbook mdbook-linkcheck mdbook-graphviz mdbook-mermaid mdbook-last-changed
mdbook serve roadmap/implementers-guide
```
and in a second terminal window run:
```sh
open http://localhost:3000
```
## Specification
See also the Polkadot specification [hosted](https://spec.polkadot.network/), and its [source](https://github.com/w3f/polkadot-spec).