Skip to content

docs: refresh README for current main - #78

Merged
abdulsaheel merged 1 commit into
mainfrom
docs/readme-refresh
Oct 9, 2026
Merged

abdulsaheel merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@abdulsaheel

@abdulsaheel abdulsaheel commented Oct 9, 2026 •

Copy link
Copy Markdown
Contributor

Refreshes the README to match what is on main today (no unreleased features claimed).

Prepared for owner review; not merged.

🤖 Generated with Claude Code

Summary by Sourcery

Documentation:

  • Update the README to accurately document current WHOOP MG ECG support and identify additional experimental sensor decoders and their limitations.

Summary by CodeRabbit

  • Documentation
    • Updated the README to state that OpenStrap supports WHOOP MG (gen5), including MG ECG records.
    • Clarified that filtered and raw MG ECG records can be received live during readings.
    • Listed experimental decoders for other sensors, watches, and rings, noting they have not been verified against physical devices and are excluded from app metrics.

@sourcery-ai

sourcery-ai Bot commented Oct 9, 2026 •

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

Reviewer's Guide

Refreshes README.md to accurately describe the current main-branch decoder coverage, including WHOOP MG ECG support and experimental device integrations, without claiming unreleased functionality.

File-Level Changes

Change Details Files
Update README device-support documentation to reflect currently implemented decoders and their maturity.
  • Add WHOOP MG/gen5 support, including ECG records, to the supported-device overview.
  • Document the new Labrador ECG decoder and distinguish live-reading data from historical drains.
  • List additional experimental single-device decoders while clarifying they are unverified and excluded from app metrics.
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

@coderabbitai

coderabbitai Bot commented Oct 9, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: 8ed5e657-2a4b-4e05-a41d-54abd604f4a0

📥 Commits

Reviewing files that changed from the base of the PR and between ecb512b and 4090d08.


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

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.



📝 Walkthrough

Walkthrough

The README now lists WHOOP MG (gen5), including MG ECG records. It also describes labrador.dart and clarifies the verification status and app-metrics exclusion of other single-device decoders.

Changes

Device documentation

Layer / File(s) Summary
Document device coverage and decoders
README.md
The README adds WHOOP MG (gen5) and MG ECG records to its device coverage. It lists labrador.dart for filtered and raw MG ECG records received live during a reading. It describes other single-device decoders as experimental, unverified against physical devices, and excluded from app metrics.

Priority: ⬇️ Low

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

Change: Other


Merge Risk: ⚪ Minimal · up to 4090d

No actionable issue is established for this documentation update. The app’s metric exclusion claim remains unconfirmed.

Pre-merge checks | Passed 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 clearly and concisely describes the README documentation update. It matches the main change 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.


  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@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 ✨

@abdulsaheel
abdulsaheel merged commit 138e543 into main Oct 9, 2026
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.

1 participant