docs: expand the architecture doc - #581
Conversation
The page described the two actors in four paragraphs and was never listed in SUMMARY.md, so mdbook did not render it at all. Add a component diagram, the actor protocol table, and sections covering the tick loop, block import, off-loop aggregation, the sync gate, pending-parent backfill, chain events, the P2P swarm split, the Store and the startup sequence. Every claim was checked against the code it describes. Link the page from SUMMARY.md under a new Design part, and mention it in the introduction.
The introduction enumerated the book's parts but stopped at Operations, so Spec Deviations was reachable from the sidebar and invisible from the intro.
There was a problem hiding this comment.
Your trial has ended. Reactivate Greptile to resume code reviews.
🤖 Kimi Code ReviewThis PR contains only documentation changes (no Rust code), so traditional code correctness and security vulnerability checks do not apply. Below is a review of the architectural documentation for clarity, consistency, and potential concerns. Overall Quality Specific Items
Minor
Summary Automated review by Kimi (Moonshot AI) · kimi-k2.5 · custom prompt |
🤖 Codex Code ReviewFindings:
No consensus/security/runtime code changes are in this PR, so I did not find functional regressions in fork choice, attestation processing, state transition, XMSS verification, or SSZ handling from the diff itself. Automated review by OpenAI Codex · gpt-5.4 · custom prompt |
What
Expands
docs/architecture.mdfrom a four-paragraph sketch into a full page, andwires it into the book. It was never listed in
SUMMARY.md, so mdbook did notrender it.
Contents
and the shared
Store, plus the actor-protocol message table.split of per-interval duties, block import (state transition, state-root check,
head recompute), aggregation off the message loop, reaggregation on import, the
sync gate, pending-parent backfill and the chain-event bus.
and range sync,
BlocksByRootretries.single-writer discipline.
shutdown.
Cross-links to
slots_and_intervals.md,3sf_mini.md,lmd_ghost.md,data_storage.md,checkpoint_sync.mdandrpc.md.Accuracy
Every claim was verified against the code it describes, then re-checked in a
second pass that corrected fifteen of them. Things worth knowing that the earlier
draft got wrong:
boundary, so an early session buys proving time and not earlier publication.
into the local pool for fork-choice weight.
pending_blocksis keyed by immediate parent; the deep missing ancestor livesin
pending_block_parents.only when the ports match.
Also
SUMMARY.mdholding the page.Spec Deviations invisible from the intro. Both it and the new Design part are
now listed.
mdbook buildpasses, including the linkcheck backend.