feat: mention artela specific stuff when running full node and connecting m… #504
Conversation
WalkthroughThe changes involve updates to three documentation files: Changes
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
yarikbratashchuk
changed the title
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (3)
guides/full-node.md (1)
85-85: Fix grammatical and spelling issues in the tip section.The tip provides valuable operational guidance, but there are some minor issues to address.
Apply this diff to fix the issues:
-If your rollup uses EVM as an execution layar and you see an error like `datadir already used by another process`, it means you have to remove all the state from rollup data directory (`/root/.yourrollup_fn/data/`) and specify a different data directory for the EVM client. Preferrably to run a full node on a different machine, as some EVM clients does not have a configurable data directory. +If your rollup uses EVM as an execution layer, and you see an error like `datadir already used by another process`, it means you have to remove all the state from rollup data directory (`/root/.yourrollup_fn/data/`) and specify a different data directory for the EVM client. Preferably run a full node on a different machine, as some EVM clients do not have a configurable data directory.🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ur rollup uses EVM as an execution layar and you see an error like `datadir already ...(COMMA_COMPOUND_SENTENCE)
tutorials/artela-evm-plus-plus.md (2)
Line range hint
24-27: Enhance Docker prerequisites section.Consider adding more specific details about host network mode requirements and potential issues users might encounter.
Add a note explaining:
- Why host network mode is required
- Common issues and their solutions
- Platform-specific requirements (Windows/Mac/Linux)
🧰 Tools
🪛 Markdownlint
106-106: null
Bare URL used(MD034, no-bare-urls)
Line range hint
71-82: Add examples of common configuration changes.The configuration section could be more helpful with examples of frequently modified parameters.
Consider adding:
- Common runtime parameters that users might want to modify
- Example configurations for different use cases
- Best practices for configuration changes
🧰 Tools
🪛 Markdownlint
106-106: null
Bare URL used(MD034, no-bare-urls)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
guides/full-node.md(1 hunks)tutorials/artela-evm-plus-plus.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
guides/full-node.md
[uncategorized] ~85-~85: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ur rollup uses EVM as an execution layar and you see an error like `datadir already ...
(COMMA_COMPOUND_SENTENCE)
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (2)
guides/full-node.md (2)
85-85: Consider adding Docker configuration example.Since Docker is recommended as a solution, it would be helpful to provide a basic Docker configuration example or link to Docker-specific setup instructions. This would make it easier for users to follow the recommended approach.
Would you like me to help draft a Docker configuration example section?
🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ur rollup uses EVM as an execution layar and you see an error like `datadir already ...(COMMA_COMPOUND_SENTENCE)
85-85: Fix grammatical and spelling issues.Please correct the following issues in the tip section:
- "layar" → "layer"
- "Preferrably" → "Preferably"
- Add a comma before "and" in the compound sentence
Here's the corrected text:
-If your rollup uses EVM as an execution layar and you see an error like `datadir already used by another process`, it means you have to remove all the state from rollup data directory (`/root/.yourrollup_fn/data/`) and specify a different data directory for the EVM client. Preferrably to run a full node on a different machine (or using Docker), as some EVM clients does not have a configurable data directory. +If your rollup uses EVM as an execution layer, and you see an error like `datadir already used by another process`, it means you have to remove all the state from rollup data directory (`/root/.yourrollup_fn/data/`) and specify a different data directory for the EVM client. Preferably run a full node on a different machine (or using Docker), as some EVM clients do not have a configurable data directory.🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ur rollup uses EVM as an execution layar and you see an error like `datadir already ...(COMMA_COMPOUND_SENTENCE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (2)
.vitepress/config.ts(0 hunks)guides/full-node.md(1 hunks)
💤 Files with no reviewable changes (1)
- .vitepress/config.ts
🧰 Additional context used
🪛 LanguageTool
guides/full-node.md
[uncategorized] ~85-~85: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ur rollup uses EVM as an execution layar and you see an error like `datadir already ...
(COMMA_COMPOUND_SENTENCE)
🔇 Additional comments (1)
guides/full-node.md (1)
Line range hint 15-19: LGTM! Good separation of data directories.
The change to use a distinct configuration directory for the full node (_fn suffix) helps prevent conflicts between the sequencer and full node data, which is a good practice.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~85-~85: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ur rollup uses EVM as an execution layar and you see an error like `datadir already ...
(COMMA_COMPOUND_SENTENCE)
Summary by CodeRabbit
New Features
Improvements
Documentation