docs: update quick-sync

[qubelabsio]

Overview

Checklist

• New and updated code has appropriate documentation
• New and updated code has new and/or updated testing
• Required CI checks are passing
• Visual proof for any user facing features like CLI or documentation updates
• Linked issues closed with keywords

Summary by CodeRabbit

• Refactor
  • Updated the method for downloading and extracting snapshots in the consensus node documentation to use aria2c, enhancing the efficiency of the process.
• Documentation
  • Added aria2 to the list of packages installed via apt and yum commands in the environment setup documentation.

[coderabbitai]

Walkthrough

The update introduces a new method for handling snapshot files in the consensus node documentation, shifting from wget to aria2c for the download process and specifying a new extraction technique. This enhancement aims to streamline the process, potentially offering a more efficient and reliable way to manage snapshot files.

Changes

File Path	Change Summary
nodes/consensus-node.md	Updated to use aria2c for downloading and extracting snapshots.

🐇✨
In the land of code and byte,
Where changes dance in the light,
A rabbit hops with delight,
For efficiency takes flight.
🚀🌌

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between a60eef4 and e277817.

Files selected for processing (1)

• nodes/consensus-node.md (3 hunks)

Additional comments: 3

nodes/consensus-node.md (3)

• 280-281: The use of aria2c with -x 16 -s 16 options for parallel downloads is a good improvement over wget for efficiency. However, ensure the server supports this level of parallelism to avoid potential issues with the download process.
• 290-291: Similar to the previous comment, the use of aria2c is approved for the Mocha network. It's important to verify that the snapshot server can handle the specified number of connections.
• 300-301: The use of aria2c for the Arabica network follows the same pattern as for the other networks. Ensure compatibility and server support for the specified parallel download options.

[jcstein]

• update other instances of wget
• replace wget with aria2c as a dependency in environment setup

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between e277817 and b1f9414.

Files selected for processing (1)

• nodes/environment.md (1 hunks)

Additional comments: 2

nodes/environment.md (2)

• 47-47: The addition of aria2 for yum command is consistent with the change for apt. However, verify that aria2 is available in the default repositories for all distributions that use yum as their package manager to ensure users do not encounter issues during installation.
• 39-50: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-94]

The rest of the document, including the setup instructions for Golang and the development environment, remains unchanged and appears to be clear and accurate. Ensure that the addition of aria2 is well-integrated into the overall setup process and does not introduce any inconsistencies or confusion.

[qubelabsio]

• update other instances of wget
• replace wget with aria2c as a dependency in environment setup

@jcstein I wouldn't update other instances of wget, as it remains the preferred method for validators. However, for snapshots, which are optional but large in size, it makes sense to use aria2 instead.

I added aria2 to dependencies but left wget also, if that is ok?

[jcstein]

i just realized this doesn't work for mac now unless i just can't find the right way to install aria2c?

[jcstein]

nvm brew install aria2