docs: port Help Center updates and new namespace pages to main#20267
Merged
Conversation
- FAQs: add items 21 (pruned history / no earlier blocks) and 22 (RPi / ARM) - Best practices: add Public RPC hardening row to Security table; add new section 6 "Advanced Performance Tricks" with shell commands for sync.loop.block.limit, vmtouch, SNAPSHOT_MADV_RND, db.pagesize - Common errors: add items 8 (Docker UID/GID 1000 permission denied) and 9 (libsilkworm_capi.so missing shared library) - Troubleshooting: add "Collecting Diagnostics" section (SIGUSR1 + pprof) and Hetzner firewall note for P2P ports - Known issues: add db.pagesize section explaining the flag is set-once with link to integration README Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Drop deprecated DOCKER_BUILDKIT=1 and COMPOSE_DOCKER_CLI_BUILD=1 env vars from the docker-compose BuildKit workaround (BuildKit is default in Docker Engine 23.0+ and Compose V2) - Label vmmap as macOS-only; add Linux equivalents (pmap -x PID and /proc/<PID>/smaps) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Add three new RPC namespace pages missing from the interacting-with-erigon section on main: - overlay.md: Erigon-specific overlay API (archive nodes, state overrides) - parity.md: Partial OpenEthereum compat (parity_listStorageKeys only) - graphql.md: GraphQL endpoint per EIP-1767 Update SUMMARY.md and interacting-with-erigon/README.md to list the new pages. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
yperbasis
requested changes
Apr 2, 2026
yperbasis
left a comment
Member
There was a problem hiding this comment.
Issues
- Broken link in known-issues.md (should fix)
The new --db.pagesize section links to:
▎ https://github.com/erigontech/erigon/blob/main/erigon-lib/kv/mdbx/README.md
Two problems:
- erigon-lib/ was restructured to db/ on main
- There is no README.md in db/kv/mdbx/ either
This link will 404. It should either be removed, point to an existing resource, or a README should be created first.
Nits (non-blocking)
- best-practices.md — pprof default port not mentioned
The troubleshooting section documents curl http://localhost:6060/debug/pprof/... and notes it "requires --pprof flag at startup", but doesn't mention the --pprof.addr / --pprof.port flags for changing the
address. Minor, but could save a user a search.
-
Known-issues vmmap / pmap edit is a good improvement — correctly labels vmmap as macOS-only and adds pmap -x for Linux. The removal of the standalone cat /proc//smaps line in favor of inlining it as a
pmap detail is clean. -
BuildKit env var removal is correct — DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1 are no longer needed since BuildKit became the Docker default.
Verdict
Good PR overall. Content is well-structured, technically accurate, and fills genuine documentation gaps. The new namespace pages (overlay, parity, graphql) match the existing page format and are thorough.
The broken README link (#1) should be fixed before merge. Everything else looks good to go.
The erigon-lib/ directory was restructured to db/ and the referenced README.md no longer exists. Remove the dead link.
Mention default pprof address and flags to override it, per review feedback from yperbasis on PR #20267.
bloxster
added a commit
that referenced
this pull request
Apr 2, 2026
Mention default pprof address and flags to override it, per review feedback from yperbasis on PR #20267.
yperbasis
approved these changes
Apr 2, 2026
Merge main's base + PR improvements: - vmmap: add macOS-only note; add pmap -x for Linux - remove DOCKER_BUILDKIT env vars (no longer needed) - fix trailing whitespace - add --db.pagesize section (default 16KB per node/ethconfig/config.go:121)
Merge main's 18-step guide + PR additions: - diagnostics section (SIGUSR1 goroutine dump) - pprof section with --pprof.addr / --pprof.port flags - Hetzner firewall note
Apply PR additions to current main: - Add 'Harden Public RPC Endpoints' row to Security table - Add Section 6: Advanced Performance Tricks
Use main's updated version: soften archive node requirement to 'historical state to be available' per yperbasis review feedback
bloxster
added a commit
that referenced
this pull request
Apr 3, 2026
…tes) Bring v3.3 branch in line with the full Help Center content merged via PR #20267.
bloxster
added a commit
that referenced
this pull request
Apr 3, 2026
…updates) Bring v3.3 branch in line with the full Help Center content merged via PR #20267.
bloxster
added a commit
that referenced
this pull request
Apr 3, 2026
Bring v3.3 branch in line with the full Help Center content merged via PR #20267.
bloxster
added a commit
that referenced
this pull request
Apr 3, 2026
Port Help Center updates from main (merged via PR #20267) to release/3.4.
bloxster
added a commit
that referenced
this pull request
Apr 3, 2026
… content Port Help Center updates from main (merged via PR #20267) to release/3.4.
bloxster
added a commit
that referenced
this pull request
Apr 3, 2026
…nter content Port Help Center updates from main (merged via PR #20267) to release/3.4.
bloxster
added a commit
that referenced
this pull request
Apr 3, 2026
Port Help Center updates from main (merged via PR #20267) to release/3.4.
bloxster
added a commit
that referenced
this pull request
Apr 3, 2026
Port Help Center updates from main (merged via PR #20267) to release/3.4.
3 tasks
AskAlexSharov
pushed a commit
that referenced
this pull request
Apr 3, 2026
## Summary Ports the full Help Center content to `release/3.4`, mirroring what was merged to `main` via PR #20267. Changes per file: - **best-practices.md**: added "Harden Public RPC Endpoints" row + Section 6 (Advanced Performance Tricks with vmtouch, ERIGON_SNAPSHOT_MADV_RND, db.pagesize) - **common-errors-and-solutions.md**: added errors #8 (Docker UID/GID mismatch) and #9 (libsilkworm_capi.so missing) - **frequently-asked-questions-faqs.md**: added FAQ #21 (historical block queries / pruning) and #22 (ARM/RPi feasibility) - **known-issues.md**: improved vmmap/pmap section (macOS vs Linux), removed DOCKER_BUILDKIT env vars, added `--db.pagesize` section (default 16KB) - **troubleshooting.md**: added Diagnostics section (SIGUSR1 goroutine dump, pprof CPU/heap capture) and Hetzner firewall note All content is identical to `main` post-#20267, with yperbasis review fixes already applied (broken erigon-lib link removed, pprof addr/port flags documented). ## Test plan - [ ] Verify all 5 files render correctly in GitBook preview - [ ] No broken internal links - [ ] Content consistent with release/3.3 (PR #20263) and main 🤖 Generated with [Claude Code](https://claude.com/claude-code)
sudeepdino008
pushed a commit
that referenced
this pull request
Apr 3, 2026
## Summary Ports the full Help Center content to `release/3.4`, mirroring what was merged to `main` via PR #20267. Changes per file: - **best-practices.md**: added "Harden Public RPC Endpoints" row + Section 6 (Advanced Performance Tricks with vmtouch, ERIGON_SNAPSHOT_MADV_RND, db.pagesize) - **common-errors-and-solutions.md**: added errors #8 (Docker UID/GID mismatch) and #9 (libsilkworm_capi.so missing) - **frequently-asked-questions-faqs.md**: added FAQ #21 (historical block queries / pruning) and #22 (ARM/RPi feasibility) - **known-issues.md**: improved vmmap/pmap section (macOS vs Linux), removed DOCKER_BUILDKIT env vars, added `--db.pagesize` section (default 16KB) - **troubleshooting.md**: added Diagnostics section (SIGUSR1 goroutine dump, pprof CPU/heap capture) and Hetzner firewall note All content is identical to `main` post-#20267, with yperbasis review fixes already applied (broken erigon-lib link removed, pprof addr/port flags documented). ## Test plan - [ ] Verify all 5 files render correctly in GitBook preview - [ ] No broken internal links - [ ] Content consistent with release/3.3 (PR #20263) and main 🤖 Generated with [Claude Code](https://claude.com/claude-code)
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Ports documentation-only changes from
gitbook_docs_v3.3tomain. Only touchesdocs/files.Note:
mainhas a restructured docs tree (different paths fromrelease/3.3), so only the changes that map cleanly are included here:docs(gitbook-help): fill gaps from README FAQ and community Q&A (FAQs 21-22, best practices, common errors, troubleshooting, known issues)docs(gitbook-help): fix stale known-issues entries (BuildKit env vars removed, vmmap labeled macOS-only)docs: add overlay, parity, graphql namespace pages tointeracting-with-erigon/Not included: changes to configuring-erigon, security, default-ports, logs, caplin, etc. —
mainalready has diverged content for those files and they need a separate review.🤖 Generated with Claude Code