Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Templates README docs #4980

Merged
merged 2 commits into from
Jul 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions templates/minimal/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* 🤏 This template is a minimal (in terms of complexity and the number of components)
template for building a blockchain node.

* 🔧 Its runtime is configured of a single custom pallet as a starting point, and a handful of ready-made pallets
* 🔧 Its runtime is configured with a single custom pallet as a starting point, and a handful of ready-made pallets
such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).

* 👤 The template has no consensus configured - it is best for experimenting with a single node network.
Expand Down Expand Up @@ -57,7 +57,7 @@ and don't forget to also customize the corresponding comments.
🔨 Use the following command to build the node without launching it:

```sh
cargo build --release
cargo build --package minimal-template-node --release
```

🐳 Alternatively, build the docker image:
Expand All @@ -80,7 +80,7 @@ docker run --rm polkadot-sdk-minimal-template --dev
Development chains:

* 🧹 Do not persist the state.
* 💰 Are preconfigured with a genesis state that includes several prefunded development accounts.
* 💰 Are preconfigured with a genesis state that includes several pre-funded development accounts.
* 🧑‍⚖️ Development accounts are used as `sudo` accounts.

### Connect with the Polkadot-JS Apps Front-End
Expand Down
6 changes: 3 additions & 3 deletions templates/parachain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
* ☁️ It is based on the
[Cumulus](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/polkadot_sdk/cumulus/index.html) framework.

* 🔧 Its runtime is configured of a single custom pallet as a starting point, and a handful of ready-made pallets
* 🔧 Its runtime is configured with a single custom pallet as a starting point, and a handful of ready-made pallets
such as a [Balances pallet](https://paritytech.github.io/polkadot-sdk/master/pallet_balances/index.html).

* 👉 Learn more about parachains [here](https://wiki.polkadot.network/docs/learn-parachains)
Expand Down Expand Up @@ -44,7 +44,7 @@ packages required to compile this template - please take note of the Rust compil
🔨 Use the following command to build the node without launching it:

```sh
cargo build --release
cargo build --package parachain-template-node --release
```

🐳 Alternatively, build the docker image:
Expand All @@ -70,7 +70,7 @@ and `zombienet` - into `PATH` like so:
export PATH="./target/release/:$PATH"
```

This way, we can conveniently use them un the following steps.
This way, we can conveniently use them in the following steps.

👥 The following command starts a local development chain, with a single relay chain node and a single parachain collator:

Expand Down
2 changes: 1 addition & 1 deletion templates/parachain/node/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

⚙️ It acts as a remote procedure call (RPC) server, allowing interaction with the blockchain.

👉 Learn more about the architecture, and a difference between a node and a runtime
👉 Learn more about the architecture, and the difference between a node and a runtime
[here](https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/reference_docs/wasm_meta_protocol/index.html).

👇 Here are the most important files in this node template:
Expand Down
16 changes: 8 additions & 8 deletions templates/solochain/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ installation](#alternatives-installations) options.
Use the following command to build the node without launching it:

```sh
cargo build --release
cargo build --package solochain-template-node --release
```

### Embedded Docs
Expand All @@ -37,7 +37,7 @@ After you build the project, you can use the following command to explore its
parameters and subcommands:

```sh
./target/release/node-template -h
./target/release/solochain-template-node -h
```

You can generate and view the [Rust
Expand All @@ -54,19 +54,19 @@ The following command starts a single-node development chain that doesn't
persist state:

```sh
./target/release/node-template --dev
./target/release/solochain-template-node --dev
```

To purge the development chain's state, run the following command:

```sh
./target/release/node-template purge-chain --dev
./target/release/solochain-template-node purge-chain --dev
```

To start the development chain with detailed logging, run the following command:

```sh
RUST_BACKTRACE=1 ./target/release/node-template -ldebug --dev
RUST_BACKTRACE=1 ./target/release/solochain-template-node -ldebug --dev
```

Development chains:
Expand All @@ -75,7 +75,7 @@ Development chains:
- Use the **Alice** and **Bob** accounts as default validator authorities.
- Use the **Alice** account as the default `sudo` account.
- Are preconfigured with a genesis state (`/node/src/chain_spec.rs`) that
includes several prefunded development accounts.
includes several pre-funded development accounts.


To persist chain state between runs, specify a base path by running a command
Expand All @@ -86,7 +86,7 @@ similar to the following:
$ mkdir my-chain-state

// Use of that folder to store the chain state
$ ./target/release/node-template --dev --base-path ./my-chain-state/
$ ./target/release/solochain-template-node --dev --base-path ./my-chain-state/

// Check the folder structure created inside the base path after running the chain
$ ls ./my-chain-state
Expand Down Expand Up @@ -142,7 +142,7 @@ following:
file that defines a Substrate chain's initial (genesis) state. Chain
specifications are useful for development and testing, and critical when
architecting the launch of a production chain. Take note of the
`development_config` and `testnet_genesis` functions,. These functions are
`development_config` and `testnet_genesis` functions. These functions are
used to define the genesis state for the local development chain
configuration. These functions identify some [well-known
accounts](https://docs.substrate.io/reference/command-line-tools/subkey/) and
Expand Down
Loading