rollkit / docs

Documentation for Rollkit - a modular framework for rollups.
https://rollkit.dev
34 stars 49 forks source link

fix: missing space in heading in gm-world.md #364

Closed jcstein closed 6 months ago

jcstein commented 6 months ago

Overview

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The update involves a simple yet precise adjustment in the tutorial document for GM World Rollup. It corrects the spacing in the heading of the introduction section, ensuring that the emoji and the word "Introduction" are properly separated for better readability and aesthetics.

Changes

File Path Change Summary
tutorials/.../gm-world.md Corrected spacing in the introduction heading.

🐇✨ A tiny space we add, Between icons and words so glad. In tutorials, we hop and tweak, For clarity that all do seek. 🌞 Now shines bright, with space just right!


Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between ef5dfe1d5ebbd5b88df77c8a59e008654a1b7214 and 74072c441b8f390e88d6084d2fb4fea0bc6e7067.
Files selected for processing (1) * tutorials/gm-world.md (1 hunks)
Additional Context Used
LanguageTool (26)
tutorials/gm-world.md (26)
Near line 5: Possible spelling mistake found. Context: ...ocally and on a testnet --- # GM World Rollup ## 🌞 Introduction {#introduction} Th... --- Near line 9: Possible spelling mistake found. Context: ...through building a sovereign `gm-world` rollup (`gm` stands for "good morning") using ... --- Near line 9: Possible spelling mistake found. Context: ... (`gm` stands for "good morning") using Rollkit. Unlike the [quick start guide](https:/... --- Near line 9: Possible spelling mistake found. Context: ...cal approach to understanding sovereign rollup development. We will cover: - Buildin... --- Near line 13: Possible spelling mistake found. Context: ...uring a Cosmos-SDK application-specific rollup blockchain. - Posting rollup data to a ... --- Near line 14: Possible spelling mistake found. Context: ...n-specific rollup blockchain. - Posting rollup data to a Data Availability (DA) networ... --- Near line 30: Possible spelling mistake found. Context: ...> ## 🛠️ Dependencies {#dependencies} Rollkit uses the [Go programming language](http... --- Near line 53: Possible spelling mistake found. Context: ...`7980`. ## 🏗️ Building Your Sovereign Rollup {#building-your-sovereign-rollup} With... --- Near line 55: Possible spelling mistake found. Context: ... DA network running, let’s prepare your rollup blockchain. To make it simple we will ... --- Near line 57: Possible missing comma found. Context: ...are your rollup blockchain. To make it simple we will download a repository with a `g... --- Near line 57: Possible spelling mistake found. Context: ...download a repository with a `gm-world` rollup that has an `init.sh` script that does ... --- Near line 59: Possible spelling mistake found. Context: ...r you. Download and build a `gm-world` rollup with an interactive script in a new ter... --- 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 62: Possible missing comma found. Context: ... terminal: ::: warning In order to run it you need to have the jq command line to... --- Near line 62: Possible spelling mistake found. Context: ...In order to run it you need to have the jq command line tool installed. You can in... --- Near line 62: Possible spelling mistake found. Context: ...nstalled. You can install it by running `sudo apt-get install jq` on Ubuntu or `brew install jq` on macO... --- Near line 62: Possible spelling mistake found. Context: ... `sudo apt-get install jq` on Ubuntu or `brew install jq` on macOS. ::: ::: tip If you get error... --- Near line 65: Possible spelling mistake found. Context: ...macOS. ::: ::: tip If you get errors of `gmd` not found, you may need to add the `go... --- Near line 72: Possible spelling mistake found. Context: ...rollup.sh | sh ``` ## 🚀 Starting Your Rollup {#start-your-rollup} Start the rollup,... --- Near line 74: Possible spelling mistake found. Context: ... Rollup {#start-your-rollup} Start the rollup, posting to the local DA network: ```b... --- Near line 110: Possible spelling mistake found. Context: ...ex ... ``` Good work so far, we have a Rollup node, DA network node, now we can start... --- 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: Possible missing article found. Context: ... flags, for now, we just want to submit transaction from a high level perspective): ```bas... --- 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... --- Near line 177: This sentence does not start with an uppercase letter. Context: ...m and sign the transaction as prompted. now you see the transaction hash at the out... --- Near line 223: Possible spelling mistake found. Context: ... Congratulations! You've built a local rollup that posts to a local DA network. So fa...
Additional comments not posted (1)
tutorials/gm-world.md (1)
`7-7`: LGTM! The added space improves the markdown formatting and readability.
--- 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?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
github-actions[bot] commented 6 months ago

PR Preview Action v1.4.7 :---: Preview removed because the pull request was closed. 2024-05-05 05:01 UTC