Skip to content

docs: add an in-repo FAQ and point the issue templates at it - #809

Merged
ryanbr merged 1 commit into
mainfrom
docs/faq-in-repo
Jul 25, 2026
Merged

ryanbr merged 1 commit into
mainfrom
docs/faq-in-repo

Conversation

@ryanbr

@ryanbr ryanbr commented Jul 25, 2026

Copy link
Copy Markdown
Owner

The bug template asks every reporter to tick "I checked the FAQ" — and that link is dead. wiki/FAQ 302s to the bare wiki root, as do wiki/Troubleshooting and wiki/WHOOP-5.0-and-MG-Status. The wiki has no pages at all, so .wiki.git does not exist and the pages cannot be created by push.

That is the direct cause of the recurring resting-HR reports. NOOP shows the lowest sustained in-bed level; the WHOOP app shows something nearer the whole-night mean, so NOOP reads 5–8 bpm lower by design. It is documented in ANALYTICS.md and in a v7.0.0 release note that says it is "answerable straight from the log" — which means exporting and reading a log to learn your data is fine. #550 is the master issue; #803 is the latest.

docs/FAQ.md answers that plus the questions that arrive with it: HRV differing from the app (including the coverage / collapsedCov line worth pasting when filing), what leaves the device, measured vs estimated numbers, why a score says Calibrating, and the not-a-medical-device line.

In-repo rather than wiki: versioned, reviewable, and a link to it cannot rot the way these three did.

Scope: only the three FAQ links are repointed. Troubleshooting and WHOOP-5.0-and-MG-Status are still dead in six more places — that needs either real wiki pages or the same in-repo treatment, and I did not want to invent content for them. Worth deciding separately.

Verified: both issue templates still parse as YAML, every relative link in the new doc resolves, i18n gate green.

The bug template asks every reporter to confirm they checked the FAQ, and that link
was dead — github.com/ryanbr/noop/wiki/FAQ 302s to the bare wiki root, as do the
Troubleshooting and WHOOP-5.0-and-MG-Status links. The wiki has no pages, so the
.wiki.git repo does not exist either.

That is why the resting-HR explanation never reaches anyone. NOOP reports the lowest
sustained in-bed level while the WHOOP app shows something nearer the whole-night
mean, so NOOP reads 5-8 bpm lower by design. It is documented in ANALYTICS.md and in
a v7.0.0 release note saying it is 'answerable straight from the log' — which requires
exporting and reading a log. #550 is the master issue for it and #803 is the latest
report.

docs/FAQ.md answers that plus the questions that recur alongside it: HRV differing
from the app (with the coverage diagnostic to include when filing), what leaves the
device, which numbers are measured versus estimated, why a score says Calibrating,
and the not-a-medical-device line. In-repo rather than wiki so it is versioned and
reviewable, and so a link to it cannot rot the way these three did.

Only the FAQ links are repointed. Troubleshooting and WHOOP-5.0-and-MG-Status are
still dead in six places and need either wiki pages or the same in-repo treatment —
left as a separate decision rather than inventing content for them here.
@ryanbr
ryanbr merged commit 0105c64 into main Jul 25, 2026
1 check passed
ryanbr added a commit that referenced this pull request Jul 25, 2026
iOS 208 -> 209, Android 299 -> 300. MARKETING_VERSION/versionName stay 9.1.1:
nothing since the last staging build warrants a version bump — an in-repo FAQ,
a re-pair-guide placement fix, and a diagnostic log field.

Picks up three commits since a0970b1:
  0105c64 docs: in-repo FAQ, issue templates repointed off the dead wiki (#809)
  956727e re-pair guide on Devices, not only on Live (#802) (#810)
  3c0fa7c rrIntegrity verdict on the hrv diag line (#550) (#811)
@ryanbr
ryanbr deleted the docs/faq-in-repo branch August 2, 2026 07:41
simoncad7 pushed a commit to simoncad7/noop that referenced this pull request Aug 17, 2026
)

The bug template asks every reporter to confirm they checked the FAQ, and that link
was dead — github.com/ryanbr/noop/wiki/FAQ 302s to the bare wiki root, as do the
Troubleshooting and WHOOP-5.0-and-MG-Status links. The wiki has no pages, so the
.wiki.git repo does not exist either.

That is why the resting-HR explanation never reaches anyone. NOOP reports the lowest
sustained in-bed level while the WHOOP app shows something nearer the whole-night
mean, so NOOP reads 5-8 bpm lower by design. It is documented in ANALYTICS.md and in
a v7.0.0 release note saying it is 'answerable straight from the log' — which requires
exporting and reading a log. ryanbr#550 is the master issue for it and ryanbr#803 is the latest
report.

docs/FAQ.md answers that plus the questions that recur alongside it: HRV differing
from the app (with the coverage diagnostic to include when filing), what leaves the
device, which numbers are measured versus estimated, why a score says Calibrating,
and the not-a-medical-device line. In-repo rather than wiki so it is versioned and
reviewable, and so a link to it cannot rot the way these three did.

Only the FAQ links are repointed. Troubleshooting and WHOOP-5.0-and-MG-Status are
still dead in six places and need either wiki pages or the same in-repo treatment —
left as a separate decision rather than inventing content for them here.
simoncad7 pushed a commit to simoncad7/noop that referenced this pull request Aug 17, 2026
iOS 208 -> 209, Android 299 -> 300. MARKETING_VERSION/versionName stay 9.1.1:
nothing since the last staging build warrants a version bump — an in-repo FAQ,
a re-pair-guide placement fix, and a diagnostic log field.

Picks up three commits since a0970b1:
  0105c64 docs: in-repo FAQ, issue templates repointed off the dead wiki (ryanbr#809)
  956727e re-pair guide on Devices, not only on Live (ryanbr#802) (ryanbr#810)
  3c0fa7c rrIntegrity verdict on the hrv diag line (ryanbr#550) (ryanbr#811)
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