doc: improve the page of setting up a validator node #2012
Conversation
reorder the section about delegating state to the validator, and also explain how to add/update a validator's descriptive fields Signed-off-by: Long Zhang <[email protected]>
WalkthroughThis update reorganizes and enhances the validator node documentation. The section on delegating stake to a validator is moved to a later part of the guide and retitled for clarity. The instructions for running a validator node are revised to clarify variable usage and expand the validator creation command with additional optional metadata fields. A tip is added to explain these fields and demonstrate how to update them later. No code or exported entity changes are present; all modifications are within the documentation. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
🧹 Nitpick comments (6)
how-to-guides/validator-node.md (6)
115-117: Use "number of tokens" for countable items
Replace "amount of tokens" with "number of tokens" to correctly distinguish countable nouns from mass nouns.
Proposed change:- Parameter `--min-self-delegation=1000000` defines the amount of tokens that are self delegated from your validator wallet. + Parameter `--min-self-delegation=1000000` defines the number of tokens that are self-delegated from your validator wallet.🧰 Tools
🪛 LanguageTool
[uncategorized] ~116-~116: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...in-self-delegation=1000000` defines the amount of tokens that are self delegated from ...(AMOUNTOF_TO_NUMBEROF)
133-135: Recommend exporting the wallet environment variable
To ensure theVALIDATOR_WALLETvariable is available to downstream commands and scripts, consider usingexport:- MONIKER="your_moniker" - VALIDATOR_WALLET="<validator-wallet-name>" + MONIKER="your_moniker" + export VALIDATOR_WALLET="<validator-wallet-name>"
155-170: Refine tip block formatting and tone
- Use
:::tip(or:::info) with a bolded title instead of:::tip NOTE, per VitePress conventions.- Change the code fence from
bash-vuetobashsince this is a standalone example.- Simplify the language around removing flags.
Example diff:
-:::tip NOTE +:::tip +**Note** The options `--identity`, `--website`, `--security-contact` and `--details` are optional. You can update any of these fields after creation using: -```bash-vue +```bash celestia-appd tx staking edit-validator \ --new-moniker=<new_validator_name> \ --identity=<identity_signature> \ --website="<validator_website>" \ --security-contact="<email_address_for_security_contact>" \ --details="New description of the validator." \ --chain-id={{constants.mochaChainId}} \ --from=$VALIDATOR_WALLET \ --keyring-backend=test \ --fees=21000utia \ --gas=220000:::
--- `210-211`: **Recommend exporting the wallet environment variable (again)** Similar to above, ensure the `VALIDATOR_WALLET` variable is exported here as well: ```diff - VALIDATOR_WALLET=<validator-wallet-name> + export VALIDATOR_WALLET=<validator-wallet-name>
213-216: Fix missing comma and clarify phrasing
Insert a comma after "including your own" and streamline the sentence to avoid repetition:- If you want to delegate more stake to any validator, including your own you will need the `celestiavaloper` address of the validator in question. + To delegate more stake to any validator, including your own, you will need the `celestiavaloper` address.🧰 Tools
🪛 LanguageTool
[uncategorized] ~213-~213: A comma might be missing here.
Context: ... stake to any validator, including your own you will need thecelestiavaloperadd...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~216-~216: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...your local validator wallet in case you want to delegate more to it: ```bash celestia-...(REP_WANT_TO_VB)
229-232: Polish example introduction
Refine the lead-in to the example command for clarity and flow:- To delegate tokens to the `celestiavaloper` validator, as an example you can run: + For example, to delegate tokens to a `celestiavaloper` address, run:🧰 Tools
🪛 LanguageTool
[uncategorized] ~229-~229: A comma might be missing here.
Context: ... thecelestiavalopervalidator, as an example you can run: ```bash-vue celestia-appd...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/validator-node.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/validator-node.md
[uncategorized] ~116-~116: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...in-self-delegation=1000000` defines the amount of tokens that are self delegated from ...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~213-~213: A comma might be missing here.
Context: ... stake to any validator, including your own you will need the celestiavaloper add...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~216-~216: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...your local validator wallet in case you want to delegate more to it: ```bash celestia-...
(REP_WANT_TO_VB)
[uncategorized] ~229-~229: A comma might be missing here.
Context: ... the celestiavaloper validator, as an example you can run: ```bash-vue celestia-appd...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🔇 Additional comments (2)
how-to-guides/validator-node.md (2)
140-143: Great addition of optional metadata flags
Including--identity,--website,--security-contact, and--detailsaligns with the PR objective to let users provide rich validator metadata at creation time.
205-207: Approve relocation of the delegation section
Moving "## Optional: Delegate more stake to a validator" after the validator creation steps prevents users from attempting to delegate to a non-existent validator and aligns with the PR’s goal.
how-to-guides/validator-node.md
Outdated
| @@ -234,6 +202,60 @@ You should now be able to see your validator from | |||
| After starting your node, please submit your node as a seed and peer to the | |||
| [networks repository](https://github.com/celestiaorg/networks). | |||
|
|
|||
| ## Optional: Delegate more stake to a validator | |||
There was a problem hiding this comment.
Thank you for the PR @gluckzhang. why does this heading change from "### Delegate stake to a validator" to "## Optional: Delegate more stake to a validator" i.e. why is it "More" now?
There was a problem hiding this comment.
Hi @jcstein, thanks for reviewing it :) Because I moved the section later and I think it should be at the same level as another optional step. Maybe we can group some of the sub-sections if you think the page contains too many ## headlines. Just let me know what you think and I will adjust it!
Here are the screenshots that show the difference.
Current prod version:
This PR:
There was a problem hiding this comment.
Oh sorry I just got your question. I agree more is not necessary here. Let me change it back to the original title :)
Signed-off-by: Long Zhang <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
how-to-guides/validator-node.md (3)
116-117: Refine wording for clarity.The phrase “defines the amount of tokens that are self delegated” is a bit wordy and uses “amount of” with a countable noun. Consider rephrasing to “defines the number of tokens you are self-delegating” for improved readability and correctness.
Proposed diff:
- Parameter `--min-self-delegation=1000000` defines the amount of tokens that are self delegated from your validator wallet. + Parameter `--min-self-delegation=1000000` defines the number of tokens you are self-delegating from your validator wallet.🧰 Tools
🪛 LanguageTool
[uncategorized] ~116-~116: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...in-self-delegation=1000000` defines the amount of tokens that are self delegated from ...(AMOUNTOF_TO_NUMBEROF)
205-206: Approve relocated delegation section & consider clarifying scope.Moving “Delegate stake to a validator” after the creation step improves the tutorial flow. For additional precision, you might rename the heading to:
## Optional: Delegate additional stake to a validatorso it’s clear this is post-creation/delegation.
213-214: Add missing comma for correct punctuation.Insert a comma after “including your own” to separate clauses:
- If you want to delegate more stake to any validator, including your own you will need the `celestiavaloper` address… + If you want to delegate more stake to any validator, including your own, you will need the `celestiavaloper` address…🧰 Tools
🪛 LanguageTool
[uncategorized] ~213-~213: A comma might be missing here.
Context: ... stake to any validator, including your own you will need thecelestiavaloperadd...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/validator-node.md(4 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/validator-node.md
[uncategorized] ~116-~116: ‘Amount of’ should usually only be used with uncountable or mass nouns. Consider using “number” if this is not the case.
Context: ...in-self-delegation=1000000` defines the amount of tokens that are self delegated from ...
(AMOUNTOF_TO_NUMBEROF)
[uncategorized] ~213-~213: A comma might be missing here.
Context: ... stake to any validator, including your own you will need the celestiavaloper add...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[style] ~216-~216: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...your local validator wallet in case you want to delegate more to it: ```bash celestia-...
(REP_WANT_TO_VB)
🔇 Additional comments (2)
how-to-guides/validator-node.md (2)
134-143: Great enhancement: add optional metadata flags.Including
--identity,--website,--security-contact, and--detailsin thecreate-validatorcommand lets users enrich their validator profile upfront. This elevates UX by surfacing profile customization immediately. Ensure flag syntax matches the latest CLI reference.
155-170: Verify CLI support for editing metadata fields.You’ve added a handy tip on using
staking edit-validator. Please confirm that the targetedcelestia-appdversions expose these flags (--identity,--website, etc.) as expected, and consider linking to the official CLI docs foredit-validatorfor future maintainability.
Overview
This PR contains the following two improvements for the page Setting up a Celestia validator node.
First, the sub-section "Delegate stake to a validator" is moved a bit later after creating a validator. If this is done before creating the validator, the transaction will fail with an error "failed to execute message; message index: 0: validator does not exist" (example here).
Second, when creating a validator, users can add extra information such as the logo, website, and a description for the validator. It is also possible to update these fields after creating a validator. This PR adds such explanations to the related section.
Summary by CodeRabbit