docs: update quickstart #1766
docs: update quickstart #1766
Conversation
|
Warning Rate limit exceeded@jcstein has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 10 minutes and 35 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe changes in this pull request involve significant updates to the documentation structure within the Celestia project. Key modifications include the addition of a "Quick start" navigation item, reorganization of sidebar links, and enhancements to several how-to guides and tutorials. The updates aim to improve clarity, accessibility, and user guidance across various documents, particularly focusing on installation processes and operational instructions for Celestia components. Changes
Assessment against linked issues
Possibly related issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 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 and nitpick comments (15)
how-to-guides/celestia-app.md (1)
20-22: LGTM! Consider enhancing the RPC endpoint description.The introduction clearly states the main purpose of celestia-app. To make it even more helpful for newcomers, consider expanding on what the RPC endpoints are used for, such as:
Celestia-app is the software that allows you to run -validator nodes and provide RPC endpoints. +validator nodes and provide RPC endpoints for blockchain queries and transactions.how-to-guides/celestia-node.md (4)
99-104: Consider clarifying path precedence for binary locations.The binary locations are well-documented, but it would be helpful to clarify the precedence of these paths. This helps users understand which location takes priority if multiple paths exist.
The installation script will download a binary file named `celestia`. Depending on your chosen installation option, the `celestia` binary will be available at one of these locations: - - `$GOPATH/bin/celestia` (if Go is installed) - - `/usr/local/bin/celestia` - - `$HOME/celestia-node-temp/celestia` + 1. `$GOPATH/bin/celestia` (if Go is installed, highest precedence) + 2. `/usr/local/bin/celestia` + 3. `$HOME/celestia-node-temp/celestia` (lowest precedence)
112-119: Add version verification step before installation.Consider adding a step for users to verify available versions before installation, especially for specific version installations.
# Install latest version bash -c "$(curl -sL https://docs.celestia.org/celestia-node.sh)" +# View available versions +curl -s https://api.github.com/repos/celestiaorg/celestia-node/releases | grep -o '"tag_name": ".*"' | cut -d'"' -f4 + # Install specific version bash -c "$(curl -sL https://docs.celestia.org/celestia-node.sh)" -- -v {{mainnetVersions['node-latest-tag']}}
135-139: Enhance post-installation verification steps.Consider adding more comprehensive verification steps:
celestia version && celestia --help + +# Verify binary location +which celestia + +# Verify executable permissions +ls -l $(which celestia) + +# Verify all required commands are available +celestia node --help
141-143: Expand troubleshooting information.While the log file location is helpful, consider adding:
- Common installation issues and their solutions
- How to interpret the log file
- When to refer to the troubleshooting guide
> **Note**: The script maintains a log file at `$HOME/celestia-node-temp/logfile.log` for troubleshooting purposes. + +Common issues you might encounter: +- Permission denied: Ensure you have appropriate permissions for the installation directory +- Binary not found: Verify your PATH environment variable +- Checksum mismatch: Re-download the installation script and try again + +For detailed troubleshooting steps, refer to the [troubleshooting guide](./celestia-node-troubleshooting.md).how-to-guides/quick-start.md (6)
13-13: Fix grammar in introduction sentenceThere's a minor grammar issue in the introduction.
-Welcome to Celestia's quick start guide! In this guide, we'll learn how to run a Celestia data availability sampling (DAS) light node to post and retrieve data blobs on Celestia's [Mocha testnet](./mocha-testnet.md). +Welcome to Celestia's quick start guide! In this guide, you'll learn how to run a Celestia data availability sampling (DAS) light node to post and retrieve data blobs on Celestia's [Mocha testnet](./mocha-testnet.md).🧰 Tools
🪛 LanguageTool
[grammar] ~13-~13: There seems to be a noun/verb agreement error. Did you mean “guides” or “guided”?
Context: ...ipt> Welcome to Celestia's quick start guide! In this guide, we'll learn how to run ...(SINGULAR_NOUN_VERB_AGREEMENT)
67-67: Fix grammatical error-You'll also see In this example, using the Mocha testnet and setting up a light node, our node store will be at: `~/.celestia-light-{{ constants.mochaChainId }}`. +In this example, using the Mocha testnet and setting up a light node, our node store will be at: `~/.celestia-light-{{ constants.mochaChainId }}`.
61-63: Consider using a more appropriate mnemonic exampleWhile the Rickroll mnemonic is humorous, it might be better to use a more realistic example in security-related documentation to set proper expectations for users about mnemonic format and security best practices.
Consider using a standard BIP39 mnemonic format example instead, with a clear note that it's just an example and should never be used in production.
132-132: Fix typo in response description-Once you run this command, you'll see a a height and data committment in the response. +Once you run this command, you'll see a height and data commitment in the response.Note: Also fixed the spelling of "commitment".
🧰 Tools
🪛 LanguageTool
[duplication] ~132-~132: Possible typo: you repeated a word
Context: ... Once you run this command, you'll see a a height and data committment in the resp...(ENGLISH_WORD_REPEAT_RULE)
122-122: Enhance namespace explanationThe namespace explanation could be more technical to help developers understand its purpose better.
-The `[namespace]` is a permissionless way to categorize your data on Celestia. In other words, it's a channel for you to post your data. For example, this could be the name of your project or a category for the type of blob. In this example, we'll use `0x48656C6C6F` as the namespace, which is the hex encoding of "quotes". +The `[namespace]` is a permissionless way to categorize your data on Celestia. It's a 29-byte identifier that helps organize and retrieve data efficiently. For example, this could be your project's unique identifier or a category for the blob type. In this example, we'll use `0x48656C6C6F` as the namespace, which is the hex encoding of "quotes".
229-239: Standardize formatting in node store structureThe bullet points have inconsistent punctuation and formatting.
In this guide, the node store for `~/.celestia-light-{{ constants.mochaChainId }}` contains the following directories: - `config.toml`: Node configuration settings - `data/`: Contains database files - `.vlog` files: Value log files storing actual data - `.sst` files: Static sorted tables containing indexed data - System files: `DISCARD`, `KEYREGISTRY`, and `MANIFEST` for database management - `keys/`: Stores node identity and account keys - - Contains encoded node identifiers - - `keyring-test/`: Test keyring directory storing - - `.address` files: Account addresses - - `.info` files: Key metadata and information + - Contains encoded node identifiers + - `keyring-test/`: Test keyring directory containing: + - `.address` files: Account addresses + - `.info` files: Key metadata and information🧰 Tools
🪛 LanguageTool
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ... following directories: -config.toml: Node configuration settings -data/: ...(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~230-~230: Possible typo: you repeated a word
Context: ...n settings -data/: Contains database files -.vlogfiles: Value log files storing actual data ...(ENGLISH_WORD_REPEAT_RULE)
public/celestia-node.sh (4)
65-70: Enhance version format validation to accommodate pre-release versionsThe current regular expression for validating the version format may not match all valid semantic versioning formats, such as pre-releases or build metadata (e.g.,
v1.0.0-beta.1orv1.0.0+build.1). Consider updating the regex to handle these cases.You can modify the regex pattern as follows:
-if [[ ! $VERSION =~ ^v[0-9]+\.[0-9]+\.[0-9]+(-.*)?$ ]]; then +if [[ ! $VERSION =~ ^v[0-9]+\.[0-9]+\.[0-9]+([-+].*)?$ ]]; thenThis change allows for additional pre-release and build metadata tags in the version string.
193-194: Reevaluate the necessity of symbolic links in the temporary directoryCreating symbolic links to the binary within the temporary directory after moving it to a global path (like
$GOBINor/usr/local/bin) may be redundant and could potentially confuse users. Since the binary is accessible globally, the symbolic link in the temporary directory might not be needed.Consider removing the creation of symbolic links in the temporary directory unless there is a specific use case that requires them.
Also applies to: 209-210, 234-235
197-201: Provide guidance for adding Go bin directory to PATHThe script correctly checks if
$GOBINis in the user'sPATHand provides instructions if it's not. To enhance clarity, you might specify the exact file to edit based on the user's shell (e.g.,.bashrcfor Bash or.zshrcfor Zsh).For example, you can modify the message as follows:
-echo "NOTE: $GOBIN is not in your PATH. You may want to add it by adding this line to your ~/.bashrc or ~/.zshrc:" +echo "NOTE: $GOBIN is not in your PATH. You may want to add it by adding this line to your shell profile (e.g., ~/.bashrc or ~/.zshrc):"This change acknowledges that users might be using different shells and directs them accordingly.
65-70: Ensure informative error message for invalid version formatThe error message for an invalid version format is helpful. However, you might provide an example of a valid pre-release or build metadata version to guide users.
For instance, you can update the message:
-echo "Version should be in the format vX.X.X (e.g., v0.11.0)" | tee -a "$LOGFILE" +echo "Version should be in the format vX.X.X (e.g., v0.11.0, v1.0.0-beta.1)" | tee -a "$LOGFILE"This offers users a clearer understanding of acceptable version formats.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (7)
- .vitepress/config.ts (4 hunks)
- how-to-guides/celestia-app.md (1 hunks)
- how-to-guides/celestia-node.md (1 hunks)
- how-to-guides/quick-start.md (1 hunks)
- index.md (1 hunks)
- public/celestia-node.sh (3 hunks)
- tutorials/node-api.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/quick-start.md
[grammar] ~13-~13: There seems to be a noun/verb agreement error. Did you mean “guides” or “guided”?
Context: ...ipt> Welcome to Celestia's quick start guide! In this guide, we'll learn how to run ...(SINGULAR_NOUN_VERB_AGREEMENT)
[duplication] ~132-~132: Possible typo: you repeated a word
Context: ... Once you run this command, you'll see a a height and data committment in the resp...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...``` Let's break it down: -namespace: The [namespace](https://celestiaorg.git...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ...u used to categorize your data. -data: The data blob you posted to the network...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~177-~177: Loose punctuation mark.
Context: ...posted to the network. -share_version: The version of the [share](https://cele...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...th exactly one namespace. -commitment: The commitment of the data (see [Blob S...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~179-~179: Loose punctuation mark.
Context: ...blob-share-commitment-rules)). -index: The [index](https://celestiaorg.github....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ... following directories: -config.toml: Node configuration settings -data/: ...(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~230-~230: Possible typo: you repeated a word
Context: ...n settings -data/: Contains database files -.vlogfiles: Value log files storing actual data ...(ENGLISH_WORD_REPEAT_RULE)
🪛 Markdownlint
how-to-guides/quick-start.md
52-52: Column: 5
Hard tabs(MD010, no-hard-tabs)
52-52: Column: 10
Hard tabs(MD010, no-hard-tabs)
52-52: Column: 33
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 5
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 10
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 33
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 46
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 5
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 10
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 33
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 5
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 10
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 34
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 5
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 10
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 34
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 79
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 5
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 10
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 34
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 5
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 10
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 33
Hard tabs(MD010, no-hard-tabs)
87-87: Column: 15
Hard tabs(MD010, no-hard-tabs)
88-88: Column: 12
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 10
Hard tabs(MD010, no-hard-tabs)
🔇 Additional comments (17)
index.md (2)
15-15: LGTM! Improved clarity of primary CTAThe change from "Build whatever" to "Quick start" provides a clearer, more conventional entry point for new users, better aligning with documentation best practices.
16-16: Verify the quick start guide exists at the new pathLet's ensure the target page exists to prevent broken links.
✅ Verification successful
Let me gather more information to verify the existence of the quick start guide, as the previous search path was incorrect.
Let me verify the content of the quick-start guide to ensure it's not just an empty file.
The quick start guide exists and is properly populated
The quick start guide exists at the correct path
how-to-guides/quick-start.mdand contains comprehensive content about getting started with Celestia, including instructions for running a light node, posting data, and retrieving data. The link in the navigation will work correctly.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of the quick start guide # Expected: Find the quick start guide markdown file # Search for the quick start guide file fd "quick-start.md" docs/how-to-guides/ # Alternatively, check if it's referenced in the VitePress config rg "quick-start" .vitepress/Length of output: 340
Script:
#!/bin/bash # Search for quick-start markdown file in the entire repository fd "quick-start.md" # Also check for the content structure to understand where docs are located fd "how-to-guides" # Let's also check the root structure to understand the docs organization ls -laLength of output: 1344
Script:
#!/bin/bash # Check the content of the quick-start guide cat how-to-guides/quick-start.mdLength of output: 10364
tutorials/node-api.md (3)
42-43: LGTM! Clear progression in documentation structureThe rewording appropriately positions this tutorial as a deeper dive after the quick start guide, creating a logical learning progression for users.
44-44: Consider enhancing the alternative tutorials sectionThe addition of Rust and Golang tutorials addresses Issue #1756's objectives. Consider adding brief descriptions to help users choose the most appropriate tutorial for their needs.
Consider expanding this section like so:
-Other ways to get started are with the [Rust](./rust-client-tutorial.md) and [Golang](./golang-client-tutorial.md) tutorials. +Other ways to get started: +- [Rust tutorial](./rust-client-tutorial.md) - Learn how to interact with Celestia using Rust +- [Golang tutorial](./golang-client-tutorial.md) - Build applications using the native Go implementationLet's verify the tutorial links:
#!/bin/bash # Description: Verify the existence of the language-specific tutorials # Expected: Both tutorial files should exist fd --type f "rust-client-tutorial.md|golang-client-tutorial.md" tutorials/
38-39: Verify the quick start guide link pathThe addition of the quick start guide reference improves the documentation flow and matches the PR objectives.
Let's verify the quick start guide link path:
✅ Verification successful
Let me gather more information about the quick start guide's location since the previous search didn't find it.
The previous search was unsuccessful, so I'm broadening the search to:
- Look for quick-start.md anywhere in the repository
- Understand the documentation structure by looking at markdown files in docs/
- Check recent changes that might indicate documentation restructuring
This will help us verify if the link path is correct or needs to be updated.
Link path to quick start guide is correct and verified
The relative path
../how-to-guides/quick-start.mdin the documentation is correct. The file exists athow-to-guides/quick-start.mdin the repository, and when referenced fromtutorials/node-api.md, the relative path../how-to-guides/quick-start.mdcorrectly points to this location.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the existence of the quick start guide # Expected: The quick start guide file should exist at the specified path fd --type f "quick-start.md" how-to-guides/Length of output: 146
Script:
#!/bin/bash # Let's do a broader search for the quick-start guide across the repository fd --type f "quick-start.md" # Also search for any markdown files in docs directory to understand the documentation structure fd --type f -e md docs/ # Let's also check if there are any recent changes to documentation structure git log --since="1 month ago" --name-only --pretty=format: | grep -i "quick-start\|docs\|tutorials" | sort -uLength of output: 457
how-to-guides/celestia-app.md (1)
Line range hint
1-150: Well-structured documentation with clear installation paths!The document effectively:
- Provides clear installation options (source vs. pre-built)
- Includes detailed port configurations
- Maintains consistent formatting throughout
how-to-guides/celestia-node.md (2)
99-143: Documentation improvements look great!The changes significantly improve the installation guide's clarity and organization. The pre-built binary installation process is well-documented, with clear instructions and helpful details about the installation script's functionality. This aligns well with the PR objectives of enhancing the quick start guide.
122-134: Add security best practices for script execution.While the script functionality is well-documented, consider adding security best practices such as:
- Verifying script integrity
- Understanding the implications of system-wide installation
- Explaining the permissions required for each installation location
Let's verify if the script includes checksum verification:
✅ Verification successful
Let me verify if the documentation accurately reflects the script's security measures by checking the complete script content.
Let me also check if there are any other installation scripts in the repository that might have relevant security documentation:
Based on the script analysis, I can now generate the final response since I have sufficient information about the security measures in place.
Documentation accurately reflects security measures, but could be enhanced
The current documentation correctly mentions checksum verification, which is indeed implemented in the script. However, the documentation could be more comprehensive about the security aspects that are present in the script:
- The script already implements:
- Secure downloads using HTTPS
- Checksum verification against official checksums.txt
- Clear permission requirements for system-wide installation
- Safe temporary directory handling
- User consent for privileged operations
Suggested additions to the documentation:
- Mention that system-wide installation (
/usr/local/bin) requires sudo privileges- Note that the script creates logs at
$HOME/celestia-node-temp/logfile.logfor audit purposes- Include that the script performs cleanup of temporary files after installation
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check if the installation script includes checksum verification curl -sL https://docs.celestia.org/celestia-node.sh | grep -A 5 "checksum"Length of output: 1033
Script:
#!/bin/bash # Get the full script content to analyze security measures curl -sL https://docs.celestia.org/celestia-node.sh | grep -A 3 "permission\|sudo\|LOGFILE\|security"Length of output: 3384
Script:
#!/bin/bash # Search for installation-related files fd -e sh -e md . | grep -i "install"Length of output: 36
.vitepress/config.ts (4)
258-266: LGTM! Navigation structure improvements enhance documentation accessibility.The addition of the Quick start link and reorganization of Resources section with new links to CIPs and API docs provides better navigation for users.
387-397: LGTM! Well-structured hierarchy for node setup documentation.The reorganization with a dedicated "Getting started" section and prominent placement of the Quick start guide improves the user experience for new users setting up nodes.
564-567: LGTM! Clear overview structure for the Build section.The addition of an overview page helps users better understand the build options available to them.
822-825: LGTM! Improved structure for API documentation.The addition of an overview page for Node API Tutorials provides a better entry point for developers.
public/celestia-node.sh (5)
14-26: Command-line argument parsing is implemented correctlyThe script correctly parses the
-voption usinggetopts, allowing users to specify a version. The error handling for invalid options and the usage instructions are clear and user-friendly.
49-62: Version selection and fetching logic works as intendedThe logic for setting the
VERSIONvariable is well-implemented. If the user provides a version, it uses that; otherwise, it fetches the latest release tag from GitHub. The error handling in case of failing to fetch the version is appropriate.
154-154: Cleanup of temporary files is properly handledRemoving
checksums.txtafter its use helps keep the temporary directory clean and prevents clutter.
159-167: Go installation check is correctly implementedThe script effectively checks whether Go is installed and sets the
HAS_GOflag appropriately. It retrievesGOPATHandGOBINwhen available, which is essential for determining installation options.
168-253: Installation options provide flexibility to the userThe script offers clear choices for installing the binary based on whether Go is installed. The logic for handling each option, including moving the binary and setting permissions, is sound. The user prompts and instructions enhance usability.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
how-to-guides/quick-start.md (1)
197-203: Consider adding security warning for auth token.Since the auth token provides admin access, consider adding a security warning about keeping it secure and not sharing it.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- how-to-guides/quick-start.md (1 hunks)
- index.md (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- index.md
🧰 Additional context used
🪛 LanguageTool
how-to-guides/quick-start.md
[grammar] ~13-~13: There seems to be a noun/verb agreement error. Did you mean “guides” or “guided”?
Context: ...ipt> Welcome to Celestia's quick start guide! In this guide, we'll learn how to run ...(SINGULAR_NOUN_VERB_AGREEMENT)
[uncategorized] ~20-~20: Possible missing comma found.
Context: ...et's get started! ## Run a light node First we'll need to install thecelestiabi...(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~132-~132: Possible typo: you repeated a word
Context: ... Once you run this command, you'll see a a height and data committment in the resp...(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...``` Let's break it down: -namespace: The [namespace](https://celestiaorg.git...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ...u used to categorize your data. -data: The data blob you posted to the network...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~177-~177: Loose punctuation mark.
Context: ...posted to the network. -share_version: The version of the [share](https://cele...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...th exactly one namespace. -commitment: The commitment of the data (see [Blob S...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~179-~179: Loose punctuation mark.
Context: ...blob-share-commitment-rules)). -index: The [index](https://celestiaorg.github....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~229-~229: Loose punctuation mark.
Context: ...ctories and file types: -config.toml: Node configuration settings -data/: ...(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~230-~230: Possible typo: you repeated a word
Context: ...n settings -data/: Contains database files -.vlogfiles: Value log files storing actual data ...(ENGLISH_WORD_REPEAT_RULE)
🪛 Markdownlint
how-to-guides/quick-start.md
52-52: Column: 5
Hard tabs(MD010, no-hard-tabs)
52-52: Column: 10
Hard tabs(MD010, no-hard-tabs)
52-52: Column: 33
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 5
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 10
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 33
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 46
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 5
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 10
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 33
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 5
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 10
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 34
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 5
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 10
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 34
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 79
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 5
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 10
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 34
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 5
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 10
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 33
Hard tabs(MD010, no-hard-tabs)
87-87: Column: 15
Hard tabs(MD010, no-hard-tabs)
88-88: Column: 12
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 10
Hard tabs(MD010, no-hard-tabs)
🔇 Additional comments (6)
how-to-guides/quick-start.md (6)
1-15: LGTM! Clear and well-structured introduction.The introduction effectively sets expectations and introduces key concepts like blobs and DAS.
🧰 Tools
🪛 LanguageTool
[grammar] ~13-~13: There seems to be a noun/verb agreement error. Did you mean “guides” or “guided”?
Context: ...ipt> Welcome to Celestia's quick start guide! In this guide, we'll learn how to run ...(SINGULAR_NOUN_VERB_AGREEMENT)
37-92: LGTM! Well-documented initialization process.The section provides clear instructions and example output. Good use of a joke mnemonic instead of a real one in the examples.
🧰 Tools
🪛 Markdownlint
52-52: Column: 5
Hard tabs(MD010, no-hard-tabs)
52-52: Column: 10
Hard tabs(MD010, no-hard-tabs)
52-52: Column: 33
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 5
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 10
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 33
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 46
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 5
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 10
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 33
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 5
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 10
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 34
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 5
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 10
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 34
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 79
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 5
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 10
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 34
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 5
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 10
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 33
Hard tabs(MD010, no-hard-tabs)
87-87: Column: 15
Hard tabs(MD010, no-hard-tabs)
88-88: Column: 12
Hard tabs(MD010, no-hard-tabs)
89-89: Column: 10
Hard tabs(MD010, no-hard-tabs)
145-180: LGTM! Comprehensive data retrieval documentation.The section provides clear instructions and excellent explanations of each response field.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~175-~175: Loose punctuation mark.
Context: ...``` Let's break it down: -namespace: The [namespace](https://celestiaorg.git...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~176-~176: Loose punctuation mark.
Context: ...u used to categorize your data. -data: The data blob you posted to the network...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~177-~177: Loose punctuation mark.
Context: ...posted to the network. -share_version: The version of the [share](https://cele...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~178-~178: Loose punctuation mark.
Context: ...th exactly one namespace. -commitment: The commitment of the data (see [Blob S...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~179-~179: Loose punctuation mark.
Context: ...blob-share-commitment-rules)). -index: The [index](https://celestiaorg.github....(UNLIKELY_OPENING_PUNCTUATION)
183-190: LGTM! Helpful troubleshooting tip.Good inclusion of a common syncing issue and link to the solution.
240-248: LGTM! Clear next steps.The conclusion effectively guides users to additional resources and next steps.
25-27: Consider adding checksum verification step.While the installation script is hosted on docs.celestia.org, it's a security best practice to include SHA256 checksum verification steps for binary downloads.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (4)
how-to-guides/celestia-node-trusted-hash.md (1)
Line range hint
29-31: Consider adding example values and verification steps.To make the documentation more user-friendly, consider:
- Adding example values for the placeholders (e.g.,
<hash_of_block_n>,<network>,<consensus-node-rpc>)- Including steps or commands to verify that the trusted hash is valid
Example enhancement:
celestia light start --headers.trusted-hash <hash_of_block_n> \ --p2p.network <network> --core.ip <consensus-node-rpc> + +# Example with sample values: +celestia light start --headers.trusted-hash 0x1234...abcd \ + --p2p.network mainnet --core.ip rpc.celestia.example.com:26657how-to-guides/quick-start.md (3)
73-88: Consider enhancing the trusted hash section explanationWhile the section explains the concept well, it could benefit from a clearer structure of the trust implications.
Consider adding a note explaining:
- What security assumptions users are making when using a trusted hash
- Alternative approaches for users who want to avoid these trust assumptions
156-170: Add security note about data visibilityConsider adding a note to inform users that all data posted to Celestia is publicly visible on the network.
Add a warning before the posting example:
The `[namespace]` is a permissionless way to categorize your data on Celestia. In other words, it's a channel for you to post your data. For example, this could be the name of your project or a category for the type of blob. In this example, we'll use `0x71756f746573` as the namespace, which is the hex encoding of "quotes". See the ["quotes" namespace on Celenium](https://mocha.celenium.io/namespace/0000000000000000000000000000000000000000000071756f746573?tab=Blobs). +> ⚠️ **Important**: All data posted to Celestia is publicly visible on the network. Do not post sensitive or private information. +
237-243: Add key backup best practicesConsider adding information about key backup and recovery best practices.
Add a note about:
- The importance of securely backing up keys
- Recommended backup procedures
- Key recovery process
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
- how-to-guides/celestia-node-trusted-hash.md (2 hunks)
- how-to-guides/quick-start.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/quick-start.md
[uncategorized] ~20-~20: Possible missing comma found.
Context: ...et's get started! ## Run a light node First we'll need to install thecelestiabi...(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~215-~215: Loose punctuation mark.
Context: ...``` Let's break it down: -namespace: The [namespace](https://celestiaorg.git...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~216-~216: Loose punctuation mark.
Context: ...u used to categorize your data. -data: The data blob you posted to the network...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~217-~217: Loose punctuation mark.
Context: ...posted to the network. -share_version: The version of the [share](https://cele...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~218-~218: Loose punctuation mark.
Context: ...th exactly one namespace. -commitment: The commitment of the data (see [Blob S...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~219-~219: Loose punctuation mark.
Context: ...blob-share-commitment-rules)). -index: The [index](https://celestiaorg.github....(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~259-~259: Loose punctuation mark.
Context: ...ctories and file types: -config.toml: Node configuration settings -data/: ...(UNLIKELY_OPENING_PUNCTUATION)
[duplication] ~260-~260: Possible typo: you repeated a word
Context: ...n settings -data/: Contains database files -.vlogfiles: Value log files storing actual data ...(ENGLISH_WORD_REPEAT_RULE)
🪛 Markdownlint
how-to-guides/quick-start.md
52-52: Column: 5
Hard tabs(MD010, no-hard-tabs)
52-52: Column: 10
Hard tabs(MD010, no-hard-tabs)
52-52: Column: 33
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 5
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 10
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 33
Hard tabs(MD010, no-hard-tabs)
53-53: Column: 46
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 5
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 10
Hard tabs(MD010, no-hard-tabs)
54-54: Column: 33
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 5
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 10
Hard tabs(MD010, no-hard-tabs)
55-55: Column: 34
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 5
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 10
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 34
Hard tabs(MD010, no-hard-tabs)
56-56: Column: 79
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 5
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 10
Hard tabs(MD010, no-hard-tabs)
57-57: Column: 34
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 5
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 10
Hard tabs(MD010, no-hard-tabs)
64-64: Column: 33
Hard tabs(MD010, no-hard-tabs)
109-109: Column: 15
Hard tabs(MD010, no-hard-tabs)
110-110: Column: 12
Hard tabs(MD010, no-hard-tabs)
111-111: Column: 10
Hard tabs(MD010, no-hard-tabs)
🔇 Additional comments (3)
how-to-guides/celestia-node-trusted-hash.md (2)
15-15: LGTM: Improved punctuation consistency.The addition of the period after "Celenium" maintains consistent punctuation throughout the document.
26-26: LGTM: Improved code formatting.The addition of backticks around
config.tomlimproves readability by clearly identifying it as a code reference.how-to-guides/quick-start.md (1)
2-17: Well-structured introduction that aligns with PR objectives!The introduction effectively explains the purpose of the guide and provides clear context about blobs and their role in Celestia's data availability layer.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Overview
Resolves #1756
Partially resolves #1341
This also removes any pages that were displayed as category headings, i.e "Build whatever" here shows a page:
Summary by CodeRabbit
Release Notes
New Features
quick-start.mdto focus on posting data blobs on Celestia, including installation and initialization instructions for the light node.Documentation Enhancements
celestia-app.mdandcelestia-node.mdinstallation guides.tutorials/node-api.mdto include a new "quick start guide" section.Bug Fixes
public/celestia-node.shscript.