Skip to content

docs: March 2026 w11 documentation update#19859

Merged
bloxster merged 12 commits intomainfrom
docs/update-march-2026
Mar 18, 2026
Merged

docs: March 2026 w11 documentation update#19859
bloxster merged 12 commits intomainfrom
docs/update-march-2026

Conversation

@bloxster
Copy link
Copy Markdown
Collaborator

@bloxster bloxster commented Mar 12, 2026

Summary

  • Remove `(experimental)` label from `--prune.include-commitment-history` flag (feature is now stable, warning removed in mark commitment history feature as non-experimental #19774)
  • Add documentation for log directory default permissions (`0700` for dir, `0640` for files) introduced in logging: flexible log directory permissions with secure defaults #19761
  • Update MCP standalone section: `mcp` binary is now included in official GitHub Releases and Docker image (`/usr/local/bin/mcp`) since ci: add mcp binary to release workflow #19819
  • Add missing CLI flags to configuring-erigon#Options: `--builder.maxblobs`, `--ws.addr`, `--ws.api`, `--ws.origins`, `--rpc.gethcompat`, `--rpc.txsync.defaulttimeout`, `--rpc.txsync.maxtimeout`, `--ipcdisable`, `--ipcpath`, `--gpo.maxprice`
  • Regenerate `--help` output section from v3.3.9-8d7d33c2 binary: fixes `--db.read.concurrency` default (768→1408), normalizes home paths, aligns flag descriptions with actual binary output

Related PRs

🤖 Generated with Claude Code

@bloxster bloxster changed the title docs: March 2026 documentation updates docs: March 2026 w11 documentation update Mar 12, 2026
Erigon Docs Bot added 3 commits March 12, 2026 13:51
Replace the old verbose bash code block in the Options section with a
clean markdown table (Flag | Default | Description) containing all 160
global flags from erigon v3.3.7-9a898cf7. Includes updated descriptions
for --metrics.addr, --log.dir.disable, --log.dir.prefix and correct
alias notation for --prune.include-commitment-history.
@bloxster bloxster added the docs label Mar 12, 2026
@bloxster bloxster requested a review from Giulio2002 as a code owner March 12, 2026 18:05
@yperbasis yperbasis added this to the 3.5.0 milestone Mar 13, 2026
Copy link
Copy Markdown
Member

@yperbasis yperbasis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From Claude:

Issues in the --help output section

The raw --help reproduction (version 3.3.9-8d7d33c2) was generated from a different build than current main. Several discrepancies:

  1. Flags removed from docs but still exist in code:
  │                 Flag                  │        Code location         │
  ├───────────────────────────────────────┼──────────────────────────────┤
  │ --fcu.background.commit               │ cmd/utils/flags.go:1096      │
  ├───────────────────────────────────────┼──────────────────────────────┤
  │ --override.amsterdam                  │ cmd/utils/flags.go:125       │
  ├───────────────────────────────────────┼──────────────────────────────┤
  │ --mcp.disable, --mcp.addr, --mcp.port │ cmd/utils/flags.go:1101-1115 │
  └───────────────────────────────────────┴──────────────────────────────┘

These flags are live on main. Removing them from the docs will confuse users who see them in erigon --help.

  1. Flags added to docs but don't exist in code:

11 --silkworm.* flags were added. There is no silkworm flag code in the current codebase (only references in old dashboards/READMEs). These were likely from a different fork or an outdated build.

  1. Incorrect defaults:
  │         Flag          │ Docs say │           Code says            │                      Source                       │
  ├───────────────────────┼──────────┼────────────────────────────────┼───────────────────────────────────────────────────┤
  │ --discovery.v4        │ true     │ false                          │ node/nodecfg/defaults.go:55                       │
  ├───────────────────────┼──────────┼────────────────────────────────┼───────────────────────────────────────────────────┤
  │ --log.dir.verbosity   │ info     │ dbug                           │ node/logging/flags.go:69 (log.LvlDebug.String())  │
  ├───────────────────────┼──────────┼────────────────────────────────┼───────────────────────────────────────────────────┤
  │ --db.read.concurrency │ 768      │ machine-dependent (GOMAXPROCS) │ Was 1408 before, both are wrong for most machines │
  └───────────────────────┴──────────┴────────────────────────────────┴───────────────────────────────────────────────────┘
  1. Default paths: Changed from /home/user/ to /home/node/ — machine-dependent, reflects whoever ran --help.

Minor issue

Otterscan link: Changed from https://docs.otterscan.io/ to https://docs.otterscan.io/api-docs/ots-api. But the surrounding text says "For the installation and usage follow the official documentation at..." — a
general-purpose landing page fits that context better than a specific API reference page.

Recommendation

The curated flags section (top of the doc) and the new prose sections (logs permissions, MCP) are good. The --help output section should be regenerated from a current main build to avoid the flag/default
mismatches. Alternatively, if the --help section is too hard to keep in sync, consider removing it entirely and just pointing users to erigon --help.

Bloxster and others added 2 commits March 16, 2026 16:35
Fixes stale --help output: correct db.read.concurrency default (768→1408),
normalize home paths (/home/node → /home/user), align flag descriptions
with actual v3.3.9-8d7d33c2 binary output.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@bloxster bloxster enabled auto-merge (squash) March 17, 2026 08:17
@bloxster bloxster merged commit 22d2f7a into main Mar 18, 2026
34 checks passed
@bloxster bloxster deleted the docs/update-march-2026 branch March 18, 2026 11:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants