docs(fundamentals): add Architecture and Database pages#21494
Merged
bloxster merged 3 commits intoMay 29, 2026
Conversation
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>
No-op whitespace change. CI's `ci-gate.yml > changes` job consistently classified this PR as `docs_site=false` across 3 attempts on the same headSha, despite the PR's 45-file diff being entirely under `docs/site/`. A fresh commit invalidates the cached path-filter view and lets `docs-site / build` actually run and verify llms.txt is up to date. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
bloxster
requested review from
AskAlexSharov,
Giulio2002 and
yperbasis
as code owners
…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>
Contributor
There was a problem hiding this comment.
Pull request overview
Adds two new Fundamentals documentation pages (Architecture and Database), wires up Docusaurus Mermaid support for the architecture diagram, and regenerates the llms.txt / llms-full.txt indexes accordingly.
Changes:
- New
fundamentals/architecture.mdwith a Mermaid component diagram and sections on staged sync, modular processes, storage model, embedded Caplin, flat KV state, and pruning. - New
fundamentals/database.mdcovering datadir layout, MDBX properties, snapshot files, mainnet sizing, tuning flags, and safe-to-delete subdirectories. - Enables
@docusaurus/theme-mermaidindocusaurus.config.tsand adds the dependency (with corresponding lockfile updates).
Reviewed changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/site/docs/fundamentals/architecture.md | New Architecture page with Mermaid diagram |
| docs/site/docs/fundamentals/database.md | New Database page (datadir, MDBX, snapshots, tuning) |
| docs/site/docusaurus.config.ts | Enable Mermaid markdown + theme |
| docs/site/package.json | Add @docusaurus/theme-mermaid dep |
| docs/site/package-lock.json | Lockfile updates for theme-mermaid + mermaid transitive deps |
| docs/site/static/llms.txt, llms.txt | Add Architecture and Database entries to LLM index |
| docs/site/static/llms-full.txt, llms-full.txt | Inline full text of the two new pages |
Files not reviewed (1)
- docs/site/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Member
|
@bloxster This PR was merged not into |
bloxster
pushed a commit
that referenced
this pull request
May 29, 2026
…)" This reverts commit f0b409c.
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
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
Two new pages in Fundamentals:
/fundamentals/architecture— staged sync, modular processes, storage split, embedded Caplin, flat-KV state. Mermaid component diagram at the top./fundamentals/database— datadir layout, MDBX engine properties, immutable.segsnapshots, per-transaction history granularity, mainnet sizing, tuning flags, safe-to-delete table.Stacked on #21451
Rebased on top of
docs/prose-audit-2026-05-27so links can target the renamed Prune Modes page. GitHub auto-retargets the base torelease/3.4once #21451 merges.Verification
npm run buildpasses withonBrokenLinks/onBrokenAnchors: 'throw'docs-site / build(incl. llms verification) ✓ passNotes
README.md"Datadir structure" / "Erigon3 datadir size" / "Modularity" sections. Once this lands, those README sections become safe to delete per the spec.@docusaurus/theme-mermaid@^3.10.0(used by the architecture diagram).