This folder contains verified, reproducible tests for guides from docs.polkadot.com. Each guide is a self-contained project that can be cloned and run to verify the documentation works as described.
This repository serves as the source of truth that Polkadot documentation works. When tests pass here, we can confidently link to these verified guides from the official docs.
| Guide | Status | Source |
|---|---|---|
| Run a Parachain Network | docs.polkadot.com | |
| Fork a Parachain | docs.polkadot.com |
Each guide folder contains:
README.md- Guide description and exact replication stepsrust-toolchain.toml- Pinned Rust versionpackage.json+package-lock.json- Pinned npm dependenciestests/- Verification tests that run withdot test
# Navigate to a guide
cd polkadot-docs/parachains/set-up-parachain-template
# Install dependencies (uses lock files for reproducibility)
npm ci
# Run verification tests
dot testAll guides use locked dependencies to ensure reproducible builds:
cargo build --locked- Uses exact crate versions fromCargo.locknpm ci- Uses exact npm versions frompackage-lock.jsonrust-toolchain.toml- Pins exact Rust version
If tests pass in CI, they should pass on your machine with the same versions.
When adding a new guide:
- Create a folder mirroring the docs.polkadot.com URL structure
- Copy
rust-toolchain.tomlfrom repo root - Add
package.jsonwith test dependencies - Write tests that verify each step of the guide
- Commit lock file (
package-lock.json)