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

Typo Update how-to-stake-tia.md #1790

Closed
wants to merge 1 commit into from

Conversation

famouswizard
Copy link

@famouswizard famouswizard commented Nov 13, 2024

Description:

This PR addresses a typo in the staking tutorial where "Celestia" was incorrectly used when referring to the staking amount in the Gem Wallet section.

Issue:

The sentence:

"Choose the amount of Celestia and search for a validator."

is incorrect because it refers to the wrong token. The tutorial is about staking TIA tokens, not Celestia.

Correction:

The sentence has been corrected to:

"Choose the amount of TIA and search for a validator."

This change is important to ensure accuracy in the tutorial, as users might be confused by the incorrect mention of "Celestia" when it should refer to "TIA", the native token for staking.


This pull request improves clarity and ensures the tutorial is aligned with the correct terminology for staking TIA tokens.

Summary by CodeRabbit

  • Documentation
    • Updated terminology in the staking tutorial to consistently use "TIA" instead of "Celestia."
    • Made minor formatting adjustments for improved clarity and uniformity.

Fix typo in staking tutorial: Replace "Celestia" with "TIA"
Copy link
Contributor

coderabbitai bot commented Nov 13, 2024

Walkthrough

The pull request updates the document learn/how-to-stake-tia.md by replacing the term "Celestia" with "TIA" in multiple instances to ensure consistent terminology regarding the staking process. The changes specifically affect the instructions for using the Gem wallet, where references to "TIA tokens" are now correctly used. Additionally, minor formatting adjustments have been made, including the removal of a hyphen for uniformity. The overall content and structure of the tutorial remain unchanged.

Changes

File Change Summary
learn/how-to-stake-tia.md - Replaced "Celestia" with "TIA" in two instances related to staking instructions.
- Removed a hyphen before the second step in the Gem wallet section for formatting consistency.

Possibly related PRs

  • Add Gem Wallet #1590: This PR adds instructions for staking TIA with the Gem wallet, which is directly related to the changes made in the main PR that also focuses on the staking process for TIA tokens.
  • docs: increase precision of TIA Allocation at Genesis #1699: Although this PR deals with precision in TIA allocation, it is related to the broader context of TIA documentation, which includes staking information.
  • chore: Fix typos in documentation for multiple files #1780: This PR addresses typographical errors across multiple documentation files, including those related to TIA, which may enhance the clarity of the staking instructions in the main PR.
  • Typo corrections #1782: This PR corrects typographical errors in the "Integrate Celestia" tutorial, which may indirectly relate to the clarity of staking instructions in the main PR.

Suggested reviewers

  • jcstein

🐰 In the meadow, where tokens play,
TIA shines bright, leading the way.
With each step staked, the process refined,
Clarity blooms, in the words we find.
Hopping along, with joy we cheer,
For staking TIA, the path is clear! 🌼


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 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

🧹 Outside diff range and nitpick comments (1)
learn/how-to-stake-tia.md (1)

109-109: Remove trailing period from heading

The heading contains a trailing period which violates markdown style guidelines.

Apply this diff to fix the markdown lint issue:

-### :two: Choose the amount of TIA and search for a validator.
+### :two: Choose the amount of TIA and search for a validator
🧰 Tools
🪛 Markdownlint

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

(MD026, no-trailing-punctuation)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4b55bf3 and bd60258.

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

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

(MD026, no-trailing-punctuation)

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

111-111: LGTM! Terminology correction looks good

The change from "Celestia" to "TIA tokens" improves accuracy and consistency in the documentation, aligning with the correct terminology for staking.

@jcstein
Copy link
Member

jcstein commented Nov 18, 2024

unecessary change.

@jcstein jcstein closed this Nov 18, 2024
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.

2 participants