feat: mention artela specific stuff when running full node and connecting m…

yarikbratashchuk commented 6 days ago

Summary by CodeRabbit

New Features
- Updated documentation for setting up a full node in a Rollkit-based blockchain network.
- Added Docker usage instructions for the Artela EVM++ setup.
Improvements
- Enhanced clarity and readability of guides with specific commands and configuration details.
- Included tips for resolving common issues during setup, particularly for EVM clients.
- Expanded instructions for accessing testing accounts and building on EVM++.
Documentation
- Retained essential instructions while refining existing content for better user guidance.
- Removed outdated tutorial link from the navigation structure for improved user experience.

coderabbitai[bot] commented 6 days ago

Walkthrough

The changes involve updates to two documentation files: guides/full-node.md and tutorials/artela-evm-plus-plus.md. The full-node.md file now includes clearer instructions for setting up a full node in a Rollkit-based blockchain, with modifications to configuration paths and initialization commands. The artela-evm-plus-plus.md file provides enhanced clarity on using Docker, accessing testing accounts, and modifying runtime parameters, along with improved structure and readability.

Changes

File	Change Summary
guides/full-node.md	Updated instructions for full node setup, changed config path, specified initialization command, added notes on P2P connection and EVM error handling.
tutorials/artela-evm-plus-plus.md	Enhanced clarity on Docker usage, expanded access to testing accounts, refined configuration steps, and improved document structure.
.vitepress/config.ts	Removed entry for "Omni Octane EVM" tutorial link, added SVG definition for Telegram icon.

Possibly related PRs

#406: This PR updates the init_full_node script and the full_and_sequencer_node guide, which are directly related to the setup of a full node, similar to the changes made in the main PR regarding the full node setup instructions.
#462: This PR introduces a comprehensive guide for setting up a full node in a Rollkit-based blockchain network, which aligns closely with the changes made in the main PR that also focuses on enhancing the full node setup documentation.
#481: Although this PR focuses on updating a tutorial to use a quick start approach, it may relate to the overall context of improving user guidance in setting up nodes, similar to the main PR's objectives.

Suggested labels

documentation

Suggested reviewers

gupadhyaya
MSevey
jcstein
Manav-Aggarwal

🐇 In the land of code where changes bloom,
Full nodes now thrive, dispelling the gloom.
With Docker and paths all laid out clear,
Setting up nodes brings us all cheer!
So hop along, dear coder friends,
To Rollkit's embrace, where the fun never ends! 🌼

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 , please review it.` - `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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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](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://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) 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 days ago

PR Preview Action v1.4.8 :---: :rocket: Deployed preview to https://rollkit.github.io/docs-preview/./pr-504/ on branch main at 2024-11-18 16:39 UTC

rollkit / docs