Skip to content

readme: cleanup + discord link - #318

Merged
abdulsaheel merged 1 commit into
mainfrom
docs/readme-cleanup
Aug 30, 2026
Merged

readme: cleanup + discord link#318
abdulsaheel merged 1 commit into
mainfrom
docs/readme-cleanup

Conversation

@abdulsaheel

@abdulsaheel abdulsaheel commented Aug 30, 2026

Copy link
Copy Markdown
Collaborator

User description

  • WHOOP 5/MG no longer framed as "experimental" (still not claimed stable, just no longer singled out)
  • removed the duplicate donate/support section (already covered near the top)
  • added discord link

Summary by Sourcery

Refresh the README to clarify supported WHOOP bands, connect users with the Discord community, and remove redundant support information.

New Features:

  • Add a Discord community link for questions, band-specific issues, and informal bug reports.

Enhancements:

  • Update README wording and compatibility guidance to present WHOOP 4.0, 5, and MG support consistently while noting that 4.0 has more usage coverage.

Documentation:

  • Remove the duplicate support section from the README.

PR Type

Documentation


Description

  • Updated WHOOP 5 and MG support status

  • Added Discord community link and badge

  • Removed duplicate donation section


File Walkthrough

Relevant files
Documentation
README.md
Update README with Discord link and revised support status

README.md

  • Added a Discord badge and a new Community section with a link
  • Revised the wording around WHOOP 5 and MG support to remove the
    "experimental" label
  • Removed the duplicate "Support the work" section at the bottom of the
    file
+13/-15 

@sourcery-ai

sourcery-ai Bot commented Aug 30, 2026

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates README messaging to present WHOOP 5/MG support without singling it out as experimental, adds Discord discovery and community guidance, and removes the redundant donation section.

File-Level Changes

Change Details Files
Refreshes the README’s project positioning and support guidance for WHOOP 5/MG compatibility.
  • Generalizes the app description from WHOOP 4.0 to WHOOP bands and tightens the wording.
  • Replaces the “experimental” label with a more nuanced note about reduced testing coverage and possible rough edges.
README.md
Adds Discord as a community support channel.
  • Adds a Discord badge alongside the existing project badges.
  • Adds a Community section directing users to Discord for questions, device quirks, and informal bug reports.
README.md
Removes redundant donation documentation from the README.
  • Deletes the duplicate Support the work section while retaining the top-level donation link.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey - I've reviewed your changes and they look great!

Sourcery assessment

Approved.


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@coderabbitai

coderabbitai Bot commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 1eec8555-b7e3-46e4-93d2-89fc29564250

📥 Commits

Reviewing files that changed from the base of the PR and between 1d25e2e and 3d9908a.

📒 Files selected for processing (1)
  • README.md

Included review availability: Your plan provides up to 2 included reviews per hour; 1 remains after this review.


📝 Walkthrough

Walkthrough

README.md now updates project wording, adds a Discord badge and Community section, describes WHOOP 5 and MG support with reduced testing notes, and removes the donation section.

Changes

README updates

Layer / File(s) Summary
Support and community messaging
README.md
The README updates project and device-support descriptions, adds Discord community information, and removes donation information.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to 3d990

This PR updates README wording, removes duplicate support information, and adds a Discord community link without changing product or runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

🚥 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 accurately identifies the README cleanup and Discord link, which are central changes in the pull request.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

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

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.

@github-actions

Copy link
Copy Markdown
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected

@github-actions

Copy link
Copy Markdown
Contributor

PR Code Suggestions ✨

No code suggestions found for the PR.

@abdulsaheel
abdulsaheel merged commit 7f7afbc into main Aug 30, 2026
4 checks passed
@abdulsaheel
abdulsaheel deleted the docs/readme-cleanup branch August 30, 2026 05:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant