Skip to content

docs/edfp: new delegation program description#2049

Merged
Bidon15 merged 1 commit intocelestiaorg:mainfrom
Bidon15:docs/edfp
May 27, 2025
Merged

docs/edfp: new delegation program description#2049
Bidon15 merged 1 commit intocelestiaorg:mainfrom
Bidon15:docs/edfp

Conversation

@Bidon15
Copy link
Copy Markdown
Member

@Bidon15 Bidon15 commented May 27, 2025

Overview

This new program outlines the rules and description + a form for our applicants

Summary by CodeRabbit

  • New Features

    • Added a new sidebar link to the "Celestia Foundation Ecosystem Delegation Program" under the Community section.
    • Published a comprehensive document detailing the Celestia Foundation Ecosystem Delegation Program, including program overview, eligibility, application instructions, and requirements for three participation tracks.
  • Documentation

    • Introduced detailed guidelines and examples for the new delegation program, covering deliverables, reporting, success criteria, and penalties for each track.

@Bidon15 Bidon15 requested review from jcstein and mindstyle85 May 27, 2025 08:53
@Bidon15 Bidon15 self-assigned this May 27, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 27, 2025

Walkthrough

A new sidebar entry for the "Celestia Foundation Ecosystem Delegation Program" was added to the documentation configuration. Additionally, a comprehensive markdown document detailing the program's structure, eligibility, application process, and participation tracks was introduced under the community section.

Changes

File(s) Change Summary
.vitepress/config.ts Added a sidebar item for the "Celestia Foundation Ecosystem Delegation Program" under Community.
community/foundation-ecosystem-delegation-program.md Introduced a detailed markdown document outlining the new delegation program and its requirements.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Sidebar (Docs)
    participant Delegation Program Doc

    User->>Sidebar (Docs): Access Community section
    Sidebar (Docs)->>User: Show "Foundation Ecosystem Delegation Program" link
    User->>Delegation Program Doc: Open program documentation
    Delegation Program Doc->>User: Display program overview, eligibility, tracks, and instructions
Loading

Possibly related PRs

Suggested reviewers

  • mindstyle85
  • jcstein

Poem

In the warren of docs, a new path appears,
For validators and builders to lend eager ears.
Three tracks to follow, with carrots as prize,
Delegation dreams under Celestia's skies.
Hop in, dear friends, and read what's in store—
The ecosystem grows as we open the door!
🥕✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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
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 (10)
community/foundation-ecosystem-delegation-program.md (10)

3-24: Check Table of Contents accuracy.
The ToC entries align with section headings. Ensure that Vitepress’s slug rules handle special characters (e.g., "&", "/") correctly. For readability and to satisfy markdownlint MD058, consider adding a blank line before line 4 and after line 24.


25-31: Surround program overview table with blank lines.
To comply with markdownlint MD058 and improve readability, insert a blank line before the table at line 27 and after line 31. Additionally, you may standardize the month range to something like "Jul–Dec 2025" for conciseness.


34-46: Link Code of Conduct & hyphenate "post-mortem".

  • Change "post mortem" to "post-mortem" for consistency.
  • Hyperlink "Celestia.org Code of Conduct" to /community/coc so readers can quickly access it.
🧰 Tools
🪛 LanguageTool

[misspelling] ~40-~40: This expression is normally spelled as one or with a hyphen.
Context: ... 1, a public forum post with a detailed post mortem is required) | | Independence | Not ass...

(EN_COMPOUNDS_POST_MORTEM)


53-55: Clarify the background section.
The description of the pilot duration and track selection is combined in one sentence. Splitting into two sentences—one for timeline and one for track requirements—would improve clarity.


58-85: Review Mamo-Users requirements & metrics.

  • Ensure the "power user" definition is precise enough for reporting.
  • Link "CC0" to the official Creative Commons page.
  • Surround each table in this block with blank lines to satisfy MD058.
🧰 Tools
🪛 LanguageTool

[style] ~75-~75: The wording of this phrase can be improved.
Context: ...ates in Q&A, and responds to surveys to make products better | | Creates & Shares Content | Publ...

(MAKE_STYLE_BETTER)


