chore: Fix typos in documentation for multiple files #1780
Conversation
WalkthroughThis pull request includes updates to several documentation files, focusing on enhancing clarity and correcting minor issues. Key changes involve removing duplicated words, refining explanations, and correcting typographical errors across various guides related to the Arabica devnet, Arbitrum integration, Blobstream, and deployment instructions. The modifications aim to improve the readability and accuracy of the documents while preserving their original structure and content. Changes
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 (5)
how-to-guides/arbitrum-integration.md (2)
60-60: Improve readability by reducing wordiness.Consider simplifying "in order to" to just "to" for better conciseness.
-In order to support fraud proofs, this integration has the necessary code for a Nitro validator to populate its preimage mapping with Celestia hashes that then get "unpeeled" in order to reveal the full data for a Blob. +In order to support fraud proofs, this integration has the necessary code for a Nitro validator to populate its preimage mapping with Celestia hashes that then get "unpeeled" to reveal the full data for a Blob.🧰 Tools
🪛 LanguageTool
[style] ~60-~60: Consider a shorter alternative to avoid wordiness.
Context: ...elestia hashes that then get "unpeeled" in order to reveal the full data for a Blob. You ca...(IN_ORDER_TO_PREMIUM)
67-67: Add commas around the interruptive phrase.The phrase "in fact" should be set off by commas as it's an interruptive phrase.
-Because only data roots that can be confirmed on Blobstream get accepted into the sequencer inbox, one can have a high degree of certainty that the canonical data root being unpeeled as well as the row roots are in fact correct. +Because only data roots that can be confirmed on Blobstream get accepted into the sequencer inbox, one can have a high degree of certainty that the canonical data root being unpeeled as well as the row roots are, in fact, correct.🧰 Tools
🪛 LanguageTool
[typographical] ~67-~67: Consider isolating this adverbial phrase with commas.
Context: ...ng unpeeled as well as the row roots are in fact correct. ### Blobstream X implementati...(IN_FACT_COMMA_2)
how-to-guides/celestia-app-vesting.md (2)
Line range hint
48-54: Fix inconsistency in variable name casingThe explanation text correctly uses
CELESTIA_APP_HOME, but the code block below still showsCElESTIA_APP_HOME. This inconsistency should be fixed to avoid confusion.Apply this diff to fix the variable name in the code block:
-export CElESTIA_APP_HOME=/var/folders/_8/ljj6hspn0kn09qf9fy8kdyh40000gn/T/celestia_app_XXXXXXXXXXXXX.XV92a3qx +export CELESTIA_APP_HOME=/var/folders/_8/ljj6hspn0kn09qf9fy8kdyh40000gn/T/celestia_app_XXXXXXXXXXXXX.XV92a3qx
Line range hint
82-83: Fix variable name casing in all command examplesThe incorrect variable name
$CElESTIA_APP_HOMEis used consistently throughout all command examples. This should be updated to$CELESTIA_APP_HOMEto match the explanation text.All command examples need to be updated. Here's an example of how the commands should look:
-./celestia-appd keys add vesting-key --home $CElESTIA_APP_HOME +./celestia-appd keys add vesting-key --home $CELESTIA_APP_HOME -./celestia-appd keys list --home $CElESTIA_APP_HOME +./celestia-appd keys list --home $CELESTIA_APP_HOME -./celestia-appd tx vesting create-vesting-account $TO_ADDRESS 100000utia 1686748051 --from $FROM_ADDRESS --gas auto --fees 100000utia --chain-id private --home $CElESTIA_APP_HOME +./celestia-appd tx vesting create-vesting-account $TO_ADDRESS 100000utia 1686748051 --from $FROM_ADDRESS --gas auto --fees 100000utia --chain-id private --home $CELESTIA_APP_HOMEPlease update all remaining instances accordingly.
Also applies to: 89-90, 102-103, 108-109, 115-116, 122-123, 129-130, 136-137, 143-144
how-to-guides/blobstream-x-deploy.md (1)
165-165: Fix grammatical error: "setup" should be "set up"The word "setup" is being used as a verb, but it's actually a noun. When used as a verb, it should be written as two words: "set up".
Apply this change:
-by default, the whitelist status is set to `Default`. This means that only the default verifier, which was setup when [deploying the SuccinctGateway](#d... +by default, the whitelist status is set to `Default`. This means that only the default verifier, which was set up when [deploying the SuccinctGateway](#d...🧰 Tools
🪛 LanguageTool
[grammar] ~165-~165: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...at only the default verifier, which was setup when [deploying the SuccinctGateway](#d...(BE_VB_OR_NN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (5)
how-to-guides/arabica-devnet.md(1 hunks)how-to-guides/arbitrum-integration.md(1 hunks)how-to-guides/blobstream-offchain.md(1 hunks)how-to-guides/blobstream-x-deploy.md(2 hunks)how-to-guides/celestia-app-vesting.md(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- how-to-guides/arabica-devnet.md
🧰 Additional context used
🪛 LanguageTool
how-to-guides/arbitrum-integration.md
[style] ~60-~60: Consider a shorter alternative to avoid wordiness.
Context: ...elestia hashes that then get "unpeeled" in order to reveal the full data for a Blob. You ca...
(IN_ORDER_TO_PREMIUM)
[typographical] ~67-~67: Consider isolating this adverbial phrase with commas.
Context: ...ng unpeeled as well as the row roots are in fact correct. ### Blobstream X implementati...
(IN_FACT_COMMA_2)
how-to-guides/blobstream-x-deploy.md
[grammar] ~165-~165: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...at only the default verifier, which was setup when [deploying the SuccinctGateway](#d...
(BE_VB_OR_NN)
🔇 Additional comments (3)
how-to-guides/celestia-app-vesting.md (1)
Line range hint 1-500: Overall document structure and formatting looks good
Apart from the variable name casing issues, the document is well-structured with clear sections, properly formatted code blocks, and helpful examples.
how-to-guides/blobstream-offchain.md (1)
211-212: LGTM! Indentation fix improves readability.
The indentation correction for the Namespace and Span fields in the header initialization improves code block consistency and readability.
how-to-guides/blobstream-x-deploy.md (1)
57-57: LGTM!
The environment variable description is clear and accurate.
|
Congrats, your important contribution to this open-source project has earned you a GitPOAP! GitPOAP: 2024 Celestia Contributor: Head to gitpoap.io & connect your GitHub account to mint! Learn more about GitPOAPs here. |
Overview
Description:
Added typo corrections to documentation for the following files:
arabica-devnet.mdarbitrum-integration.mdblobstream-offchain.mdblobstream-x-deploy.mdcelestia-app-vesting.mdGoal:
Correct grammatical errors and improve readability of the documentation.
Summary by CodeRabbit
Release Notes