docs(guides): add Enrolling devices how-to (lifts canonical pin #2324)#321
Conversation
Converts the enrollment-friction discussion canonical pin into a
permanent how-to under Guides. Diataxis "how-to" mode with F-pattern
device-name headings, a 30-second triage table, and honest-limited
callouts for paths the community has not settled (Apple Watch, AirPods,
2025 Polar Loop, Find-My / SmartTag family).
Each per-device section cites its source thread (#1348, #2099, #492,
#1531, #2054, #1247, #880, #1202) and credits contributors by GitHub
handle. MQTT topic schema (espresense/settings/<id>/config retained)
and payload shape ({"id", "name", "rssi@1m"?}) verified against
firmware main (src/Enrollment.cpp sendConfig, src/mqtt.cpp:239-254).
Fingerprint prefixes (irk:, apple:findmy, mifit:, name:, smarttag:)
verified against src/BleFingerprint.cpp.
Wires the page into the Guides sidebar, cross-links from /apple
(directs non-Apple readers to the new how-to) and /android (BLE
Transmitter setup).
Last-verified header pinned to firmware v4.0.6 (2026-05-11).
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
Summary
/guides/enrolling-devicesso the answers don't disappear into Discussions search.What this PR is
Diataxis how-to, F-pattern headings (device name left-justified —
## iPhone, not "How to enroll an iPhone"), scannable triage table at the top, source threads + GitHub-handle credits in every section.Verification
Last verified against firmware v4.0.6(2026-05-11) — pinned in the page header.irk:/mifit:/name:example checked against firmwaremain:src/mqtt.cppsendConfig()(topicCHANNEL/settings/<id>/config, retained; payload{"id", "name", "rssi@1m"?}).irk:,apple:findmy,mifit:,name:,smarttag:,iTrack:,tile:,garmin:) checked againstsrc/BleFingerprint.cpp.npm run build(under node 22) passes; new page generates atdist/guides/enrolling-devices/index.html; sidebar entry rendered; all in-page anchors to/apple/#apple-watch-using-bluetooth-terminal-appand/apple/#lookup-method-requires-a-macresolve.Source threads (with credits)
/androidOut of scope
Acceptance check
ESPresense/ESPresense.com.main.Last verified against firmware v4.0.6+ date in header.Test plan
npm run buildand click through/guides/enrolling-deviceson the preview deploy/appleresolve on the deploy URL🤖 Generated with Claude Code