docs(fundamentals): add Architecture and Database pages [main]#21500
Open
bloxster wants to merge 2 commits into
Open
docs(fundamentals): add Architecture and Database pages [main]#21500bloxster wants to merge 2 commits into
bloxster wants to merge 2 commits into
Conversation
AskAlexSharov
approved these changes
May 29, 2026
Closes two of the largest content gaps identified in the [Improving-public-docs](https://github.com/erigontech/erigon-documents/blob/master/public-docs/Improving-public-docs.md) spec: the high-level Architecture overview and the deep-dive Database / datadir page. New pages: - `/fundamentals/architecture` (sidebar_position 3) - At-a-glance ASCII component diagram - Staged Sync pipeline + Erigon 3 consolidation notes - Modular processes (Sentry/Downloader/Execution/RPC Daemon/TxPool/Caplin) - Storage model split (chaindata vs snapshots) - Embedded Caplin consensus layer - Flat KV state model + RPC-latency rationale - Prune-modes vs sync-modes clarification - `/fundamentals/database` (sidebar_position 15) - Datadir directory tree with role per folder - MDBX engine properties (no compaction, mmap reads, single-writer) - Immutable .seg snapshots + BitTorrent distribution - Per-transaction history granularity - Real Nov-2024 mainnet + bor-mainnet sizing numbers - Why chaindata/ stays small (and is recoverable from snapshots) - Tuning flags (--batchSize, --db.size.limit, --db.read.concurrency) - Safe-to-delete subdirectories table Cross-links: both pages link to each other plus existing pages (Modules, Caplin, Optimizing Storage, Hardware Requirements, Sync Modes). No content duplication with Optimizing Storage — that page covers multi-disk tiering recipes, these pages cover concepts. Sources: erigontech/erigon README "Datadir structure", "Erigon3 datadir size", "Erigon3 changes from Erigon2", "Modularity", "More Efficient State Storage" sections. llms.txt and llms-full.txt (both static/ and root copies) regenerated. Build: `pnpm run build` passes with onBrokenLinks/onBrokenAnchors: 'throw'. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
…nnet sizing - Architecture page: ASCII component diagram → Mermaid flowchart - Database page: remove Polygon (bor-mainnet) disk-size block; we no longer maintain that chain - Add @docusaurus/theme-mermaid@^3.10.0 and enable mermaid in config - Regenerate llms-full.txt Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
bloxster
force-pushed
the
docs/architecture-database-main-2026-05-28
branch
from
38658a6 to
c6c18da
Compare
2 tasks
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
maintwin of #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 #21496
Base is
docs/prose-audit-main-2026-05-28so links can target the renamed Prune Modes page. GitHub auto-retargets tomainonce #21496 merges.Verification
npm run buildpasses withonBrokenLinks/onBrokenAnchors: 'throw'docs-site / build(incl. llms verification) ✓ passNotes
README.md"Datadir structure" / "Erigon3 datadir size" / "Modularity" sections.@docusaurus/theme-mermaid@^3.10.0(used by the architecture diagram).