docs: add evm mainnet integrations cheat sheet #117
Conversation
Signed-off-by: Brendan Graetz <[email protected]>
WalkthroughAdded a new EVM Integrations Cheatsheet markdown file and updated the documentation table of contents to include a link to that cheat sheet under EVM Developers. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (1)
.gitbook/developers-evm/integrations-cheat-sheet-evm.md (1)
100-100: Resolve TODO markers before merge.The
<!-- TODO img -->and<!-- TODO image -->comments indicate incomplete work. Clarify the intention: should these be placeholders for screenshot assets, or should the instructions be refined?Before merging, please either:
- Add the referenced image/screenshot asset, or
- Remove the TODO and finalize the instructions as-is, or
- Link to an existing screenshot resource if available.
Also applies to: 109-109
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.gitbook/SUMMARY.md(1 hunks).gitbook/developers-evm/integrations-cheat-sheet-evm.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.gitbook/developers-evm/integrations-cheat-sheet-evm.md
[grammar] ~76-~76: Use a hyphen to join words.
Context: ...rammatic control, e.g. application/ DApp operated accounts. Installation quick s...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
.gitbook/developers-evm/integrations-cheat-sheet-evm.md
29-29: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
29-29: Hard tabs
Column: 1
(MD010, no-hard-tabs)
30-30: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
30-30: Hard tabs
Column: 1
(MD010, no-hard-tabs)
31-31: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
31-31: Hard tabs
Column: 1
(MD010, no-hard-tabs)
32-32: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
32-32: Hard tabs
Column: 1
(MD010, no-hard-tabs)
33-33: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
33-33: Hard tabs
Column: 1
(MD010, no-hard-tabs)
34-34: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
34-34: Hard tabs
Column: 1
(MD010, no-hard-tabs)
36-36: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
36-36: Hard tabs
Column: 1
(MD010, no-hard-tabs)
37-37: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
37-37: Hard tabs
Column: 1
(MD010, no-hard-tabs)
38-38: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
38-38: Hard tabs
Column: 1
(MD010, no-hard-tabs)
39-39: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
39-39: Hard tabs
Column: 1
(MD010, no-hard-tabs)
40-40: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
40-40: Hard tabs
Column: 1
(MD010, no-hard-tabs)
41-41: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
41-41: Hard tabs
Column: 1
(MD010, no-hard-tabs)
101-101: Multiple headings with the same content
(MD024, no-duplicate-heading)
🔇 Additional comments (2)
.gitbook/developers-evm/integrations-cheat-sheet-evm.md (1)
1-90: Overall structure and content look good.The cheatsheet provides clear organization and comprehensive coverage of key integration points (network config, explorers, RPC endpoints, contract addresses, bridges, wallets, and oracles). The deprecation notes for InEVM are helpful, and references to canonical documentation are well-placed.
Address the formatting and duplication issues flagged above, and the document will be ready.
Also applies to: 110-131
.gitbook/SUMMARY.md (1)
138-138: Table of contents entry is well-positioned and correctly formatted.The new "EVM Integrations Cheatsheet" entry is properly placed in the EVM Developers section with correct path reference and formatting. The placement after "EVM Network Information" makes logical sense.
Signed-off-by: Brendan Graetz <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
.gitbook/developers-evm/integrations-cheat-sheet-evm.md (1)
28-41: Hard tabs and indentation issues remain unfixed from previous review.Static analysis continues to flag hard tabs (MD010) and incorrect list indentation (MD007) in the RPC Endpoints section. This was previously raised and needs to be corrected—replace all hard tabs with spaces and use consistent 2-space indentation for top-level list items and 4-space for nested items as per Markdown standards.
🧹 Nitpick comments (1)
.gitbook/developers-evm/integrations-cheat-sheet-evm.md (1)
3-3: Minor: Improve formatting of slash-separated items.The line uses "build/ deploy/ integrate" with spaces after slashes. Consider using a more consistent format such as "build/deploy/integrate" or the more readable "build, deploy, or integrate" for better readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
.gitbook/.gitbook/assets/blockscout-add-injective-button.pngis excluded by!**/*.png
📒 Files selected for processing (1)
.gitbook/developers-evm/integrations-cheat-sheet-evm.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.18.1)
.gitbook/developers-evm/integrations-cheat-sheet-evm.md
29-29: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
29-29: Hard tabs
Column: 1
(MD010, no-hard-tabs)
30-30: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
30-30: Hard tabs
Column: 1
(MD010, no-hard-tabs)
31-31: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
31-31: Hard tabs
Column: 1
(MD010, no-hard-tabs)
32-32: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
32-32: Hard tabs
Column: 1
(MD010, no-hard-tabs)
33-33: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
33-33: Hard tabs
Column: 1
(MD010, no-hard-tabs)
34-34: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
34-34: Hard tabs
Column: 1
(MD010, no-hard-tabs)
36-36: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
36-36: Hard tabs
Column: 1
(MD010, no-hard-tabs)
37-37: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
37-37: Hard tabs
Column: 1
(MD010, no-hard-tabs)
38-38: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
38-38: Hard tabs
Column: 1
(MD010, no-hard-tabs)
39-39: Unordered list indentation
Expected: 2; Actual: 1
(MD007, ul-indent)
39-39: Hard tabs
Column: 1
(MD010, no-hard-tabs)
40-40: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
40-40: Hard tabs
Column: 1
(MD010, no-hard-tabs)
41-41: Unordered list indentation
Expected: 4; Actual: 2
(MD007, ul-indent)
41-41: Hard tabs
Column: 1
(MD010, no-hard-tabs)
101-101: Multiple headings with the same content
(MD024, no-duplicate-heading)
🔇 Additional comments (2)
.gitbook/developers-evm/integrations-cheat-sheet-evm.md (2)
76-76: Verify semantic intent of grammar change on line 76.The line was changed from "application/ DApp operated accounts" to "application or dApp-operated accounts." While the hyphenation is now correct, the semantic meaning has shifted from "application/DApp" (both) to "application or dApp" (either/or). Confirm this change is intentional, or revert to "application/DApp-operated accounts" if both were meant.
92-102: MetaMask duplication has been resolved.The duplicate MetaMask section previously flagged has been removed, and a single complete section with the image reference remains. This change looks good.
Summary by CodeRabbit