docs(credits): add Supporting the project section#330
Conversation
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>
Deploying espresense with
|
| Latest commit: |
c858bb4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://586b3019.espresense.pages.dev |
| Branch Preview URL: | https://docs-credits-supporting-sect.espresense.pages.dev |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThis 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). ChangesCredits Supporting the Project Section
Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
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/nodesand/deviceslinks there "for other ways to support," but/creditswas 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:
ESPresense/ESPresense/.github/FUNDING.yml), plus the affiliate-link path on/nodesand/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
/creditspage shows the new "Supporting the project" section at the top, above "Fork of ESP32-mqtt-room"Summary by CodeRabbit