Skip to content

readme: stop framing the whole app as WHOOP-only - #320

Merged
abdulsaheel merged 1 commit into
mainfrom
docs/readme-drop-whoop-only-framing
Aug 30, 2026
Merged

readme: stop framing the whole app as WHOOP-only#320
abdulsaheel merged 1 commit into
mainfrom
docs/readme-drop-whoop-only-framing

Conversation

@abdulsaheel

@abdulsaheel abdulsaheel commented Aug 30, 2026

Copy link
Copy Markdown
Collaborator

User description

Tagline and the how-it-works pipeline diagram still said 'WHOOP band' even though the Supports section further down already lists BLE straps + Oura roadmap. Genericized both, pointed the tagline at the Supports section.

Summary by Sourcery

Generalize the README to reflect Openstrap Edge’s broader wearable support.

Enhancements:

  • Update README wording and the pipeline overview to describe Openstrap Edge as supporting wearables generally rather than framing it as WHOOP-only, while linking readers to the support details.

Documentation:

  • Clarify current WHOOP support and direct users to the Supports section for additional device compatibility.

PR Type

Documentation


Description

  • Generalize tagline for broader wearable support

  • Update pipeline diagram removing WHOOP-only framing

  • Direct users to the Supports section


Diagram Walkthrough

flowchart LR
  id1["README.md"] -- "Update tagline" --> id2["Broader wearable support"]
  id1 -- "Update pipeline diagram" --> id3["Generic 'wearable' term"]
Loading

File Walkthrough

Relevant files
Documentation
README.md
Generalize wearable support in README                                       

README.md

  • Updated the main tagline to mention generic wearables instead of just
    WHOOP.
  • Added a reference to the Supports section for device compatibility.
  • Changed the pipeline diagram to start with wearable instead of WHOOP
    band.
+2/-2     

@sourcery-ai

sourcery-ai Bot commented Aug 30, 2026

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

Reviewer's Guide

The README now presents Openstrap Edge as a wearable-agnostic app, with a Supports-section link for compatibility details, while retaining explicit WHOOP support information and genericizing the pipeline diagram.

File-Level Changes

Change Details Files
Generalize README positioning from WHOOP-specific language to broader wearable support while preserving current support details.
  • Update the tagline to describe generic wearable Bluetooth pairing and local computation.
  • Retain WHOOP 4/5/MG full-support messaging and link readers to the Supports section for compatibility details.
  • Replace the WHOOP-specific device label in the how-it-works pipeline with “wearable”.
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 Aug 30, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

Next included review available in 22 minutes.

View limit details

Limit details: You’ve used all 2 included reviews currently available.

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Learn how review limits work.

Review configuration:

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 4c0be0d5-d01e-49b4-9ef7-daa04ccace8d

📥 Commits

Reviewing files that changed from the base of the PR and between 4265664 and 2534dbe.

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

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 found 1 issue

Prompt for AI Agents
Please address the comments from this code review:

## Individual Comments

### Comment 1
<location path="README.md" line_range="177" />
<code_context>

 ```
-WHOOP band → Bluetooth → protocol decoder → local storage → analytics → the UI
+wearable → Bluetooth → protocol decoder → local storage → analytics → the UI
 ```

</code_context>
<issue_to_address>
**nitpick:** The generic pipeline presents every supported wearable as flowing through the protocol decoder and analytics pipeline, but the Supports section says standard Bluetooth heart-rate straps currently provide only workout heart rate and beat timing while recovery/strain processing is still on the roadmap. This makes the diagram overstate what the newly included strap support actually does.

**Triggers:** When a reader interprets the diagram as describing the currently supported BLE heart-rate strap path.

**Suggested fix:** Label the diagram as the WHOOP pipeline, or show the strap path separately with its current workout-only capabilities.

```suggestion
WHOOP pipeline: wearable → Bluetooth → protocol decoder → local storage → analytics → the UI
```
</issue_to_address>

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.

Comment thread README.md

```
WHOOP band → Bluetooth → protocol decoder → local storage → analytics → the UI
wearable → Bluetooth → protocol decoder → local storage → analytics → the UI

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

nitpick: The generic pipeline presents every supported wearable as flowing through the protocol decoder and analytics pipeline, but the Supports section says standard Bluetooth heart-rate straps currently provide only workout heart rate and beat timing while recovery/strain processing is still on the roadmap. This makes the diagram overstate what the newly included strap support actually does.

Triggers: When a reader interprets the diagram as describing the currently supported BLE heart-rate strap path.

Suggested fix: Label the diagram as the WHOOP pipeline, or show the strap path separately with its current workout-only capabilities.

Suggested change
wearable → Bluetooth → protocol decoder → local storage → analytics → the UI
WHOOP pipeline: wearable → Bluetooth → protocol decoder → local storage → analytics → the UI

@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 9568a73 into main Aug 30, 2026
4 checks passed
@abdulsaheel
abdulsaheel deleted the docs/readme-drop-whoop-only-framing branch August 30, 2026 05:44
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