Skip to content

Update Delegation Requirements and Clarify Documentation#1877

Merged
jcstein merged 3 commits intocelestiaorg:mainfrom
MarsonKotovi4:main
Jan 28, 2025
Merged

Update Delegation Requirements and Clarify Documentation#1877
jcstein merged 3 commits intocelestiaorg:mainfrom
MarsonKotovi4:main

Conversation

@MarsonKotovi4
Copy link
Copy Markdown
Contributor

@MarsonKotovi4 MarsonKotovi4 commented Jan 28, 2025

This Pull Request introduces updates to three files:

1.	foundation-delegation-program.md
•	Added a requirement to maintain a fully archival (non-pruned) bridge node for both Mainnet Beta and Mocha, if selected for the program.
•	Clarified that hosting infrastructure in Hetzner or OVH is discouraged.

2.	modular-meetup-guide.md
•	Adjusted wording regarding free venues (e.g., libraries) and the availability of equipment in co-working spaces and universities.
•	Corrected minor typos (e.g., changing “costs” to “cost” and “equipments” to “equipment”).

3.	speaker-list.md
•	Expanded the description of the benefits of joining the Speaker List, emphasizing high-quality presentations, interactive Q&A, and knowledge sharing.
•	Fixed stylistic and grammatical inconsistencies.

Overall, these changes improve the clarity of the documentation, refine node requirements, and make it easier to understand the process of organizing Modular Meetups and participating in the Speaker List.

Summary by CodeRabbit

  • Documentation
    • Updated grammatical and formatting details in multiple community documents
    • Corrected minor phrasing in Foundation Delegation Program requirements
    • Improved grammatical accuracy in Modular Meetup Guide
    • Added a clarifying comma in Speaker List document

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Jan 28, 2025

Walkthrough

This pull request involves minor grammatical and formatting corrections across three Markdown documentation files in the community directory. The changes are primarily focused on improving language precision, such as adding hyphens, correcting grammatical errors, and adjusting punctuation. These modifications do not alter the substantive content or functionality of the documents but enhance their readability and grammatical accuracy.

Changes

File Change Summary
community/foundation-delegation-program.md Added hyphen to "non-pruned" in bridge node maintenance requirement
community/modular-meetup-guide.md Corrected grammar: "at little to no costs" → "at little to no cost", "necessary equipments" → "necessary equipment"
community/speaker-list.md Added comma after "Speaker List" to improve sentence clarity

Possibly related PRs

Suggested reviewers

  • jcstein
  • rootulp

Poem

🐰 A Rabbit's Documentation Delight

Commas dance and hyphens take flight,
Grammar polished, words shining bright,
In Markdown's realm, precision gleams,
Our docs now sparkle with clearer seams!

Hop, hop, hooray! 🌟


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
Copy Markdown
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)
community/modular-meetup-guide.md (1)

92-92: Consider rephrasing to improve conciseness.

The phrase "a lot of" is wordy. Consider a more precise alternative.

-     offer you a lot of spaces for meetups, as well as necessary equipment
+     offer you various spaces for meetups, as well as necessary equipment
🧰 Tools
🪛 LanguageTool

[style] ~92-~92: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...cal university clubs can offer you a lot of spaces for meetups, as well as necessar...

(A_LOT_OF)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between b8aa44b and 1f618b9.

📒 Files selected for processing (3)
  • community/foundation-delegation-program.md (1 hunks)
  • community/modular-meetup-guide.md (2 hunks)
  • community/speaker-list.md (1 hunks)
✅ Files skipped from review due to trivial changes (2)
  • community/speaker-list.md
  • community/foundation-delegation-program.md
🧰 Additional context used
🪛 LanguageTool
community/modular-meetup-guide.md

[style] ~92-~92: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...cal university clubs can offer you a lot of spaces for meetups, as well as necessar...

(A_LOT_OF)

🔇 Additional comments (1)
community/modular-meetup-guide.md (1)

83-83: LGTM!

The wording clearly communicates the availability and cost considerations for library venues.

@jcstein
Copy link
Copy Markdown
Member

jcstein commented Jan 28, 2025

OK

@jcstein jcstein merged commit fc9876c into celestiaorg:main Jan 28, 2025
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