-
Notifications
You must be signed in to change notification settings - Fork 378
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
base: main
Are you sure you want to change the base?
Conversation
WalkthroughThe 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
Possibly related PRs
Poem
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this 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
📒 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.
Overview
I’ve reviewed the staking documentation and corrected a few grammatical inconsistencies to improve clarity and professionalism. Below are the changes made:
"enter amount of TIA tokens and select Stake"
"In top right select Celestia network and navigate to Stake."
"Similarly to previous step, select the +Stake button."
"On the following screen enter amount of TIA tokens and select Stake."
"Choose the amount of Celestia and search for a validator."
These adjustments make the documentation more polished and easier to follow.
Summary by CodeRabbit