-
Notifications
You must be signed in to change notification settings - Fork 376
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
fix: several typos of various value #1838
base: main
Are you sure you want to change the base?
Conversation
WalkthroughThis pull request encompasses documentation updates across multiple Markdown files in the Celestia community repository. The changes primarily focus on improving clarity, grammatical precision, and providing more detailed instructions. The modifications span guides for the Foundation Delegation Program, Modular Meetups, BlobstreamX deployment, Celestia Node troubleshooting, and a Quick Start guide. The updates aim to enhance readability and ensure comprehensive, accurate information for users and community members. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (5)
community/foundation-delegation-program.md
(2 hunks)community/modular-meetup-guide.md
(3 hunks)how-to-guides/blobstream-x-deploy.md
(1 hunks)how-to-guides/celestia-node-troubleshooting.md
(1 hunks)how-to-guides/quick-start.md
(2 hunks)
🔇 Additional comments (4)
community/foundation-delegation-program.md (1)
75-75
: LGTM! Grammar improvements enhance clarity.
The changes improve readability by adding appropriate articles and possessive forms:
- "before application deadline" → "before the application deadline"
- "will result in withdrawal of delegation" → "will result in the withdrawal of the delegation"
- "Celestia docs" → "Celestia's docs"
Also applies to: 90-90, 94-94
how-to-guides/quick-start.md (1)
176-176
: LGTM! Improved conciseness in documentation.
The removal of redundant "data" before "commitment" improves readability while maintaining technical accuracy.
Also applies to: 194-194
community/modular-meetup-guide.md (1)
26-26
: LGTM! Grammar and clarity improvements.
The changes improve readability through better phrasing and consistent hyphenation.
Also applies to: 71-71, 166-166
how-to-guides/blobstream-x-deploy.md (1)
74-74
: LGTM! Helpful example for fee vault configuration.
The added comment provides clear guidance on how to set the SUCCINCT_FEE_VAULT
environment variable when a specific vault isn't needed.
@@ -24,7 +24,7 @@ celestia <node-type> start --p2p.network <network> --core.ip <URI> | |||
|
|||
:::tip | |||
Refer to [the ports section of this page](#ports) | |||
for information on which ports are required to be open on your machine. | |||
for information on which ports are required to be opened on your machine. |
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.
Revert grammatical change for technical accuracy.
The phrase "required to be open" is more accurate than "required to be opened" when describing port states. "Open" describes the required state, while "opened" implies the action of opening.
-for information on which ports are required to be opened on your machine.
+for information on which ports are required to be open on your machine.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
for information on which ports are required to be opened on your machine. | |
for information on which ports are required to be open on your machine. |
Pull Request: Gengixer
Overview
This pull request addresses multiple minor typographical errors across various documentation files within the repository. These corrections improve the clarity and professionalism of the text. Below is a summary of the changes made:
Details of Changes
Files Updated:
community/foundation-delegation-program.md
community/modular-meetup-guide.md
how-to-guides/blobstream-x-deploy.md
how-to-guides/celestia-node-troubleshooting.md
how-to-guides/quick-start.md
Notes
Checklist
Thank you for reviewing this PR!
Summary by CodeRabbit
New Features
Bug Fixes
Documentation