docs: correct misuse of 'validator node' across multiple docs#1982
Conversation
Replaced incorrect references to 'validator node' in bridge-node.md, celestia-app.md, full-storage-node.md, and snapshots.md. Updated to 'consensus node', 'core node', or similar terms where appropriate, following the guidance in issue celestiaorg#1977.
WalkthroughThe changes update several how-to guides to clarify node connection instructions and node type descriptions. In the bridge node, full storage node, and light node guides, references to a validator node's gRPC endpoint have been replaced with a consensus node's gRPC endpoint (noting port 9090). In the celestia-app and snapshots guides, the terminology has been broadened from "validator nodes" to "consensus nodes (including validators)". Additional clarifications were made in troubleshooting, config, consensus node, mainnet, and tutorial guides to consistently use "consensus node" terminology. No modifications were made to exported or public entity declarations. Changes
Possibly related PRs
Suggested reviewers
Poem
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
how-to-guides/full-storage-node.md (1)
60-66: 🛠️ Refactor suggestionInconsistent Node Reference Terminology
Line 60 correctly introduces the connection as to a “Celestia Core node’s gRPC endpoint.” However, line 63 still refers to “a gRPC endpoint of a validator (core) node.” For clarity and consistency with the PR objectives, update line 63 to reference “Celestia Core node” exclusively.
🧹 Nitpick comments (2)
how-to-guides/snapshots.md (1)
23-25: Refine Redundant TerminologyThe updated bullet reads “Consensus nodes (including validators) that only need recent state to participate in consensus.” There is a slight repetition of “consensus” that could be clarified. For example, consider rephrasing to something like “that only need recent state for consensus operations” to avoid redundancy.
🧰 Tools
🪛 LanguageTool
[duplication] ~23-~23: Possible typo: you repeated a word.
Context: ...nly need recent state to participate in consensus - Consensus nodes that don't need complete historic...(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~24-~24: Did you mean “to complete”?
Context: ...ensus - Consensus nodes that don't need complete historical data - Users who want to get...(NEEDNT_TO_DO_AND_DONT_NEED_DO)
how-to-guides/bridge-node.md (1)
115-117: Remove Port Information DuplicationThe text redundantly repeats the port information in the parenthetical. Line 115 introduces “(which is usually exposed on port 9090):” and line 116 repeats the same information. Removing the duplicate phrasing on line 116 will improve clarity.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
how-to-guides/bridge-node.md(1 hunks)how-to-guides/celestia-app.md(1 hunks)how-to-guides/full-storage-node.md(1 hunks)how-to-guides/snapshots.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/snapshots.md
[duplication] ~23-~23: Possible typo: you repeated a word.
Context: ...nly need recent state to participate in consensus - Consensus nodes that don't need complete historic...
(ENGLISH_WORD_REPEAT_RULE)
🔇 Additional comments (1)
how-to-guides/celestia-app.md (1)
20-21: Terminology Clarification is CorrectThe change updates the description to “consensus nodes — including validators” which clearly conveys that celestia-app supports multiple node types. Please ensure that this phrasing remains consistent across all related documents.
|
@gabrielaugz can you please use "consensus node" instead of both consensus/core? also please review copliots comments and I'll review after |
I am going to work on it and upload a new commit! |
…ress review comments
|
does this cover the whole codebase? |
Hey! I believe I have reviewed all .md files:
I also reviewed the other files where "validator node" appears — including |
jcstein
left a comment
jcstein
left a comment
There was a problem hiding this comment.
the existing changes LGTM, but after checking have found a few cases that I think should be changed to "consensus node" or clarified, some of these (like ones at end in consensus-node.md), may not need change
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/bridge-node.md?plain=1#L16
- (https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/bridge-node.md?plain=1#L89)
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/config-toml.md?plain=1#L30 - in this case maybe put "Core (Consensus)" because the config says core in it. same for lines 34/35 here
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/config-toml.md?plain=1#L59 "celestia-core node" -> "Celestia consensus node"
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/full-storage-node.md?plain=1#L67
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/full-storage-node.md?plain=1#L87
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/light-node.md?plain=1#L88-L89
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/light-node.md?plain=1#L180-L182
- if you change heading, change this too https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/mainnet.md?plain=1#L108
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/tutorials/node-tutorial.md?plain=1#L19
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/tutorials/node-tutorial.md?plain=1#L84-L87
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/tutorials/node-tutorial.md?plain=1#L874
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/celestia-node-troubleshooting.md?plain=1#L62
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/consensus-node.md?plain=1#L357
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/consensus-node.md?plain=1#L363
- - [ ] https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/consensus-node.md?plain=1#L368
- - [ ] https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/consensus-node.md?plain=1#L372
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/full-storage-node.md?plain=1#L66
- https://github.com/gabrielaugz/celestia-docs/blob/96c048dfd469329714a1a10930bca85ef961544d/how-to-guides/full-storage-node.md?plain=1#L118
|
I'm going to work on it! |
|
awesome! |
Signed-off-by: gabrielaugz <95982237+gabrielaugz@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
how-to-guides/mainnet.md (1)
107-109: Refine wording for clarity
The phrase "with authentication of endpoints" is slightly awkward. Consider rephrasing to "with authenticated endpoints" for a more natural reading:- If you are using QuickNode or another provider with authentication of endpoints, + If you are using QuickNode or another provider with authenticated endpoints, see [the light node guide](/how-to-guides/light-node.md#optional-start-light-node-with-consensus-node-endpoint-with-authentication) to learn how to use an endpoint with x-token.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
how-to-guides/bridge-node.md(3 hunks)how-to-guides/celestia-node-troubleshooting.md(1 hunks)how-to-guides/config-toml.md(2 hunks)how-to-guides/consensus-node.md(1 hunks)how-to-guides/full-storage-node.md(3 hunks)how-to-guides/light-node.md(2 hunks)how-to-guides/mainnet.md(1 hunks)tutorials/node-tutorial.md(3 hunks)
✅ Files skipped from review due to trivial changes (5)
- how-to-guides/consensus-node.md
- how-to-guides/celestia-node-troubleshooting.md
- how-to-guides/light-node.md
- how-to-guides/config-toml.md
- tutorials/node-tutorial.md
🚧 Files skipped from review as they are similar to previous changes (2)
- how-to-guides/bridge-node.md
- how-to-guides/full-storage-node.md
🔇 Additional comments (1)
how-to-guides/mainnet.md (1)
108-109:Details
✅ Verification successful
Verify the updated anchor slug matches the target header
Ensure the link fragment#optional-start-light-node-with-consensus-node-endpoint-with-authenticationcorresponds exactly to a header ID inlight-node.md. Otherwise, the link will break.
🏁 Script executed:
#!/bin/bash # Verify the anchor slug exists in the light-node guide rg -n 'optional-start-light-node-with-consensus-node-endpoint-with-authentication' how-to-guides/light-node.mdLength of output: 110
To determine the correct header slug, let’s list all headings in
how-to-guides/light-node.md:
🏁 Script executed:
#!/bin/bash # List all markdown headings in the light-node guide rg -n '^#{1,6} ' how-to-guides/light-node.mdLength of output: 636
Anchor slug is correct
The fragment#optional-start-light-node-with-consensus-node-endpoint-with-authenticationmatches the header
### Optional: start light node with consensus node endpoint with authentication
on line 180 ofhow-to-guides/light-node.md. No changes needed.
|
Hey! I updated the first sentence under line 355 in The rest of the section already uses the right technical language and clearly points to validator node files like edit: I have already updated with coderabbit suggestion |
Signed-off-by: gabrielaugz <95982237+gabrielaugz@users.noreply.github.com>
|
lgtm, thank you @gabrielaugz ! |
This PR updates multiple documentation files to correct the misuse of the term "validator node", replacing it with more accurate alternatives such as "consensus node", "core node", or "Celestia Core node", where appropriate.
The goal is to improve technical accuracy and clarity, following the guidance in issue #1977.
I have updated the following files:
No changes were made where “validator node” was technically correct.
Summary by CodeRabbit