docs: add node-types page; trim duplicate ASCII diagrams from halt RCA - #70
docs: add node-types page; trim duplicate ASCII diagrams from halt RCA#70luishsr wants to merge 2 commits into
Conversation
Adds doc/node-types.md (Validator/Observer/Archive reference) cross-linked from README and glossary. In the mainnet-halt incident doc, removes the characters-based pipeline/failure/fix diagrams now that Mermaid renders of the same content exist, keeping the Mermaid versions as the single source and folding the one unique data point (observed telemetry) into a plain note.
|
Claude finished @luishsr's task in 2m 25s —— View job PR Review
This is a well-grounded documentation PR. Code references are specific (file paths + line numbers), cross-links are accurate, and the "Archive is not a code concept" disclaimer in Issues to fix1. Stray code fence at end of incident file ( The file ends with a lone This reads as "Observer streams to Archive," which contradicts the prose that correctly says Archive is an Observer with pruning disabled — not a downstream consumer. The edge direction and label mislead: someone skimming the diagram will infer there are two separate node processes (Observer feeding Archive), when there is actually one process run with different flags. Suggested fix — use a Observations (no action required, but worth knowing)
The new
This transparency is good and matches the stated goal of the PR. No action needed. All code-path references verified: Summary: Approve after the stray ``` on line 108 is removed and the |
Security Scan - CodeSeverity: HIGH, CRITICAL No vulnerabilities found View scan results |
…diagram Issue #48 asked the diagram to cover consensus participation, state, RPC exposure, and public access. RPC exposure/public access were only in the comparison table and prose, not the diagram graphic — add a per-node RPC line so the diagram carries all four dimensions.
|
Outstanding from #48's Definition of Done: per-node machine sizing/cost is still open and needs SRE input — not addressed by this PR. `doc/node-types.md` flags it explicitly under "Open questions" rather than answering it, so it isn't lost, but it should be resolved before this doc is treated as complete guidance for provisioning. |
|
Claude finished @luishsr's task in 1m 23s —— View job PR Review — follow-up after commit
|
Summary
doc/node-types.md: Validator/Observer/Archive reference (role, config, why it matters), cross-linked fromdoc/README.mdanddoc/glossary.md.doc/incidents/2026-06-21-mainnet-halt.md, removes the characters-based pipeline/failure/fix diagrams, which duplicated the existing Mermaid diagrams — Mermaid is now the single source. The one unique data point (observed telemetry) is preserved as a plain note.Test plan