Skip to content

Minor corrections and fixes #22

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

Merged
merged 4 commits into from
Jul 24, 2025
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
11 changes: 9 additions & 2 deletions src/about/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@ Visit also Erigon's **[Wiki](https://github.com/ledgerwatch/erigon/wiki)** to ga
- Transaction Pool Design
- Using Postman to test RPC.

# Contributing to Documentation
# Contributing to this Documentation

To contribute to the Erigon 3 book, commit your change to the development branch on **[Github](https://github.com/erigontech/docs/tree/development)**. You might want to run it locally to verify the output before committing, see how MdBook works [here](https://rust-lang.github.io/mdBook/index.html).
This documentation is powered by [MdBook](https://rust-lang.github.io/mdBook).

To contribute to the Erigon 3 Docs, you can either:

1) Create an Issue: Open a new issue in the main branch to suggest changes or report problems.
2) Open a Branch and Submit a PR: Create a new branch, make your changes, and submit a pull request (PR) on Github.

Before committing your changes, it's recommended to run the documentation locally to verify the output. This ensures that your changes render correctly and maintain the consistency of the documentation.
2 changes: 1 addition & 1 deletion src/getting-started/hw-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Archive nodes retain **all** historical state and require significantly more dis
| Network | Disk Size (Required) | Disk Size (Recommended) | RAM (Required) | RAM (Recommended) |
|-----------|----------------------|--------------------------|----------------|-------------------|
| Mainnet | 2 TB | 4 TB | 32 GB | 64 GB |
| Polygon | 6 TB | 6 TB | 64 GB | 128 GB |
| Polygon | 4.3 TB | 6 TB | 64 GB | 128 GB |
| Gnosis | 1 TB | 2 TB | 16 GB | 32 GB |


Expand Down
4 changes: 2 additions & 2 deletions src/getting-started/sw-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ Install **Build-essential** and **Cmake**:
sudo apt install build-essential cmake -y
```

### Go Programming Language (only for Linux and MacOS)
### Go Programming Language

Erigon utilizes Go (also known as Golang) version 1.23 or newer for part of its development. It is recommended to have a fresh Go installation. If you have an older version, consider deleting the /usr/local/go folder (you may need to use sudo) and re-extract the new version in its place.

To install the latest Go version, visit the official documentation at [https://golang.org/doc/install](https://golang.org/doc/install).

### C++ Compiler (only for Linux and MacOS)
### C++ Compiler

This turns the C++ part of Erigon's code into a program your computer can run. You can use either **Clang** or **GCC**:

Expand Down
2 changes: 1 addition & 1 deletion src/installation/build_exec_win.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Open the Command Prompt and type the following:
git clone --branch release/3.0 --single-branch https://github.com/erigontech/erigon.git
```

You might need to change the `ExecutionPolicy` to allow scripts created locally or signed by a trusted publisher to run:
You might need to change the `ExecutionPolicy` to allow scripts created locally or signed by a trusted publisher to run. Open a Powershell session as Administrator and type:

```powershell
Set-ExecutionPolicy RemoteSigned
Expand Down
1 change: 0 additions & 1 deletion src/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,6 @@ If you want to start Erigon add the options according to the [basic usage](/basi

```bash
docker run -it 36f25992dd1a --chain=holesky --prune.mode=minimal
docker run -it 36f25992dd1a --chain=holesky --prune.mode=minimal
```

To exit the container press `Ctrl+C`; the container will stop.
Expand Down
89 changes: 0 additions & 89 deletions src/installation/upgrading-md

This file was deleted.

4 changes: 2 additions & 2 deletions src/installation/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@

There are 3 options for running Erigon 3 on Windows, listed from easiest to most difficult installation:

- [Build executable binaries natively for Windows](/installation/build_exec_win.md): Use the pre-built Windows executables that can be natively run on Windows without any emulation or containers required.

- [Use Docker](/installation/docker.md): Run Erigon in a Docker container for isolation from the host Windows system. This avoids dependencies on Windows but requires installing Docker.

- [Build executable binaries natively for Windows](/installation/build_exec_win.md): Use the pre-built Windows executables that can be natively run on Windows without any emulation or containers required.

- [Use Windows Subsystem for Linux (WSL)](/installation/wsl.md): Install the Windows Subsystem for Linux (WSL) to create a Linux environment within Windows. Erigon can then be installed in WSL by following the Linux installation instructions. This provides compatibility with Linux builds but involves more setup overhead.
1 change: 0 additions & 1 deletion src/op-node.md

This file was deleted.