rollkit / docs

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

docs: add range rollkit guide #353

Closed aesmonty closed 6 months ago

aesmonty commented 6 months ago

Overview

Adding the guide to integrate Range with your rollup.

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 6 months ago

Walkthrough

The recent updates bring enhancements to navigation and functionality in the documentation. These changes include improving markdown navigation through link updates, introducing a new guide on integrating Range with rollups, and providing Rollkit developers with a comprehensive monitoring guide using the Range platform.

Changes

File Path Change Summary
guides/full-and-sequencer-node.md
guides/overview.md
Updated link references for improved navigation.
Added a guide on integrating Range with rollups.
guides/rollkit-monitoring.md New guide for Rollkit developers to monitor rollup activity efficiently using the Range platform.

🐇✨ In the docs, a change does sprout, Where links and guides twist about. A rabbit hops, with glee, no doubt, For knowledge paths are clear, throughout! 🌟📜


Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between f79f4bee32d47bf46af8a4947b1450b90bb1d8dd and e1543184dd9d89b1d821550cdc6171a4f6660e86.
Files selected for processing (1) * guides/rollkit-monitoring.md (1 hunks)
Additional Context Used
LanguageTool (17)
guides/rollkit-monitoring.md (17)
Near line 1: Possible spelling mistake found. Context: # How to integrate Range with your rollup This section illustrates how Rollkit d... --- Near line 3: Possible spelling mistake found. Context: ...ur rollup This section illustrates how Rollkit developers can leverage the Range platf... --- Near line 3: Possible spelling mistake found. Context: ...age the Range platform to monitor their rollup activity and explore relevant addresses... --- Near line 7: Possible spelling mistake found. Context: ... steps of the integration of our sample rollup GM, which is divided into three section... --- Near line 9: Possible spelling mistake found. Context: ...to three sections: 1. **Integrate your rollup with Range and start the indexing.** 2.... --- Near line 15: Possible spelling mistake found. Context: ...isites You need to have an operational rollkit rollup. If you haven't done so, you'll ... --- Near line 15: Possible spelling mistake found. Context: ...You need to have an operational rollkit rollup. If you haven't done so, you'll need to... --- Near line 17: Possible spelling mistake found. Context: ... tutorial first. ### 1. Integrate Your Rollup We’ll integrate our rollup GM into Ran... --- Near line 19: Possible spelling mistake found. Context: ...egrate Your Rollup We’ll integrate our rollup GM into Range and start indexing blocks... --- Near line 25: Unpaired symbol: ‘]’ seems to be missing Context: ...ng) #### Steps - Create an account in [Range](https://app.range.org) - Make sur... --- Near line 26: Possible spelling mistake found. Context: ... you have a public RPC endpoint of your Rollkit rollup - Go to the settings tab on your... --- Near line 26: Possible spelling mistake found. Context: ...e a public RPC endpoint of your Rollkit rollup - Go to the settings tab on your accoun... --- Near line 29: Possible spelling mistake found. Context: ... in the Custom Network section - Choose Rollkit and fill out the form - Congrats! Your ... --- Near line 30: Possible spelling mistake found. Context: ... and fill out the form - Congrats! Your rollup should be integrated in Range in less t... --- Near line 34: Possible spelling mistake found. Context: ... Addresses and Contracts Now that your rollup is integrated into Range, you can custo... --- Near line 42: Possible spelling mistake found. Context: ...specific events or transactions in your rollup. As an example, we can create an alert ... --- Near line 56: Possible spelling mistake found. Context: ... first monitored transaction in your GM rollup.
Additional comments not posted (3)
guides/rollkit-monitoring.md (3)
`13-15`: Ensure there is a blank line above the "Prerequisites" heading for better readability. --- `23-23`: Ensure there is a blank line above the "Steps" subheading for consistency and readability. --- `32-34`: Surround the list with blank lines for better markdown formatting.
--- 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.