Skip to content

Commit 28e9f53

Browse files
bloxsterBloxsterclaudeyperbasis
authored
docs: replace 'prune modes' with 'pruning modes' (grammatical fix) (#21689)
Grammatical fix: "pruning modes" is more correct than "prune modes". Applied across all existing documentation files. New documentation pages already use the correct term. Also renames `prune-modes.md` → `pruning-modes.md` and updates all internal links to match. --------- Co-authored-by: Bloxster <gianni.morselli@erigon.tech> Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Co-authored-by: yperbasis <andrey.ashikhmin@gmail.com>
1 parent 6dfe811 commit 28e9f53

21 files changed

Lines changed: 137 additions & 137 deletions

File tree

docs/site/docs/fundamentals/architecture.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,11 +125,11 @@ Erigon 3 has one sync pipeline. The user-facing choice is *what to retain after
125125
| `blocks` | All blocks, but no state history | Full block/receipt history without archive-size state |
126126
| `minimal` | Latest state only (shortest block window) | Solo stakers, constrained hardware |
127127

128-
See [Prune Modes](prune-modes) for the full comparison.
128+
See [Pruning Modes](pruning-modes) for the full comparison.
129129

130130
## Where to go next
131131

132132
- [Database](database) — datadir layout, MDBX internals, mainnet sizing
133133
- [Modules](modules) — running RPC Daemon, TxPool, Sentry, Downloader as separate processes
134-
- [Prune Modes](prune-modes) — choosing what history to keep
134+
- [Pruning Modes](pruning-modes) — choosing what history to keep
135135
- [Optimizing Storage](optimizing-storage) — splitting datadir across fast and slow disks

docs/site/docs/fundamentals/basic-usage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ To run Erigon with RPC Daemon, TxPool, and other components in a single process
9292
```
9393
* The `--chain=mainnet` flag is set by default for Erigon to sync with the Ethereum mainnet. To explore other network options, check the [Supported Networks](supported-networks) section. For quick testing, consider selecting a testnet.
9494
* `--log.dir.path` dictates where [logs](logs) will be output - useful for sending reports to the Erigon team when issues occur.
95-
* Based on the [prune mode](prune-modes) you want to run you can add `--prune.mode=archive` to run an archive node, `--prune.mode=full` for a full node (default value) or `--prune.mode=minimal` for a minimal node.
95+
* Based on the [pruning mode](pruning-modes) you want to run you can add `--prune.mode=archive` to run an archive node, `--prune.mode=full` for a full node (default value) or `--prune.mode=minimal` for a minimal node.
9696
* `--http.addr=0.0.0.0 --http.api=eth,web3,net,debug,trace,txpool` to use [RPC Service](../interacting-with-erigon/) and e.g. be able to connect your [wallet](web3-wallet).
9797
* `--torrent.download.rate` sets the torrent download rate cap. The default is `512mb` (megabytes per second). During initial sync Erigon will use the full allowance — on a dedicated machine this is fine, but if you share the machine with other work you may want to lower it (e.g. `--torrent.download.rate=128mb`). Set `--torrent.download.rate=Inf` to remove the limit entirely.
9898

docs/site/docs/fundamentals/configuring-erigon/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ These flags control database performance and memory usage.
9292

9393
Flags for managing how old chain data is handled and stored.
9494

95-
* `--prune.mode value`: Selects a pruning preset (`full`, `archive`, `minimal`, `blocks`). See also [Prune Modes](/fundamentals/prune-modes)
95+
* `--prune.mode value`: Selects a pruning preset (`full`, `archive`, `minimal`, `blocks`). See also [Pruning Modes](/fundamentals/pruning-modes)
9696
* Default: `"full"`
9797
* `--prune.distance value`: Keeps state history for the latest `N` blocks.
9898
* Default: `0`

docs/site/docs/fundamentals/database.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ snapshots TOTAL 2.3 TB
7777

7878
The breakdown above lists the state/history snapshot subdirectories. The remaining ~1.2 TB is mostly block/transaction `.seg` data, which is not broken out separately here.
7979

80-
For up-to-date totals across all networks and prune modes, see [Hardware Requirements](../get-started/hardware-requirements).
80+
For up-to-date totals across all networks and pruning modes, see [Hardware Requirements](../get-started/hardware-requirements).
8181

8282
## Why `chaindata/` stays so small
8383

@@ -115,4 +115,4 @@ If you need to reclaim space without resyncing from scratch:
115115
- [Architecture](architecture) — how this storage model fits into staged sync and the flat-KV state design
116116
- [Optimizing Storage](optimizing-storage) — concrete recipes for splitting the datadir across multiple disks
117117
- [Hardware Requirements](../get-started/hardware-requirements) — disk-size numbers for each `--prune.mode`
118-
- [Prune Modes](prune-modes) — choosing what history to keep
118+
- [Pruning Modes](pruning-modes) — choosing what history to keep

docs/site/docs/fundamentals/index.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Fundamentals
33
sidebar_position: 3
44
hide_title: true
5-
description: "Core concepts for running Erigon — modules, CLI flags, prune modes, database internals, and node configuration."
5+
description: "Core concepts for running Erigon — modules, CLI flags, pruning modes, database internals, and node configuration."
66
---
77

88
import Link from '@docusaurus/Link';
@@ -23,13 +23,13 @@ import Link from '@docusaurus/Link';
2323
<div className="lp-card-desc">Command-line flags, common arguments, and first steps running the Erigon binary.</div>
2424
</Link>
2525

26-
<Link className="lp-card" to="/fundamentals/prune-modes">
26+
<Link className="lp-card" to="/fundamentals/pruning-modes">
2727
<svg className="lp-icon" viewBox="0 0 24 24" fill="none" stroke="currentColor" strokeWidth="2" strokeLinecap="round" strokeLinejoin="round">
2828
<polyline points="23 4 23 10 17 10"/>
2929
<polyline points="1 20 1 14 7 14"/>
3030
<path d="M3.51 9a9 9 0 0 1 14.85-3.36L23 10M1 14l4.64 4.36A9 9 0 0 0 20.49 15"/>
3131
</svg>
32-
<div className="lp-card-title">Prune Modes</div>
32+
<div className="lp-card-title">Pruning Modes</div>
3333
<div className="lp-card-desc">Full, minimal, and archive sync explained — choose the right mode for your use case.</div>
3434
</Link>
3535

docs/site/docs/fundamentals/prune-modes.md renamed to docs/site/docs/fundamentals/pruning-modes.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: "Prune Modes"
3-
description: "Full, minimal, blocks, and archive prune modes explained — choose the right mode for your use case."
2+
title: "Pruning Modes"
3+
description: "Full, minimal, blocks, and archive pruning modes explained — choose the right mode for your use case."
44
sidebar_position: 2
55
---
66

77

8-
# Prune Modes
8+
# Pruning Modes
99

10-
Erigon 3 supports four prune modes that control how much chain history your node retains. Choose based on your use case — most users should run a Full Node.
10+
Erigon 3 supports four pruning modes that control how much chain history your node retains. Choose based on your use case — most users should run a Full Node.
1111

12-
| **Prune Mode** | **Flag** | **Data Retained** | **Primary Use Case** |
12+
| **Pruning Mode** | **Flag** | **Data Retained** | **Primary Use Case** |
1313
| --------------------------------------------------------------------- | ---------------------- | --------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
1414
| <p>* <a href="#full-node">Full Node</a><br />(Default)</p> | `--prune.mode=full` | State and block data within the EIP-8252 window (last 262,144 blocks, ~36 days) | General users, DApp interaction, fastest sync. |
1515
| \* [Minimal Node](#minimal-node) | `--prune.mode=minimal` | State and block data within the last 100,000 blocks (~14 days) | Solo staking, users with constrained hardware, maximum privacy for sending transactions. |

docs/site/docs/get-started/easy-nodes/how-to-run-a-gnosis-chain-node/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 2
99

1010
## 1. Prerequisites Check
1111

12-
1. Confirm your machine meets the necessary [Hardware Requirements](/get-started/hardware-requirements) based on your desired prune mode.
12+
1. Confirm your machine meets the necessary [Hardware Requirements](/get-started/hardware-requirements) based on your desired pruning mode.
1313
2. **Install Docker**:
1414
* For Linux, install [Docker Engine](https://docs.docker.com/engine/install).
1515
* For macOS or Windows, install [Docker Desktop](https://docs.docker.com/desktop/).
@@ -35,8 +35,8 @@ services:
3535
- --http.api=eth,web3,net,debug,trace,txpool
3636
# --- Performance Tweaks ---
3737
- --torrent.download.rate=512mb
38-
# --- Prune Mode (Optional) ---
39-
# To change Prune Mode, uncomment the line below:
38+
# --- Pruning Mode (Optional) ---
39+
# To change Pruning Mode, uncomment the line below:
4040
# - --prune.mode=archive
4141
# or
4242
# - --prune.mode=minimal
@@ -64,7 +64,7 @@ docker compose up
6464
## Flag explanation
6565

6666
* `--chain=gnosis` specifies to run on Gnosis Chain, use `--chain=chiado` for Chiado testnet
67-
* Add `--prune.mode=minimal` to run minimal [Prune Mode](/fundamentals/prune-modes) or `--prune.mode=archive` to run an archive node
67+
* Add `--prune.mode=minimal` to run minimal [Pruning Mode](/fundamentals/pruning-modes) or `--prune.mode=archive` to run an archive node
6868
* `--http.addr="0.0.0.0" --http.api=eth,web3,net,debug,trace,txpool` to use RPC and e.g. be able to connect your [web3 wallet](/fundamentals/web3-wallet)
6969
* `--torrent.download.rate=512mb` to increase download speed. While the default downloading speed is 128mb, with this flag Erigon will use as much download speed as it can, up to a maximum of 512 megabytes per second. This means it will try to download data as quickly as possible, but it won't exceed the 512 MB/s limit you've set
7070

docs/site/docs/get-started/easy-nodes/how-to-run-a-polygon-node.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ sidebar_position: 3
1313

1414
## 1. Prerequisites Check
1515

16-
1. Confirm your machine meets the necessary [Hardware Requirements](../hardware-requirements) based on your desired prune mode.
16+
1. Confirm your machine meets the necessary [Hardware Requirements](../hardware-requirements) based on your desired pruning mode.
1717
2. **Install Docker**:
1818
* For Linux, install [Docker Engine](https://docs.docker.com/engine/install).
1919
* For macOS or Windows, install [Docker Desktop](https://docs.docker.com/desktop/).
@@ -40,8 +40,8 @@ services:
4040
- --http.api=eth,web3,net,debug,trace,txpool
4141
# --- Performance Tweaks ---
4242
- --torrent.download.rate=512mb
43-
# --- Prune Mode (Optional) ---
44-
# To change Prune Mode, uncomment the line below:
43+
# --- Pruning Mode (Optional) ---
44+
# To change Pruning Mode, uncomment the line below:
4545
# - --prune.mode=archive
4646
# or
4747
# - --prune.mode=minimal
@@ -72,7 +72,7 @@ Now you can relax and watch your Erigon Polygon node sync!
7272

7373
* `--chain=bor-mainnet` and `--bor.heimdall=https://heimdall-api.polygon.technologyspecifies` specify respectively the Polygon mainnet and the API endpoint for the Heimdall network
7474
* to use Amoy tesnet replace with flags `--chain=amoy --bor.heimdall=https://heimdall-api-amoy.polygon.technology`
75-
* Add `--prune.mode=minimal` to run minimal [Prune Mode](../../fundamentals/prune-modes) or `--prune.mode=archive` to run an archive node
75+
* Add `--prune.mode=minimal` to run minimal [Pruning Mode](../../fundamentals/pruning-modes) or `--prune.mode=archive` to run an archive node
7676
* `--http.addr="0.0.0.0" --http.api=eth,web3,net,debug,trace,txpool` to use RPC and e.g. be able to connect your [web3 wallet](../../fundamentals/web3-wallet);
7777
* `--torrent.download.rate=512mb` to increase download speed. While the default downloading speed is 128mb, with this flag Erigon will use as much download speed as it can, up to a maximum of 512 megabytes per second. This means it will try to download data as quickly as possible, but it won't exceed the 512 MB/s limit you've set.
7878

docs/site/docs/get-started/easy-nodes/how-to-run-an-ethereum-node/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ sidebar_position: 1
99

1010
## 1. Prerequisites Check
1111

12-
1. Confirm your machine meets the necessary [Hardware Requirements](/get-started/hardware-requirements) based on your desired prune mode.
12+
1. Confirm your machine meets the necessary [Hardware Requirements](/get-started/hardware-requirements) based on your desired pruning mode.
1313
2. **Install Docker**:
1414
* For Linux, install [Docker Engine](https://docs.docker.com/engine/install).
1515
* For macOS or Windows, install [Docker Desktop](https://docs.docker.com/desktop/).
@@ -35,8 +35,8 @@ services:
3535
- --http.api=eth,web3,net,debug,trace,txpool
3636
# --- Performance Tweaks ---
3737
- --torrent.download.rate=512mb
38-
# --- Prune Mode (Optional) ---
39-
# To change Prune Mode, uncomment the line below:
38+
# --- Pruning Mode (Optional) ---
39+
# To change Pruning Mode, uncomment the line below:
4040
# - --prune.mode=archive
4141
# or
4242
# - --prune.mode=minimal
@@ -64,7 +64,7 @@ docker compose up
6464
## Flag explanation
6565

6666
* `--chain=mainnet` specifies to run on Ethereum mainnet
67-
* Add `--prune.mode=minimal` to run minimal [Prune Mode](/fundamentals/prune-modes) or `--prune.mode=archive` to run an archive node
67+
* Add `--prune.mode=minimal` to run minimal [Pruning Mode](/fundamentals/pruning-modes) or `--prune.mode=archive` to run an archive node
6868
* `--http.addr=0.0.0.0 --http.api=eth,web3,net,debug,trace,txpool` to use RPC and e.g. be able to connect your [web3 wallet](/fundamentals/web3-wallet)
6969
* `--torrent.download.rate` sets the torrent download rate cap. The default is `512mb` (megabytes per second). During initial sync Erigon will use the full allowance — on a dedicated machine this is fine, but if you share the machine with other work you may want to lower it (e.g. `--torrent.download.rate=128mb`). Set `--torrent.download.rate=Inf` to remove the limit entirely.
7070

docs/site/docs/get-started/hardware-requirements.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@ A locally mounted **SSD** (Solid-State Drive) or **NVMe** (Non-Volatile Memory E
2525

2626
## Disk Size and RAM Requirements
2727

28-
The amount of disk space recommended and RAM you need depends on the [prune mode](../fundamentals/prune-modes) you want to run. **Current Disk Usage** values listed below are obtained using the standard Erigon + [Caplin](../fundamentals/caplin) configuration, with the sole exception of the `--prune.mode` flag.
28+
The amount of disk space recommended and RAM you need depends on the [pruning mode](../fundamentals/pruning-modes) you want to run. **Current Disk Usage** values listed below are obtained using the standard Erigon + [Caplin](../fundamentals/caplin) configuration, with the sole exception of the `--prune.mode` flag.
2929

3030
<Tabs>
3131
<TabItem value="ethereum-mainnet" label="Ethereum mainnet">
32-
| Prune Mode | Current Disk Usage | Disk Size (Recommended) | RAM (Required) | RAM (Recommended) |
32+
| Pruning Mode | Current Disk Usage | Disk Size (Recommended) | RAM (Required) | RAM (Recommended) |
3333
| --- | --- | --- | --- | --- |
3434
| Archive | {diskSizes?.networks?.['mainnet']?.['archive']?.display ?? ''} | 4 TB | 32 GB | 64 GB |
3535
| Full (Default) | {diskSizes?.networks?.['mainnet']?.['full']?.display ?? ''} | 2 TB | 16 GB | 32 GB |
3636
| Minimal | {diskSizes?.networks?.['mainnet']?.['minimal']?.display ?? ''} | 1 TB | 16 GB | 64 GB |
3737

3838
</TabItem>
3939
<TabItem value="gnosis-chain" label="Gnosis Chain">
40-
| **Prune Mode** | **Current Disk Usage** | **Disk Size (Recommended)** | **RAM (Required)** | **RAM (Recommended)** |
40+
| **Pruning Mode** | **Current Disk Usage** | **Disk Size (Recommended)** | **RAM (Required)** | **RAM (Recommended)** |
4141
| -------------- | ---------------------- | --------------------------- | ------------------ | --------------------- |
4242
| Archive | {diskSizes?.networks?.['gnosis']?.['archive']?.display ?? ''} | 1 TB | 16 GB | 32 GB |
4343
| Full (Default) | {diskSizes?.networks?.['gnosis']?.['full']?.display ?? ''} | 1 TB | 8 GB | 16 GB |
@@ -48,7 +48,7 @@ The amount of disk space recommended and RAM you need depends on the [prune mode
4848
The final release series of Erigon that officially supports Polygon is 3.1.\*. For the software supported by Polygon, please refer to the link: [https://github.com/0xPolygon/erigon/releases](https://github.com/0xPolygon/erigon/releases). Disk usage figures below are from September 2025 and are no longer automatically updated.
4949
:::
5050

51-
| **Prune Mode** | **Current Disk Usage** | **Disk Size (Recommended)** | **RAM (Required)** | **RAM (Recommended)** |
51+
| **Pruning Mode** | **Current Disk Usage** | **Disk Size (Recommended)** | **RAM (Required)** | **RAM (Recommended)** |
5252
| -------------- | ---------------------- | --------------------------- | ------------------ | --------------------- |
5353
| Archive | 4.85 TB | 8 TB | 64 GB | 128 GB |
5454
| Full (Default) | 3.3 TB | 4 TB | 32 GB | 64 GB |

0 commit comments

Comments
 (0)