Skip to content

Commit e517594

Browse files
committed
Use MkDocs admonition syntax for notes and warnings
1 parent fda3e1c commit e517594

File tree

2 files changed

+21
-7
lines changed

2 files changed

+21
-7
lines changed

node-infrastructure/run-a-collator/collator.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -308,7 +308,9 @@ Sync time depends on:
308308

309309
The relay chain uses warp sync for faster synchronization.
310310

311-
**Important**: Do not proceed with registration until both chains are fully synced. Monitor sync progress using the log viewing commands in the [Log Management](#log-management) section.
311+
!!! warning
312+
313+
Do not proceed with registration until both chains are fully synced. Monitor sync progress using the log viewing commands in the [Log Management](#log-management) section.
312314

313315
## Generate Session Keys
314316

node-infrastructure/run-a-node/parachain-rpc.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,9 @@ curl -L https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/cumulus
4545

4646
For non-system parachains, check the parachain's documentation for official chain specification files.
4747

48-
**Note**: Throughout this guide, we use **People Chain** as the example. To set up a different parachain, substitute the chain spec file, snapshot path, and chain name with values for your target parachain.
48+
!!! note
49+
50+
Throughout this guide, we use **People Chain** as the example. To set up a different parachain, substitute the chain spec file, snapshot path, and chain name with values for your target parachain.
4951

5052
## Prerequisites
5153

@@ -71,7 +73,9 @@ RPC nodes serving production traffic require robust hardware:
7173
- 9615 (Prometheus metrics - optional)
7274
- Consider DDoS protection and rate limiting for production deployments
7375

74-
**Note**: For development or low-traffic scenarios, you can reduce these requirements proportionally. Consider using a reverse proxy (nginx, Caddy) for production deployments.
76+
!!! note
77+
78+
For development or low-traffic scenarios, you can reduce these requirements proportionally. Consider using a reverse proxy (nginx, Caddy) for production deployments.
7579

7680
### Software Requirements
7781

@@ -102,7 +106,9 @@ Using pre-synchronized snapshots significantly reduces initial sync time from se
102106

103107
**Snapshot Provider**: https://snapshots.polkadot.io/
104108

105-
**Note**: Snapshots are available for system parachains and the Polkadot relay chain. For other parachains, check with the parachain team for snapshot availability or sync from genesis.
109+
!!! note
110+
111+
Snapshots are available for system parachains and the Polkadot relay chain. For other parachains, check with the parachain team for snapshot availability or sync from genesis.
106112

107113
#### Create Directories
108114

@@ -139,7 +145,9 @@ rm files.txt
139145
- `--retries-sleep 10s`: Waits 10 seconds between retry attempts
140146
- `--size-only`: Only transfers if sizes differ (prevents unnecessary re-downloads)
141147

142-
**Note**: If a snapshot is not available, you can sync from scratch (which will take longer) or check https://snapshots.polkadot.io/ for alternative snapshot providers.
148+
!!! note
149+
150+
If a snapshot is not available, you can sync from scratch (which will take longer) or check https://snapshots.polkadot.io/ for alternative snapshot providers.
143151

144152
#### Download Polkadot Relay Chain Snapshot
145153

@@ -171,7 +179,9 @@ Launch the node using the official Parity Docker image.
171179

172180
**Docker Image**: https://hub.docker.com/r/parity/polkadot-parachain
173181

174-
**Note**: The `parity/polkadot-parachain` image works for system parachains and parachains built with standard Cumulus templates. For parachains with custom runtimes, check the parachain's documentation for their specific Docker image or binary.
182+
!!! note
183+
184+
The `parity/polkadot-parachain` image works for system parachains and parachains built with standard Cumulus templates. For parachains with custom runtimes, check the parachain's documentation for their specific Docker image or binary.
175185

176186
```bash
177187
docker run -d --name people-chain-rpc --restart unless-stopped \
@@ -334,7 +344,9 @@ docker start people-chain-rpc
334344
docker rm people-chain-rpc
335345
```
336346

337-
**Note**: For update procedures, see the [Updates and Upgrades](#updates-and-upgrades) section.
347+
!!! note
348+
349+
For update procedures, see the [Updates and Upgrades](#updates-and-upgrades) section.
338350

339351
---
340352

0 commit comments

Comments
 (0)