Skip to content
This repository has been archived by the owner on Apr 15, 2024. It is now read-only.

chore: update docs #610

Merged
merged 3 commits into from
Nov 21, 2023
Merged

chore: update docs #610

merged 3 commits into from
Nov 21, 2023

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Nov 21, 2023

Overview

I will put this into an automation soon so that docs update when this repo is updated

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 format for specifying the bootstrapper node in the Mocha testnet instructions.
    • Added information on using the --from your_wallet flag to specify the wallet for transaction fees in the celestia-appd tx qgb register command.

Copy link
Contributor

coderabbitai bot commented Nov 21, 2023

Walkthrough

The documentation for the Mocha testnet has been updated to enhance clarity and user experience. The bootstrapper node information is now presented in a more readable code block, and a new flag has been introduced to specify the wallet for transaction fees during the registration command.

Changes

File Change Summary
docs/orchestrator.md Updated bootstrapper node format to code block; added --from your_wallet flag to celestia-appd tx qgb register command.

🐇🍂 "In the brisk autumn breeze, code flows with ease,
As the Mocha testnet gets a tweak.
With a hop and a skip, we make this small trip,
To ensure every command is unique." 🍁🌟


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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 8fa8dd3 and d9fafa1.
Files selected for processing (1)
  • docs/orchestrator.md (2 hunks)
Files skipped from review due to trivial changes (1)
  • docs/orchestrator.md

@rach-id rach-id enabled auto-merge (squash) November 21, 2023 15:04
@rach-id rach-id added the documentation Improvements or additions to documentation label Nov 21, 2023
@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (8fa8dd3) 26.13% compared to head (4bb99c5) 26.13%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #610   +/-   ##
=======================================
  Coverage   26.13%   26.13%           
=======================================
  Files          29       29           
  Lines        3019     3019           
=======================================
  Hits          789      789           
  Misses       2135     2135           
  Partials       95       95           

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

@rach-id rach-id merged commit 4067795 into celestiaorg:main Nov 21, 2023
17 checks passed
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants