chore: implement blobstream feedback from docs #1275

[jcstein]

Overview

Implements changes from 6-14 on issue 1275 in docs

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

• Documentation
  • Updated the keys command description for better clarity and added information on managing EVM keys.
  • Enhanced the orchestrator setup instructions, including specifying bootstrappers, registering EVM addresses, and configuration parameters.
  • Clarified the deployment process of the Blobstream smart contract and the location of the TOML config file for the relayer.
  • Added a note about validator set changes and their impact on orchestrator signing.
  • Improved clarity in the orchestrator setup guide for the Blobstream network, with additional details on exposing the P2P port and using setup flags.

[coderabbitai]

Warning

Rate Limit Exceeded

@jcstein has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 5 minutes and 30 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 55e35f5 and 32ecb77.

Walkthrough

The documentation for a blockchain network has been updated to enhance clarity and provide additional details. Key changes include improved instructions for setting up the orchestrator, specifying configuration parameters, and managing EVM keys. The updates also include a link to the geth keystore implementation and notes on validator set changes affecting orchestrator signing.

Changes

File Path	Change Summary
docs/keys.md	Updated keys command description and added evm subcommand details with a geth keystore link.
docs/orchestrator.md (multiple entries)	Clarified orchestrator setup instructions, added configuration flags, and detailed validator set change effects.
docs/relayer.md	Minor text updates on deploying smart contracts and clarifying TOML config file location.

Poem

As winter whispers, the docs align, 📜❄️
With clarity's touch, they now outshine.
CodeRabbit hops through, with updates in tow,
A blockchain's tale, more seamless to sow. 🐇💻

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between ea4706f and 4bddee1.

Files selected for processing (3)

• docs/keys.md (1 hunks)
• docs/orchestrator.md (7 hunks)
• docs/relayer.md (2 hunks)

Files skipped from review due to trivial changes (3)

• docs/keys.md
• docs/orchestrator.md
• docs/relayer.md

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 4bddee1 and 55e35f5.

Files selected for processing (1)

• docs/orchestrator.md (7 hunks)

Files skipped from review due to trivial changes (1)

• docs/orchestrator.md