docs: prose audit — tradenames + code-fence types + Prune Modes rename [main]#21496
Merged
Conversation
…e [main] Forward-port of #21451 (against release/3.4) onto main. Bundles the full prose-audit + sync-modes-to-prune-modes rename into a single commit since the original branch is on a different base. Content changes (vs main): - §7.1 tradename casing in prose (Docker, Linux, Sentry, TxPool, Downloader, RPC Daemon, MacOS → macOS, …) - §7.4 terminology (execution client → execution layer client) - §7.3 code-fence types — untyped ``` → ```text (Prism crashes on auto-detect on some snippets) - Renamed docs/site/docs/fundamentals/sync-modes.md → prune-modes.md with title + H1 + ~16 internal link updates across docs/ and help-center/ Also pulled in (minor content drift that release/3.4 had but main did not, picked up during 3-way merge conflict resolution): - default-ports.md: eth/68 + eth/69 row split + --p2p.allowed-ports flag entry + reworded "Typically" prose - multiple-instances.md: 30303/30304 port range in the port table llms.txt + llms-full.txt (both static/ and root) regenerated. Build: `npm run build` passes with onBrokenLinks/onBrokenAnchors: 'throw'. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
AskAlexSharov
approved these changes
May 29, 2026
Sahil-4555
pushed a commit
to Sahil-4555/erigon
that referenced
this pull request
Jun 3, 2026
…ntech#21500) ## Summary `main` twin of erigontech#21494. Same two new pages: - **`/fundamentals/architecture`** — staged sync, modular processes, storage split, embedded Caplin, flat-KV state. Mermaid component diagram. - **`/fundamentals/database`** — datadir layout, MDBX engine, snapshots, per-transaction history granularity, mainnet sizing, tuning flags, safe-to-delete table. ## Stacked on erigontech#21496 Base is `docs/prose-audit-main-2026-05-28` so links can target the renamed Prune Modes page. GitHub auto-retargets to `main` once erigontech#21496 merges. ## Verification - `npm run build` passes with `onBrokenLinks`/`onBrokenAnchors: 'throw'` - `docs-site / build` (incl. llms verification) ✓ pass - llms.txt and llms-full.txt regenerated ## Notes - Sourced from the Improving-public-docs spec and the `README.md` "Datadir structure" / "Erigon3 datadir size" / "Modularity" sections. - Adds `@docusaurus/theme-mermaid@^3.10.0` (used by the architecture diagram). --------- Co-authored-by: Bloxster <gianni.morselli@erigon.tech> Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com>
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
Forward-port of erigontech/erigon#21451 (against
release/3.4) ontomain. Same content fixes plus the Sync Modes → Prune Modes rename, applied to main's docs/ tree.Squashed into a single commit because the original branch's commit-by-commit history wouldn't cherry-pick cleanly (10 commits on a different base).
Changes
execution client→execution layer client```→```text(Prism crashes on auto-detect on some snippets)docs/site/docs/fundamentals/sync-modes.md→prune-modes.md(title + H1 + ~16 internal link updates acrossdocs/andhelp-center/)static/and root copies)Forward-port nits
Main was slightly behind
release/3.4on two files; the 3-way merge picked up the newer release/3.4 content in addition to the prose-audit changes:default-ports.md: eth/68 + eth/69 row split,--p2p.allowed-portsflag entry, reworded "Typically" prosemultiple-instances.md:30303/30304port range in the port tableThese are minor content updates that should already be in main, not new content invented by this PR.
Verification
npm run buildpasses withonBrokenLinks/onBrokenAnchors: 'throw'Merge order
This is the main-targeted twin of #21451. Either can merge first; they touch disjoint branches.
🤖 Generated with Claude Code