Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add gasprice to menu and update tutorial overview page #330

Merged
merged 1 commit into from
Mar 19, 2024

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Mar 19, 2024

Overview

  1. add new gasprice doc to menu
  2. updates tutorial overview page with new tutorial structure

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

Summary by CodeRabbit

  • New Features
    • Added a new guide on configuring gas price in the "Guides" section.
    • Expanded the "GM world rollup" tutorial into three parts covering local devnet, testnet, and mainnet.
    • Introduced a new tutorial on IBC connection.

@jcstein jcstein requested a review from gupadhyaya March 19, 2024 14:22
@jcstein jcstein self-assigned this Mar 19, 2024
Copy link
Contributor

coderabbitai bot commented Mar 19, 2024

Walkthrough

The recent update enriches the documentation with a new sidebar item on configuring gas prices and expands the "GM world rollup" tutorial into three distinct parts, catering to local devnet, testnet, and mainnet environments. Additionally, it introduces a fresh tutorial on establishing IBC connections and offers practical advice on gas price configuration, enhancing both the depth and breadth of the learning materials provided.

Changes

File(s) Change Summary
.vitepress/config.ts Added "How to configure gas price" in the "Guides" sidebar section.
tutorials/overview.md Expanded "GM world rollup" into three parts for different environments; added an IBC connection tutorial and gas price configuration guide.

🐰✨
In the land of code and byte,
A rabbit hops through day and night.
Expanding knowledge, wide and deep,
Through rollups, gas, and blockchains steep.
With every hop, a guide more clear,
To help you code without fear.
🚀🌌

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

Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

github-actions bot commented Mar 19, 2024

PR Preview Action v1.4.7
Preview removed because the pull request was closed.
2024-03-19 14:26 UTC

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 88fb079 and b074f9a.
Files selected for processing (2)
  • .vitepress/config.ts (1 hunks)
  • tutorials/overview.md (1 hunks)
Additional comments: 4
tutorials/overview.md (3)
  • 20-22: The addition of "GM world rollup: Part 1, local devnet", "Part 2, testnet", and "Part 3, mainnet" effectively splits the tutorial into three distinct sections, catering to different deployment environments. This structured approach enhances the learning experience by providing targeted content for each stage of development.
  • 30-30: The introduction of the "IBC connection" tutorial under the Intermediate section is a valuable addition, expanding the educational scope to include critical aspects of inter-blockchain communications. This aligns with the objective of broadening the learning materials to cover more complex topics.
  • 35-35: Adding the "How to configure gas price" guide under the Guides section is a practical and necessary inclusion, addressing a crucial aspect of blockchain interaction. This guide will likely be beneficial for users looking to manage transaction costs and efficiencies within the project's context.
.vitepress/config.ts (1)
  • 227-227: The addition of the "How to configure gas price" guide to the sidebar under the "Guides" section is correctly implemented. This change ensures that the new documentation piece is accessible from the project's sidebar navigation, aligning with the PR's objectives to enhance the documentation framework.

@gupadhyaya gupadhyaya merged commit 9f02d99 into main Mar 19, 2024
4 checks passed
@gupadhyaya gupadhyaya deleted the jcs/update-menu-and-gas-price branch March 19, 2024 14:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants