Skip to content

chore: add funding page to docs #6204

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.

Sign up for GitHub

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

Jump to bottom
Merged
LesnyRumcajs merged 2 commits into from
Oct 29, 2025
Merged

chore: add funding page to docs #6204

LesnyRumcajs merged 2 commits into from
Oct 29, 2025

Conversation

@LesnyRumcajs
Copy link
Member

@LesnyRumcajs LesnyRumcajs commented Oct 29, 2025 •
edited by coderabbitai bot
Loading

Summary of changes

Changes introduced in this pull request:

  • added funding page to docs for transparency

Reference issue to close (if applicable)

Closes

Other information and links

Change checklist

  • I have performed a self-review of my own code,
  • I have made corresponding changes to the documentation. All new code adheres to the team's documentation standards,
  • I have added tests that prove my fix is effective or that my feature works (if possible),
  • I have made sure the CHANGELOG is up-to-date. All user-facing changes should be reflected in this document.

Summary by CodeRabbit

  • Documentation
    • Added a new funding page that highlights support sources, displays partner logos, and links to public-goods contributions.
    • Expanded the glossary with two new entries: FIL-RetroPGF and Hypercerts.

@LesnyRumcajs LesnyRumcajs requested a review from a team as a code owner October 29, 2025 13:52
@LesnyRumcajs LesnyRumcajs requested review from hanabi1224 and sudo-shashank and removed request for a team October 29, 2025 13:52
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 29, 2025 •
edited
Loading

Walkthrough

Two dictionary entries (FIL-RetroPGF and Hypercerts) were added to funding-related terminology, and a new documentation page docs/docs/users/funding.md was created describing funding sources and contributors with logos and a Hypercerts link.

Changes

Cohort / File(s) Summary
Dictionary entries
docs/dictionary.txt		 Added two new entries: FIL-RetroPGF and Hypercerts.
Documentation page
docs/docs/users/funding.md		 New static documentation page describing funding sources (Filecoin Foundation, ChainSafe Systems, FIL-RetroPGF) with centered logos and a Hypercerts link for public goods contributions.

Sequence Diagram(s)

(Not applicable)

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

  • Simple, additive documentation changes only; no code paths or API surface modified.

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "chore: add funding page to docs" directly and accurately describes the main change in this pull request. The PR's primary objective is to add a new funding page to the documentation to increase transparency, which is exactly what the title conveys. The title is concise, clear, and specific enough for a teammate reviewing the history to immediately understand the primary change. While the PR also includes supporting changes like adding dictionary entries for related terms (FIL-RetroPGF and Hypercerts), these are secondary and support the main feature, so the title appropriately focuses on the most significant addition.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add-funding-docs
📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5aa982b and 9b79c87.

📒 Files selected for processing (1)
  • docs/dictionary.txt (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Deploy to Cloudflare Pages
🔇 Additional comments (1)
docs/dictionary.txt (1)

38-38: Dictionary entries are correctly positioned and formatted.

Both new terms—FIL-RetroPGF and Hypercerts—are inserted in correct alphabetical order and follow the consistent formatting of the dictionary list. These additions appropriately support the new funding documentation page referenced in the PR.

Also applies to: 52-52

Comment @coderabbitai help to get the list of available commands and usage tips.

sudo-shashank
sudo-shashank previously approved these changes Oct 29, 2025
View reviewed changes
coderabbitai[bot]
coderabbitai bot reviewed Oct 29, 2025
View reviewed changes
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: 1

🧹 Nitpick comments (1)
docs/dictionary.txt (1)

38-38: Add capitalized variant "Hypercerts" to dictionary to prevent spell-checker warnings.

The documentation at docs/docs/users/funding.md:15 uses "Hypercerts" (capitalized) at the start of a sentence, but the dictionary contains only the lowercase variant "hypercerts" at line 52. A case-sensitive spell-checker will flag the capitalized form as a typo.

Add "Hypercerts" as a separate entry after line 52 to cover both variants.

 hypercerts
+Hypercerts
 ie.
📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 317dff6 and 5aa982b.

📒 Files selected for processing (2)
  • docs/dictionary.txt (2 hunks)
  • docs/docs/users/funding.md (1 hunks)
🧰 Additional context used
🪛 GitHub Actions: Docs Check
docs/docs/users/funding.md

[warning] 15-15: Hypercerts is misspelt in this file (should be 'hypercerts').

🪛 markdownlint-cli2 (0.18.1)
docs/docs/users/funding.md

15-15: Link text should be descriptive

(MD059, descriptive-link-text)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
  • GitHub Check: Deploy to Cloudflare Pages
🔇 Additional comments (1)
docs/docs/users/funding.md (1)

1-15: Verify page displays correctly in Docusaurus and styling is applied.

The page uses inline JSX for layout (style={{ display: 'flex' , justifyContent: 'space-around' }}). Confirm this renders as intended in your documentation build.

@LesnyRumcajs LesnyRumcajs added this pull request to the merge queue Oct 29, 2025
Merged via the queue into main with commit db4a492 Oct 29, 2025
20 checks passed
@LesnyRumcajs LesnyRumcajs deleted the add-funding-docs branch October 29, 2025 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@sudo-shashank sudo-shashank sudo-shashank approved these changes

@hanabi1224 hanabi1224 Awaiting requested review from hanabi1224 hanabi1224 is a code owner automatically assigned from ChainSafe/forest

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@LesnyRumcajs @sudo-shashank