Skip to content

docs(credits): add Supporting the project section#330

Merged
DTTerastar merged 1 commit into
mainfrom
docs/credits-supporting-section
May 23, 2026
Merged

docs(credits): add Supporting the project section#330
DTTerastar merged 1 commit into
mainfrom
docs/credits-supporting-section

Conversation

@Terastar-Paperclip
Copy link
Copy Markdown
Contributor

@Terastar-Paperclip Terastar-Paperclip commented May 23, 2026

Summary

Follow-up to #329, addressing DT's feedback that /credits "doesn't really have any details on supporting the project" — the affiliate-disclosure aside on /nodes and /devices links there "for other ways to support," but /credits was previously just a list of upstream libraries with no actual support paths.

Adds a Supporting the project section near the top that documents the channels that already exist:

  • Free things that help — starring the repos, clear bug reports, docs PRs, helping in Discussions.
  • If you want to chip in money — GitHub Sponsors / Patreon / Ko-fi (already configured in ESPresense/ESPresense/.github/FUNDING.yml), plus the affiliate-link path on /nodes and /devices.

No invented donation channels — only what's already configured in the firmware repo's FUNDING.yml. No emoji, plain talk, matches the rest of the docs voice.

Why

Makes the existing affiliate-disclosure asides honest: the "see Credits for other ways to support" sentence now points at a section that actually describes those other ways.

Test plan

  • Astro/Starlight build succeeds
  • Rendered /credits page shows the new "Supporting the project" section at the top, above "Fork of ESP32-mqtt-room"
  • All three sponsorship links resolve (GitHub Sponsors, Patreon, Ko-fi)
  • All three repo links resolve

Summary by CodeRabbit

  • Documentation
    • Added "Supporting the project" section to credits documentation detailing volunteer maintenance practices and contribution methods available to users—including free options like community engagement, issue reporting, and documentation improvements, plus financial support channels through sponsorships and partnerships.

Review Change Stack

The /nodes and /devices affiliate-disclosure asides link to /credits
"for other ways to support" — but /credits previously only listed
upstream libraries and contributors, with no actual support paths.

Adds a Supporting the project section that documents the existing
channels: starring the repos, filing clear bug reports, doc PRs,
helping in Discussions, plus the GitHub Sponsors / Patreon / Ko-fi
links already configured in the firmware repo's FUNDING.yml.

Wording stays plain (no emojis, no jargon) to match the rest of the
docs site.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 23, 2026

Deploying espresense with  Cloudflare Pages  Cloudflare Pages

Latest commit: c858bb4
Status: ✅  Deploy successful!
Preview URL: https://586b3019.espresense.pages.dev
Branch Preview URL: https://docs-credits-supporting-sect.espresense.pages.dev

View logs

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 23, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c8aa30fa-e4ad-4a1d-b4c5-fbb907b4284f

📥 Commits

Reviewing files that changed from the base of the PR and between 1c9efd0 and c858bb4.

📒 Files selected for processing (1)
  • src/content/docs/credits.md

Walkthrough

This PR adds a "Supporting the project" section to the credits documentation, providing guidance on both non-monetary contributions (starring repos, reporting issues, documentation pull requests, participating in discussions) and monetary support options (GitHub Sponsors, Patreon, Ko-fi, affiliate hardware links).

Changes

Credits Supporting the Project Section

Layer / File(s) Summary
Supporting the project section
src/content/docs/credits.md
New section explains volunteer maintenance and lists non-monetary ways to help (starring, issue reports, docs contributions, discussions) and monetary support channels (GitHub Sponsors, Patreon, Ko-fi, affiliate hardware links).

Possibly related PRs

  • ESPresense/ESPresense.com#328: Both PRs modify documentation to add support and disclosure information, with PR #328 adding an affiliate disclosure note on /nodes.md.

Suggested reviewers

  • DTTerastar
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs(credits): add Supporting the project section' clearly and concisely summarizes the main change: adding a new section to the credits documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/credits-supporting-section

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

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

@DTTerastar DTTerastar enabled auto-merge (squash) May 23, 2026 00:10
@DTTerastar DTTerastar merged commit 400f66c into main May 23, 2026
3 checks passed
@DTTerastar DTTerastar deleted the docs/credits-supporting-section branch May 23, 2026 00:10
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.

3 participants