docs: update feegrant UX

[jcstein]

Overview

Updates new UX of feegrant.

PREVIEW DEPLOYMENT

Summary by CodeRabbit

• New Features

  • Simplified instructions and enhanced descriptions for the FeeGrant module documentation.
  • Removed the requirement for node restart when a granter revokes permission, improving user experience.
  • Streamlined command syntax for granting fees by making spend limit optional.

• Documentation

  • Improved clarity and readability of the documentation.
  • Updated submission instructions for blobs, emphasizing the --granter.address flag.

[coderabbitai]

Walkthrough

The documentation for the FeeGrant module in the celestia-node has been updated to improve clarity and usability. Key modifications include the removal of the requirement for node restarts after permission revocations, simplification of command syntax by making the spend limit optional, and clearer instructions for using the --granter.address flag when submitting blobs.

Changes

File Path	Change Summary
developers/feegrant-for-blobs.md	Simplified instructions, clarified functionality descriptions, removed restart requirement after revocation, streamlined command syntax by making spend limit optional, and updated blob submission section to emphasize --granter.address flag.

Poem

In the garden of code, hops a bright bunny,
With changes so smooth, they’re sweet like honey.
Permissions unwind, command lines set free,
A seamless experience, oh what glee! 🐇✨
Let’s hop through the updates, so clear and bright,
With every new feature, our future’s in sight!

---

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 testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• 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 testing code 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 and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

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

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions]

PR Preview Action v1.4.7
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/./pr-1683/
on branch main at 2024-08-23 17:05 UTC

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 598a959 and 1573847.

Files selected for processing (1)

• developers/feegrant-for-blobs.md (4 hunks)

Additional comments not posted (7)

developers/feegrant-for-blobs.md (7)

45-50: Improvement in usability documentation.

The documentation now correctly highlights the ability to use FeeGrant functionality during runtime without restarting the node, enhancing usability.

---

54-67: Clear instructions for granting fee allowances.

The updated instructions for starting the node and granting fee allowances are clear and concise.

---

Line range hint 71-99: Clear instructions for using FeeGrant as a grantee.

The documentation provides clear instructions for starting the node and checking the balance, along with useful example outputs.

---

96-99: Clear instructions for submitting a blob using FeeGrant.

The documentation provides clear instructions and example outputs for submitting a blob using FeeGrant.

---

139-142: Clear instructions for revoking a FeeGrant.

The documentation provides clear and concise instructions for revoking a FeeGrant.

---

Line range hint 154-176: Clear instructions for granting fee allowances using celestia-appd.

The documentation provides clear instructions and example links for granting fee allowances using celestia-appd.

---

Line range hint 178-182: Clear instructions for checking the granter's account balance.

The documentation provides clear and concise instructions for checking the granter's account balance.