86-98: Enhance example submission formatting.
Add blank lines before and after the <details> block for readability. Consider shortening the <summary> text to “Example: Mamo-Users Track” for brevity.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

97-97: Tables should be surrounded by blank lines
null

(MD058, blanks-around-tables)


102-150: Revise Bootcamp & Mammothon guidelines.

  • For accessibility, consider replacing "&" with "and" in headings.
  • Link to any referenced hackathon or bootcamp resource pages.
  • Surround all tables and code blocks with blank lines (MD058).

151-163: Consistent example formatting.
As with the previous track, insert blank lines around the <details> block and update the <summary> to “Example: Bootcamp & Mammothon Track” for consistency.

🧰 Tools
🪛 LanguageTool

[style] ~162-~162: This phrase is redundant. Consider writing “outcomes”.
Context: ...n-source all demo projects
• Publish final outcomes |

--- ## R&D Rules & Requi...

(FINAL_END)

🪛 markdownlint-cli2 (0.17.2)

162-162: Tables should be surrounded by blank lines
null

(MD058, blanks-around-tables)


167-199: Clarify R&D track details.

  • Define "CIPs" on first mention or link to the official CIP documentation.
  • Link to sample public-goods tooling repositories if available.
  • Surround tables with blank lines for markdownlint compliance.

201-227: Convert bold text to headings for examples.
Lines 204, 212, and 220 use bold emphasis as pseudo-headings (MD036). Convert them into markdown headings, for example:

- **1. CIP: "Dynamic Data Availability Fees"**
+ #### 1. CIP: "Dynamic Data Availability Fees"

This improves accessibility and lint compliance.

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

204-204: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


212-212: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


220-220: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


226-226: Tables should be surrounded by blank lines
null

(MD058, blanks-around-tables)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6c5c2cf and ed9889c.

📒 Files selected for processing (2)
  • .vitepress/config.ts (1 hunks)
  • community/foundation-ecosystem-delegation-program.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
community/foundation-ecosystem-delegation-program.md

[misspelling] ~40-~40: This expression is normally spelled as one or with a hyphen.
Context: ... 1, a public forum post with a detailed post mortem is required) | | Independence | Not ass...

(EN_COMPOUNDS_POST_MORTEM)


[style] ~75-~75: The wording of this phrase can be improved.
Context: ...ates in Q&A, and responds to surveys to make products better | | Creates & Shares Content | Publ...

(MAKE_STYLE_BETTER)


[style] ~162-~162: This phrase is redundant. Consider writing “outcomes”.
Context: ...n-source all demo projects
• Publish final outcomes |

--- ## R&D Rules & Requi...

(FINAL_END)

🪛 markdownlint-cli2 (0.17.2)
community/foundation-ecosystem-delegation-program.md

97-97: Tables should be surrounded by blank lines
null

(MD058, blanks-around-tables)


162-162: Tables should be surrounded by blank lines
null

(MD058, blanks-around-tables)


204-204: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


212-212: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


220-220: Emphasis used instead of a heading
null

(MD036, no-emphasis-as-heading)


226-226: Tables should be surrounded by blank lines
null

(MD058, blanks-around-tables)

🔇 Additional comments (3)
.vitepress/config.ts (1)

863-866: Confirm sidebar link for new program.
The new "Celestia Foundation Ecosystem Delegation Program" entry is correctly placed under the Community section. Please verify that the file community/foundation-ecosystem-delegation-program.md exists at the specified path and that the sidebar link renders properly in the documentation preview.

community/foundation-ecosystem-delegation-program.md (2)

1-2: Validate document title formatting.
The H1 heading clearly names the program. If you need a custom anchor, consider adding an explicit ID (e.g., {#foundation-ecosystem-delegation-program}). Otherwise, confirm that Vitepress’s default slug generation matches your link targets.


49-52: Validate application form URL.
Please confirm that the Google Forms link is active and correct. Consider adding a note on expected confirmation or response time to set clear applicant expectations.

@Bidon15 Bidon15 enabled auto-merge May 27, 2025 09:42
@Bidon15 Bidon15 merged commit 348de2d into celestiaorg:main May 27, 2025
3 of 4 checks passed
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