docs: improve orchestrator documentation

[rach-id]

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

• New Features

  • Users can now import a private key using a BIP39 mnemonic for enhanced security and convenience.

• Documentation

  • Updated the orchestrator guide with new instructions for gRPC authentication issues and pruned attestations.
  • Renamed commands for registering and querying EVM addresses to improve clarity and consistency.

[coderabbitai]

Walkthrough

The recent update enhances an orchestrator tool with the ability to import private keys using BIP39 mnemonics, improves clarity on resolving gRPC authentication issues and pruned attestations, and introduces a renaming of commands for EVM address handling, changing blobstream to qgb.

Changes

File Path	Change Summary
docs/orchestrator.md	- Added private key import via BIP39 mnemonic. - Clarified gRPC authentication and pruned attestations issues. - Renamed commands from blobstream to qgb.

🐇🌼 In the spring of code, changes bloom,
A mnemonic seed, in the docs finds room.
With qgb commands, we hop and zoom,
And fix the bugs before they loom. 🐛🛠️

---

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 5590cb8 and a3cf05f.

Files selected for processing (1)

• docs/orchestrator.md (4 hunks)

Additional comments: 4

docs/orchestrator.md (4)

• 95-98: The addition of BIP39 mnemonic support for importing EVM private keys is a significant enhancement for user security and key recoverability. Ensure that the documentation provides clear instructions on how to use this feature and that any necessary warnings about key security are included.

• 145-159: The clarification on known issues is helpful for troubleshooting. It's important to ensure that the solutions provided are up-to-date and have been tested to work with the current version of the software. Additionally, consider adding links to any relevant issues in the project's issue tracker for users who want more detailed information.

• 175-187: The renaming of commands from blobstream to qgb is a critical update for users following the documentation. It's essential to ensure that all instances of the old command name have been updated throughout the documentation to prevent confusion.

• 272-278: The instructions for verifying the updated EVM address are clear. It's good practice to remind users to restart the orchestrator after making changes to ensure that the new configuration is applied.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5590cb8) 26.63% compared to head (a3cf05f) 26.63%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #592   +/-   ##
=======================================
  Coverage   26.63%   26.63%           
=======================================
  Files          29       29           
  Lines        2962     2962           
=======================================
  Hits          789      789           
  Misses       2078     2078           
  Partials       95       95           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[evan-forbes]

have one suggestion