Enhance quick-start guide with improved clarity and organization#2031
Enhance quick-start guide with improved clarity and organization#2031
Conversation
- improved node header query cmd - added TrustedHash in config.toml setup - clarified meaning of sampling-stats output
WalkthroughThe quick-start guide was updated to streamline instructions for setting trusted height and hash, correct file paths, add missing configuration steps, and reorganize advanced topics. New sections on node store contents and troubleshooting were introduced, while various examples and references were clarified or expanded for improved guidance. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Guide
participant Node
participant ConfigFile
User->>Guide: Follow quick-start instructions
Guide->>User: Provide concise command to get trusted height/hash
User->>ConfigFile: Update config.toml with trusted values
User->>Node: Start node (simplified command)
Node->>User: Show syncing status and store contents
User->>Guide: Refer to troubleshooting or advanced key management as needed
Possibly related PRs
Poem
Tip ⚡️ Faster reviews with caching
Enjoy the performance boost—your workflow just got faster. 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: 1
🔭 Outside diff range comments (1)
how-to-guides/quick-start.md (1)
99-104:⚠️ Potential issueUpdate guidance text after removing the
--headers.trusted-hashflag
The start command no longer includes--headers.trusted-hash, but the paragraph below still references it. Either restore the flag in the command or update the text to note that the trusted hash is now loaded fromconfig.toml. For example:- The `headers.trusted-hash` flag will set the trusted hash from the previous section. + The trusted hash is now read automatically from your `config.toml` (no CLI flag needed).
🧹 Nitpick comments (4)
how-to-guides/quick-start.md (4)
81-83: Enhance error handling and readability of the one-liner for fetching trusted height & hash
The current one-liner is concise but can silently mask failures (e.g.,curlorjqerrors) and is hard to troubleshoot. Consider:
- Breaking it into multiple commands (curl → parse → export).
- Adding
set -o errexit -o pipefailso any step failure aborts the script.- Logging errors when fetching or parsing fails.
217-219: Standardize Celenium Explorer link formatting
Consider updating the link text to “Celenium Explorer” (capitalized) and ensure it matches other references:- You can also inspect this example on celenium explorer [here](https://mocha.celenium.io/blob?...). + You can also inspect this example on **Celenium Explorer** [here](https://mocha.celenium.io/blob?...).
234-243: Adjust markdown list indentation for “Node store contents” section
The bullet list under “Node store contents” is misaligned with markdownlint rules (MD007). Ensure top-level items start at column 1 and nested items are indented consistently. For example:- - `config.toml`: Node configuration settings + - `config.toml`: Node configuration settings - - `data/`: Contains database files - - `.vlog` files: Value log files - - `.sst` files: Static sorted tables - - System files: `DISCARD`, `KEYREGISTRY`, `MANIFEST` + - `data/`: Contains database files + - `.vlog` files: Value log files + - `.sst` files: Static sorted tables + - System files: `DISCARD`, `KEYREGISTRY`, `MANIFEST`🧰 Tools
🪛 LanguageTool
[uncategorized] ~240-~240: Loose punctuation mark.
Context: ...ctories and file types: -config.toml: Node configuration settings -data/: ...(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~241-~241: Possible typo: you repeated a word.
Context: ...n settings -data/: Contains database files -.vlogfiles: Value log files storing actual data ...(ENGLISH_WORD_REPEAT_RULE)
261-266: Fix list indentation under “Advanced Key management withcel-key”
The two list items are indented by one space, which violates markdownlint (MD007). Align them to the parent level:- - Create, import, and manage keys. - - Backup, verify and select the active key used by your node. + - Create, import, and manage keys. + - Backup, verify and select the active key used by your node.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
265-265: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
266-266: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/quick-start.md(6 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/quick-start.md
[uncategorized] ~88-~88: “ti” (solmization) seems less likely than “to
Context: ...23456) 1. Set Header.TrustedHashti the trusted hash (e.g.TrustedHash = "...
(AI_HYDRA_LEO_CPT_TI_TO)
[uncategorized] ~240-~240: Loose punctuation mark.
Context: ...ctories and file types: - config.toml: Node configuration settings - data/: ...
(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~241-~241: Possible typo: you repeated a word.
Context: ...n settings - data/: Contains database files - .vlog files: Value log files storing actual data ...
(ENGLISH_WORD_REPEAT_RULE)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/quick-start.md
265-265: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
266-266: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
| 1. Open your `config.toml` at `~/.celestia-light-{{ constants.mochaChainId }}/config.toml` | ||
| 1. Set `DASer.SampleFrom` to the trusted height (e.g. `SampleFrom = 123456`) | ||
| 1. Set `Header.TrustedHash` ti the trusted hash (e.g. `TrustedHash = "71BDED03E16EC34A6548388ADBAF3BA679FD5C1AAC3587A7F5F843741856D839"` ) | ||
|
|
There was a problem hiding this comment.
Fix numbering, typo, and improve clarity in config.toml setup steps
The nested “1.” steps are confusing and there’s a typo (“ti” → “to”). It’s clearer to use a flat list:
- 1. Open your `config.toml` at `~/.celestia-light-{{ constants.mochaChainId }}/config.toml`
- 1. Set `DASer.SampleFrom` to the trusted height (e.g. `SampleFrom = 123456`)
- 1. Set `Header.TrustedHash` ti the trusted hash (e.g. `TrustedHash = "…"`)
+ 1. Open your `config.toml` at `~/.celestia-light-{{ constants.mochaChainId }}/config.toml`
+ 2. Under `[DASer]`, set:
+ ```toml
+ SampleFrom = <TRUSTED_HEIGHT>
+ ```
+ 3. Under `[Header]`, set:
+ ```toml
+ TrustedHash = "<TRUSTED_HASH>"
+ ```This corrects the typo and makes each step explicit.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~88-~88: “ti” (solmization) seems less likely than “to
Context: ...23456) 1. Set Header.TrustedHashti the trusted hash (e.g.TrustedHash = "...
(AI_HYDRA_LEO_CPT_TI_TO)
There was a problem hiding this comment.
LGTM, let's update the trusted hash guide too with this UX in another PR #2033 read -r TRUSTED_HEIGHT TRUSTED_HASH <<<"$(curl -s https://rpc-mocha.pops.one/header | jq -r '.result.header | "\(.height) \(.last_block_id.hash)"')" && export TRUSTED_HEIGHT TRUSTED_HASH && echo "Height: $TRUSTED_HEIGHT" && echo "Hash: $TRUSTED_HASH"
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
how-to-guides/quick-start.md (1)
86-88:⚠️ Potential issueFix typo in trusted hash configuration step
There's a small typo that could confuse readers:tishould beto.Apply this diff:
- 1. Set `Header.TrustedHash` ti the trusted hash (e.g. `TrustedHash = "E8BD0C48260C496BB7A4D8D1E7BDBF1F26A2FE3CF5714DECE1741B2FFB3C095C"` ) + 1. Set `Header.TrustedHash` to the trusted hash (e.g. `TrustedHash = "E8BD0C48260C496BB7A4D8D1E7BDBF1F26A2FE3CF5714DECE1741B2FFB3C095C"` )
🧹 Nitpick comments (4)
how-to-guides/quick-start.md (4)
119-119: Suggest clearer phrasing for sync-tip
You can tighten the wording for readability. For example:-If you want to see that your node is synced, use the `celestia das sampling-stats` command to check it in another terminal. +To verify your node is synced, run `celestia das sampling-stats` in another terminal.
218-218: Capitalize and stylize Celenium Explorer link
“celenium explorer” should be capitalized as it’s a proper noun. For consistency and clarity:-You can also inspect this example on celenium explorer [here](https://mocha.celenium.io/blob?...) +You can also inspect this example on the Celenium Explorer [here](https://mocha.celenium.io/blob?...)
234-250: Review Node store contents section for clarity
The new section is informative, but consider:
- Quoting the section title in the link for consistency:
Initialize the light nodeinstead of plain text.- Adding a blank line before the list for better markdown rendering.
- Ensuring list items don’t have stray trailing punctuation if they’re fragments.
These tweaks will improve readability and maintain a uniform style.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~240-~240: Loose punctuation mark.
Context: ...ctories and file types: -config.toml: Node configuration settings -data/: ...(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~241-~241: Possible typo: you repeated a word.
Context: ...n settings -data/: Contains database files -.vlogfiles: Value log files storing actual data ...(ENGLISH_WORD_REPEAT_RULE)
265-266: Fix list indentation undercel-keysection
Markdown lint flags the odd indent. Remove the leading space so items align with the margin:- - Create, import, and manage keys. - - Backup, verify and select the active key used by your node + - Create, import, and manage keys. + - Backup, verify and select the active key used by your node🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
265-265: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
266-266: Unordered list indentation
Expected: 0; Actual: 1(MD007, ul-indent)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/quick-start.md(6 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/quick-start.md
[uncategorized] ~240-~240: Loose punctuation mark.
Context: ...ctories and file types: - config.toml: Node configuration settings - data/: ...
(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~241-~241: Possible typo: you repeated a word.
Context: ...n settings - data/: Contains database files - .vlog files: Value log files storing actual data ...
(ENGLISH_WORD_REPEAT_RULE)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/quick-start.md
265-265: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
266-266: Unordered list indentation
Expected: 0; Actual: 1
(MD007, ul-indent)
🔇 Additional comments (2)
how-to-guides/quick-start.md (2)
82-82: Approve streamlined hash retrieval command
The one-liner to fetch, export, and display bothTRUSTED_HEIGHTandTRUSTED_HASHis a solid improvement for reducing errors.
99-101: Approve simplified node start command
Removing the redundant--headers.trusted-hashflag is correct now that it's configured inconfig.toml. The newcelestia light startinvocation looks good.
2 participants
Overview
This PR improves the quick-start guide with several enhancements:
cel-key) key management section for simplicity and clarityThese changes make the guide more user-friendly and provide better clarity for new users getting started with Celestia light nodes.
Summary by CodeRabbit