mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 13:27:57 +00:00
Marcin S
1dec2433ae
* Add PVF module documentation TODO (once the PRs land): - [ ] Document executor parametrization. - [ ] Document CPU time measurement of timeouts. * Update node/core/pvf/src/lib.rs Co-authored-by: Andrei Sandu <54316454+sandreim@users.noreply.github.com> * Clarify meaning of PVF acronym * Move PVF doc to implementer's guide * Clean up implementer's guide a bit * Add page for PVF types * pvf: Better separation between crate docs and implementer's guide * ci: Add "prevalidating" to the dictionary * ig: Remove types/chain.md The types contained therein did not exist and the file was not referenced anywhere. Co-authored-by: Andrei Sandu <54316454+sandreim@users.noreply.github.com>
36 lines
841 B
Markdown
36 lines
841 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/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).
|