Updates and fixes #15
Open
+149
−39
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
bloxster
commented
May 1, 2025
•
bloxster
commented
- Updated tags for cloning latest Erigon version from Github or Docker
- Issue 13 solved (Minor nit-pick on performance document page #13)
- Fixed broken links
- updated Options page to version 3.0.2
- updated Disk Space Required page values
- removed Tips for faster syncing page from index
installation documentation
added 12 commits
February 25, 2025 09:23
There was a problem hiding this comment.
Pull Request Overview
This PR updates and fixes multiple sections of the Erigon documentation to align with the latest version and improve clarity. Key changes include:
- Updated installation instructions for Docker, Windows, and YAML/TOML configuration files.
- Revised CLI options, advanced configuration pages (Txpool, Sentry, Consensus Layer, etc.), and updated version references.
- Improved documentation navigation and branding changes to "Erigon 3 Docs".
Reviewed Changes
Copilot reviewed 28 out of 28 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/installation/docker.md | Updated Docker instructions with new prerequisites and commands. |
| src/installation/build_exec_win.md | Updated Windows build instructions to use the release/3.0 branch. |
| src/basic/yaml.md | Added configuration examples for YAML and TOML files. |
| src/basic/networks.md | Revised testnet network table and added new network information. |
| src/basic/disk-space.md | Updated disk space estimates for different network configurations. |
| src/advanced/txpool.md | Reorganized txpool documentation and commands for external usage. |
| src/advanced/sentry.md | Simplified Sentry instructions and updated default paths. |
| src/advanced/performance.md | Included flag details to improve performance via torrent options. |
| src/advanced/options.md | Updated CLI options and added a new persistence flag with revised defaults. |
| src/advanced/op-node.md | Minor title and formatting update. |
| src/advanced/consensus_layer.md | Updated link for Caplin documentation to reflect file changes. |
| src/advanced/bp-ext.md | Expanded external CL usage instructions and configuration examples. |
| src/advanced/bp-caplin.md | Refined instructions for using embedded Caplin and Lighthouse. |
| src/advanced/JSONRPC-daemon.md | Minor formatting changes for clearer documentation. |
| src/advanced.md | Updated link references for internal components. |
| src/about/disclaimer.md | Added disclaimer regarding security and usage risks. |
| src/_introduction.md | Replaced legacy art with an image and updated the introduction text. |
| src/SUMMARY.md | Adjusted navigation to include new sections. |
| book.toml | Updated title and added configuration options for section folding. |
| README.md | Updated title to reflect documentation rebranding. |
| @@ -154,6 +154,7 @@ GLOBAL OPTIONS: | |||
| --dev.period value Block period to use in developer mode (0 = mine only if transaction pending) (default: 0) | |||
| --vmdebug Record information useful for VM and contract debugging (default: false) | |||
| --networkid value Explicitly set network id (integer)(For testnets: use --chain <testnet_name> instead) (default: 1) | |||
| --experiment.persist.receipts value Set > 0 to store receipts in chaindata db (only on chain-tip) - RPC for recent receit/logs will be faster. Values: 1_000 good starting point. 10_000 receitps it's ~1Gb (not much IO increase). Please test before go over 100_000 (default: 0) | |||
There was a problem hiding this comment.
Correct the typographical errors: replace 'receit' with 'receipts' and 'receitps' with 'receipts' to ensure clarity.
Suggested change
| --experiment.persist.receipts value Set > 0 to store receipts in chaindata db (only on chain-tip) - RPC for recent receit/logs will be faster. Values: 1_000 good starting point. 10_000 receitps it's ~1Gb (not much IO increase). Please test before go over 100_000 (default: 0) | |
| --experiment.persist.receipts value Set > 0 to store receipts in chaindata db (only on chain-tip) - RPC for recent receipts/logs will be faster. Values: 1_000 good starting point. 10_000 receipts it's ~1Gb (not much IO increase). Please test before go over 100_000 (default: 0) |
Copilot uses AI. Check for mistakes.
Giulio2002
requested changes
May 3, 2025
src/installation/docker.md
Outdated
| * All build flags now passed to the release workflow — so, user can see previously missed build info in our released binaries (as well as in docker images) and also better build optimization expected; | ||
| * With recent updates, all build configurations are now included in the release process. This provides users with more comprehensive build information for both binaries and Docker images, along with enhanced build optimizations.. | ||
| * Images are stored at <https://hub.docker.com/r/erigontech/erigon> | ||
| - The released archive now comprises 10 key binaries: Erigon, Downloader, Devnet, EVM, Caplin, Diag, Integration, RPCDaemon, Sentry, and Txpool; |
There was a problem hiding this comment.
these should be lower case and as code
|
@bloxster can you merge |
|
Thank you for your comment, will merge later today and use separate PRs from now on. |
added 2 commits
May 5, 2025 20:45
yperbasis
requested changes
May 7, 2025
| @@ -3,15 +3,16 @@ | |||
|
|
|||
| # Mainnets | |||
|
|
|||
| Below is the size of the `--datadir` used by Erigon. | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.