Typo fixes and updates to block-time guide

[yarikbratashchuk]

Summary by CodeRabbit

• Documentation
  • Updated documentation to reflect changes in the command for starting a blockchain node from gmd to rollkit.
  • Revised example commands for better clarity and accuracy, including adjustments to block time settings.

[github-actions]

PR Preview Action v1.4.7
🚀 Deployed preview to https://rollkit.github.io/docs-preview/./pr-430/
on branch main at 2024-08-16 10:24 UTC

[coderabbitai]

Walkthrough

The documentation for starting a blockchain node has been updated to reflect a new command interface. Users are now instructed to use rollkit start [args...] instead of the previous gmd command. Additionally, the example for setting block times has been clarified, changing from 0.1ms to 100ms for sub-second configurations. These changes aim to improve user understanding and streamline the command structure for configuring block times in the blockchain environment.

Changes

Files	Change Summary
guides/block-times.md	Changed command from gmd start [args...] to rollkit start [args...]. Updated block time argument from --rollkit.block_time 0.1ms to --rollkit.block_time 100ms.

Poem

🐇 In the land of blocks and time,
The commands have changed, oh what a rhyme!
Rollkit now leads the way,
Guiding us through the blockchain play.
With clearer paths, let’s hop along,
Embracing the change, where we belong! 🌟

---

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
• Mastodon
• Reddit
• LinkedIn

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 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.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d235497 and 2947c4c.

Files selected for processing (1)

• guides/block-times.md (3 hunks)

Additional comments not posted (3)

guides/block-times.md (3)

7-7: LGTM! Command update is clear and consistent.

The change from gmd to rollkit accurately reflects the new command interface for starting a blockchain node.

---

22-23: Example command update is clear and correctly formatted.

The example commands using rollkit start [existing flags...] are clear and accurately demonstrate the new command structure.

---

36-36: Block time example update is clear and consistent.

The change to --rollkit.block_time 100ms provides a clearer example for sub-second block times.