readme: stop framing the whole app as WHOOP-only - #320
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThe 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
|
Warning Review limit reachedNext included review available in 22 minutes. View limit detailsLimit 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. Review configuration: ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
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 |
There was a problem hiding this comment.
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.
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
|
|
||
| ``` | ||
| WHOOP band → Bluetooth → protocol decoder → local storage → analytics → the UI | ||
| wearable → Bluetooth → protocol decoder → local storage → analytics → the UI |
There was a problem hiding this comment.
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.
| wearable → Bluetooth → protocol decoder → local storage → analytics → the UI | |
| WHOOP pipeline: wearable → Bluetooth → protocol decoder → local storage → analytics → the UI |
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
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:
Documentation:
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
File Walkthrough
README.md
Generalize wearable support in READMEREADME.md
WHOOP.
wearableinstead ofWHOOPband.