Update internal links to use relative paths #958
Conversation
WalkthroughThe document "Running an OP Mainnet Node from Source" has been updated to reflect significant changes in the SSD capacity requirements for running OP Mainnet nodes as of October 2024. Full nodes now require approximately 1.6TB of storage, with an increase of about 1TB every six months, while archive nodes require approximately 5TB, maintaining an increase of 3TB every six months. Additionally, links within the document have been updated for accuracy, particularly regarding Geth's "freezer" feature and configuration details. The tutorial's overall structure remains intact. Changes
Possibly related PRs
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous 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
Documentation and Community
|
✅ Deploy Preview for docs-optimism ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (3)
pages/builders/node-operators/tutorials/mainnet.mdx (3)
39-39: LGTM: Updated documentation linksThe addition of links to both Geth and OP documentation provides valuable resources for users. The use of a relative link for the OP documentation is correct.
Consider using title case for the link text to adhere to the coding guidelines:
-See [Geth docs](https://geth.ethereum.org/docs/fundamentals/databases) and [OP docs](../configuration/execution-config#datadirancient) for details. +See [Geth Docs](https://geth.ethereum.org/docs/fundamentals/databases) and [OP Docs](../configuration/execution-config#datadirancient) for details.
Line range hint
201-251: LGTM: Added Snap Sync verification detailsThe new subsection on Snap Sync verification is a valuable addition to the tutorial. It provides detailed information about the synchronization process and expected log outputs, which will be helpful for users.
Consider adding a brief explanation of what Snap Sync is and why it's the default option for better context:
#### Snap Sync (Default) +Snap Sync is a faster synchronization method that downloads the latest state directly. It's the default option because it significantly reduces the time required to sync a new node. Initial synchronization can take several hours to complete. You will see these `op-node` logs at the start of snap sync:
Line range hint
253-320: LGTM: Updated Archive Nodes setup instructionsThe updates to the Archive Nodes section provide more detailed and up-to-date information for setting up archive nodes. The use of relative links and step-by-step instructions enhances the usability of the tutorial.
Consider adding a note about the time required for extracting large database snapshots:
{<h3>Extract the Data Directory</h3>} Once you've downloaded the database snapshot, you'll need to extract it to a directory on your machine. - This will take some time to complete. + This process can take several hours to complete, depending on your system's performance. ```bash tar xvf <filename></blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: .coderabbit.yaml** **Review profile: CHILL** <details> <summary>📥 Commits</summary> Files that changed from the base of the PR and between 0be241dfa5ae0f0abad5ecdbf191668179e91d7a and 38d49bf7b8bc2d1f3f6a2b00be9862430ded0912. </details> <details> <summary>📒 Files selected for processing (1)</summary> * pages/builders/node-operators/tutorials/mainnet.mdx (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>📓 Path-based instructions (1)</summary><blockquote> <details> <summary>pages/builders/node-operators/tutorials/mainnet.mdx (1)</summary> Pattern `**/*.mdx`: "ALWAYS review Markdown content THOROUGHLY with the following criteria: - Use proper nouns in place of personal pronouns like 'We' and 'Our' to maintain consistency in communal documentation. - Avoid gender-specific language and use the imperative form. - Monitor capitalization for emphasis. Use **bold** for prominence instead of all caps or italics. - Ensure proper nouns are capitalized in sentences. - Apply the Oxford comma. - Use proper title case for headers, buttons, tab names, page names, and links. Sentence case should be used for body content and short phrases, even in links. - Use correct spelling and grammar at all times (IMPORTANT). " </details> </blockquote></details> </details> <details> <summary>🔇 Additional comments (2)</summary><blockquote> <details> <summary>pages/builders/node-operators/tutorials/mainnet.mdx (2)</summary><blockquote> `31-34`: **LGTM: Updated storage requirements** The storage requirements for full and archive nodes have been accurately updated with the latest information as of October 2024. The use of bold for emphasis and the clear presentation of data adhere to the coding guidelines. --- Line range hint `43-46`: **LGTM: Added Blob Archiver assessment section** The new section on assessing the need for a blob archiver service is a valuable addition to the tutorial. It provides important information for node operators and uses a relative link to the documentation, adhering to the coding guidelines. </blockquote></details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
hash1go
changed the title
Description
Tests
Additional context
Metadata