Add celestia-da tutorial, network agnostic #368
Conversation
WalkthroughThe refinements in the tutorials streamline the rollup building process by shifting from Ignite CLI and Celestia to Rollkit CLI with a mocked DA network. The documentation's sidebar navigation has been adjusted to focus more on Celestia-related content, omitting details about GM world rollup specifically. Changes
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 as PR comments)
Additionally, you can add CodeRabbit Configration 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: 5
Out of diff range and nitpick comments (2)
tutorials/celestia-da.md (2)
9-9: Consider revising the section title for clarity.The section title "Runnning a Celestia Light Node" contains a typographical error with an extra 'n' in "Running". It should be corrected to "Running a Celestia Light Node".
44-44: Avoid repetitive phrasing to enhance readability.The phrase "Now we're ready to start our rollup and connect it to the Celestia light node" is quite similar to earlier sentences in the document. Consider rephrasing to add variety, such as "At this point, we can initiate our rollup and establish a connection with the Celestia light node."
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- tutorials/celestia-da.md (1 hunks)
- tutorials/gm-world.md (2 hunks)
Files not reviewed due to errors (1)
- tutorials/gm-world.md (no review received)
Additional Context Used
LanguageTool (5)
tutorials/celestia-da.md (2)
Near line 44: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ere are three DA configuration flags we need to provide to thegmd startcommand: - ...
Near line 95: Unpaired symbol: ‘[’ seems to be missing
Context: ...haracters. [Learn more about namespaces](https://docs.celestia.org/developers/no...tutorials/gm-world.md (3)
Near line 61: Consider a shorter alternative to avoid wordiness.
Context: ... script in a new terminal: ::: warning In order to run it you need to have the jq command ...
Near line 137: A comma is probably missing here.
Context: ...1lv8c1FWhLpqP"}' type: local ``` For convenience we export two of our keys like this: `...
Near line 144: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... just want to submit transaction from a high level perspective): ```bash gmd tx bank send...
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/gm-world.md (2 hunks)
Additional Context Used
LanguageTool (3)
tutorials/gm-world.md (3)
Near line 63: Consider a shorter alternative to avoid wordiness.
Context: ... script in a new terminal: ::: warning In order to run it you need to have the jq command ...
Near line 139: A comma is probably missing here.
Context: ...1lv8c1FWhLpqP"}' type: local ``` For convenience we export two of our keys like this: `...
Near line 146: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... just want to submit transaction from a high level perspective): ```bash gmd tx bank send...
Additional comments not posted (2)
tutorials/gm-world.md (2)
2-2: Updated description aligns well with the new focus of the tutorial.
71-71: Change of directory in the installation command is a good practice to ensure scripts are executed in a safe location.
There was a problem hiding this comment.
Actionable comments posted: 6
Out of diff range and nitpick comments (1)
tutorials/celestia-da.md (1)
55-55: Ensure code blocks are surrounded by blank lines for proper Markdown formatting.The code block starting at line 56 should be preceded by a blank line to ensure it is properly formatted in Markdown. This helps in maintaining the readability and structure of the document.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- .vitepress/config.ts (1 hunks)
- tutorials/celestia-da.md (1 hunks)
Files skipped from review due to trivial changes (1)
- .vitepress/config.ts
Additional Context Used
LanguageTool (2)
tutorials/celestia-da.md (2)
Near line 44: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ere are three DA configuration flags we need to provide to thegmd startcommand: - ...
Near line 95: Unpaired symbol: ‘[’ seems to be missing
Context: ...haracters. [Learn more about namespaces](https://docs.celestia.org/developers/no...
Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com>
Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 1
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/celestia-da.md (1 hunks)
Additional Context Used
LanguageTool (2)
tutorials/celestia-da.md (2)
Near line 44: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ere are three DA configuration flags we need to provide to thegmd startcommand: - ...
Near line 95: Unpaired symbol: ‘[’ seems to be missing
Context: ...haracters. [Learn more about namespaces](https://docs.celestia.org/developers/no...
Additional comments not posted (6)
tutorials/celestia-da.md (6)
3-7: Introduction section looks clear and well-structured.
9-17: The section on running a Celestia light node is informative and correctly links to external resources.
21-30: Commands for cleaning previous chain history are correctly formatted and clear.
32-40: Building the rollup section is well-documented with clear instructions.
98-111: The section on running the rollup connected to a Celestia light node is detailed and well-documented.
117-119: The next steps section is motivational and provides a positive conclusion to the tutorial.
There was a problem hiding this comment.
Actionable comments posted: 1
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/celestia-da.md (1 hunks)
Additional Context Used
LanguageTool (2)
tutorials/celestia-da.md (2)
Near line 44: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ere are three DA configuration flags we need to provide to thegmd startcommand: - ...
Near line 95: Unpaired symbol: ‘[’ seems to be missing
Context: ...haracters. [Learn more about namespaces](https://docs.celestia.org/developers/no...
Additional comments not posted (6)
tutorials/celestia-da.md (6)
3-7: Introduction section looks clear and concise.
9-17: The section on running a Celestia light node is well-documented and informative.
21-31: Instructions for cleaning previous chain history are clear and correctly formatted.
32-40: Building the rollup section is well-documented with clear instructions.
98-111: Running the rollup connected to a Celestia light node is well-documented with clear instructions.
117-119: The next steps section is motivational and provides a positive conclusion to the tutorial.
Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 3
Out of diff range and nitpick comments (2)
tutorials/gm-world.md (2)
Line range hint
40-40: Avoid using inline HTML for links.- <a :href="`https://go.dev/dl/go${constants.golangVersion}.windows-amd64.msi`">installer</a>. + [installer](https://go.dev/dl/go${constants.golangVersion}.windows-amd64.msi)Replacing inline HTML with Markdown syntax improves the readability and maintainability of the document.
Line range hint
42-42: Remove unnecessary blank lines to comply with Markdown best practices.- -Reducing multiple consecutive blank lines helps maintain a clean and professional appearance in the document.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- tutorials/celestia-da.md (1 hunks)
- tutorials/gm-world.md (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- tutorials/celestia-da.md
There was a problem hiding this comment.
Actionable comments posted: 3
Out of diff range and nitpick comments (4)
tutorials/gm-world.md (4)
Line range hint
59-59: Consider adding a comma for clarity.- To make it simple we will download a repository with a `gm-world` rollup that has an `init.sh` script that does all the setup for you. + To make it simple, we will download a repository with a `gm-world` rollup that has an `init.sh` script that does all the setup for you.Adding a comma after "simple" improves the readability of the sentence.
Line range hint
63-63: Consider rephrasing to reduce wordiness.- In order to run it you need to have the jq command line tool installed. + To run it, you need to have the jq command line tool installed.This change makes the instruction more concise and direct.
Line range hint
140-140: Add a comma for clarity.- For convenience we export two of our keys like this: + For convenience, we export two of our keys like this:Adding a comma after "convenience" improves the readability of the instruction.
Line range hint
147-147: Add an article for grammatical correctness.- we just want to submit transaction from a high level perspective + we just want to submit a transaction from a high level perspectiveAdding "a" before "transaction" corrects the grammatical structure of the sentence.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/gm-world.md (2 hunks)
Additional Context Used
LanguageTool (5)
tutorials/gm-world.md (5)
Near line 59: Possible missing comma found.
Context: ...are your rollup blockchain. To make it simple we will download a repository with a `g...
Near line 63: Consider a shorter alternative to avoid wordiness.
Context: ... script in a new terminal: ::: warning In order to run it you need to have the jq command ...
Near line 140: A comma is probably missing here.
Context: ...1lv8c1FWhLpqP"}' type: local ``` For convenience we export two of our keys like this: `...
Near line 147: Possible missing article found.
Context: ... flags, for now, we just want to submit transaction from a high level perspective): ```bas...
Near line 147: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... just want to submit transaction from a high level perspective): ```bash gmd tx bank send...
Additional comments not posted (1)
tutorials/gm-world.md (1)
75-75: LGTM! Clear and concise section title for starting the rollup.
There was a problem hiding this comment.
Actionable comments posted: 0
Out of diff range and nitpick comments (4)
tutorials/gm-world.md (4)
Line range hint
146-146: If this is a compound adjective that modifies the following noun, use a hyphen.- just want to submit transaction from a high level perspective + just want to submit transaction from a high-level perspective
Line range hint
139-139: A comma is probably missing here.- For convenience we export two of our keys like this + For convenience, we export two of our keys like this:
Line range hint
59-59: Consider adding a comma for clarity.- To make it simple we will download a repository with a `gm-world` rollup + To make it simple, we will download a repository with a `gm-world` rollup
Line range hint
63-63: Consider a shorter alternative to avoid wordiness.- In order to run it you need to have the jq command line tool installed. + To run it, you need to have the jq command line tool installed.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- tutorials/gm-world.md (2 hunks)
Additional Context Used
LanguageTool (4)
tutorials/gm-world.md (4)
Near line 59: Possible missing comma found.
Context: ...are your rollup blockchain. To make it simple we will download a repository with a `g...
Near line 63: Consider a shorter alternative to avoid wordiness.
Context: ... script in a new terminal: ::: warning In order to run it you need to have the jq command ...
Near line 139: A comma is probably missing here.
Context: ...1lv8c1FWhLpqP"}' type: local ``` For convenience we export two of our keys like this: `...
Near line 146: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ... just want to submit transaction from a high level perspective): ```bash gmd tx bank send...
Additional comments not posted (4)
tutorials/gm-world.md (4)
2-2: Update the description to match the terminology used in the tutorial.- description: Build a sovereign rollup using only Rollkit CLI and a mock DA network. + description: Build a sovereign rollup using only Rollkit CLI and a mocked DA network.This change aligns the description with the terminology used consistently throughout the document, enhancing clarity and consistency.
5-5: Ensure the section title is consistent with the document's focus.- # GM world rollup + # GM World RollupCapitalizing "World" in the section title maintains consistency and formality in document headings.
71-71: Ensure consistent directory navigation.- cd $HOME && bash -c "$(curl -sSL https://rollkit.dev/install-gm-rollup.sh)" + cd $HOME + bash -c "$(curl -sSL https://rollkit.dev/install-gm-rollup.sh)"Splitting the command into two lines improves readability and makes it clear that changing the directory is a separate step from executing the script.
74-74: LGTM! The detailed logs and flags provide valuable insights into the rollup's operation.
* Add celestia-da tutorial, network agnostic * Update vitepress config * Add link to /guides/gas-price * Update tutorials/celestia-da.md Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Update tutorials/celestia-da.md Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update tutorials/celestia-da.md * Update tutorials/celestia-da.md * Update tutorials/celestia-da.md * Apply suggestions from code review * Apply suggestions from code review * Update tutorials/gm-world.md Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Remove sudo, we install gmd, no need to use sudo now * docs: use 1 line for install instead of 2 --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
* Update gm frontend tutorial * Update gm world tutorial: use bash and which * Add celestia-da tutorial, network agnostic (#368) * Add celestia-da tutorial, network agnostic * Update vitepress config * Add link to /guides/gas-price * Update tutorials/celestia-da.md Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Update tutorials/celestia-da.md Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update tutorials/celestia-da.md * Update tutorials/celestia-da.md * Update tutorials/celestia-da.md * Apply suggestions from code review * Apply suggestions from code review * Update tutorials/gm-world.md Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Remove sudo, we install gmd, no need to use sudo now * docs: use 1 line for install instead of 2 --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Node and yarn versions as constants, custom script to install yarn and node * Add brew bin to $PATH * Minor updates to jq and go installation scripts * Update public/install-jq.sh Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Use bash-vue * Use bash instead of sh, yes, it's opinionated * Add screenshot with connected wallet * Uppercase yarn and nodejs Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Exit if curl is not installed * docs: add vA callout back * fix: image linking, err in runtime * docs: standard sentence case capitalization * feat: remove now unused images * Apply suggestions from code review * Update tutorials/gm-world-frontend.md --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Yarik Bratashchuk <ybratashchuk@yblocal.local> Co-authored-by: jcstein <mail@jcstein.dev>
* Update gm frontend tutorial * Update gm world tutorial: use bash and which * Add celestia-da tutorial, network agnostic (#368) * Add celestia-da tutorial, network agnostic * Update vitepress config * Add link to /guides/gas-price * Update tutorials/celestia-da.md Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Update tutorials/celestia-da.md Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update tutorials/celestia-da.md * Update tutorials/celestia-da.md * Update tutorials/celestia-da.md * Apply suggestions from code review * Apply suggestions from code review * Update tutorials/gm-world.md Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> * Remove sudo, we install gmd, no need to use sudo now * docs: use 1 line for install instead of 2 --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Node and yarn versions as constants, custom script to install yarn and node * Add brew bin to $PATH * Updates to Wordle tutorial: - Update links to Cosmos SDK docs - Remove Celestia DA from script and steps - Add "Next Steps" section pointing to Celestia DA * Fix Next Steps wording Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Update tutorials/gm-world-frontend.md * fix: add backticks * Update tutorials/wordle.md * Apply suggestions from code review --------- Co-authored-by: joshcs.eth <46639943+jcstein@users.noreply.github.com> Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: Yarik Bratashchuk <ybratashchuk@yblocal.local> Co-authored-by: jcstein <mail@jcstein.dev>
Summary by CodeRabbit