Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Improved clarity and grammar in staking documentation #1842

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

0xwitty
Copy link
Contributor

@0xwitty 0xwitty commented Dec 26, 2024

Overview

I’ve reviewed the staking documentation and corrected a few grammatical inconsistencies to improve clarity and professionalism. Below are the changes made:

  1. "enter amount of TIA tokens and select Stake"

    • Updated to: "enter the amount of TIA tokens and select Stake."
  2. "In top right select Celestia network and navigate to Stake."

    • Updated to: "In the top right, select Celestia network and navigate to Stake."
  3. "Similarly to previous step, select the +Stake button."

    • Updated to: "Similarly to the previous step, select the +Stake button."
  4. "On the following screen enter amount of TIA tokens and select Stake."

    • Updated to: "On the following screen, enter the amount of TIA tokens and select Stake."
  5. "Choose the amount of Celestia and search for a validator."

    • Updated to: "Choose the amount of Celestia tokens and search for a validator."

These adjustments make the documentation more polished and easier to follow.

Summary by CodeRabbit

  • Documentation
    • Minor textual modifications for clarity in the tutorial on staking TIA, enhancing grammatical accuracy.

Copy link
Contributor

coderabbitai bot commented Dec 26, 2024

Walkthrough

The pull request introduces minor grammatical and textual improvements to the "How to Stake TIA" tutorial markdown document. The changes focus on enhancing the clarity and grammatical precision of the instructions for staking TIA tokens across different wallet interfaces, including Keplr, Leap, and Gem wallets. These modifications are purely textual and do not impact the underlying staking process or functionality.

Changes

File Change Summary
learn/how-to-stake-tia.md - Added "the" in Keplr wallet instructions: "enter the amount of TIA tokens"
- Updated Leap wallet text to "Similarly to the previous step"
- Revised Gem wallet instruction to "Choose the amount of Celestia tokens"

Possibly related PRs

  • Add Gem Wallet #1590: Expands the tutorial to include instructions for the Gem wallet, directly connected to the current document's modifications

Poem

🐰 A Rabbit's Staking Tale 🌟

With words refined, our tutorial gleams,
Grammar polished, clearer than it seems,
TIA tokens dance with newfound grace,
A tiny tweak puts a smile on my face!
Staking made smooth, one word at a time 🚀


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

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.

Actionable comments posted: 0

🧹 Nitpick comments (1)
learn/how-to-stake-tia.md (1)

109-109: Remove trailing period from heading.

According to markdown best practices (MD026), headings should not end with punctuation marks.

-### :two: Choose the amount of Celestia tokens and search for a validator.
+### :two: Choose the amount of Celestia tokens and search for a validator
🧰 Tools
🪛 Markdownlint (0.37.0)

109-109: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ed5e88 and 5401f18.

📒 Files selected for processing (1)
  • learn/how-to-stake-tia.md (3 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
learn/how-to-stake-tia.md

109-109: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

🔇 Additional comments (3)
learn/how-to-stake-tia.md (3)

58-58: LGTM! Grammar improvement.

The addition of "the" enhances readability and grammatical correctness.


77-77: LGTM! Grammar improvement.

The addition of "the" enhances readability and grammatical correctness.


79-79: LGTM! Grammar improvement.

The addition of "the" enhances readability and grammatical correctness.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant