Skip to content

docs(guides): lift calibration canonical pin into permanent how-to#322

Merged
DTTerastar merged 1 commit into
ESPresense:mainfrom
Terastar-Paperclip:docs/calibration-how-to
May 11, 2026
Merged

docs(guides): lift calibration canonical pin into permanent how-to#322
DTTerastar merged 1 commit into
ESPresense:mainfrom
Terastar-Paperclip:docs/calibration-how-to

Conversation

@Terastar-Paperclip
Copy link
Copy Markdown
Contributor

Summary

Rewrites src/content/docs/guides/calibration.md as a proper how-to that lifts the maintained community pin #2323 "Calibration — start here" and four user-voice source threads into a permanent docs page.

  • Adds a 30-second triage table at the top so readers land on the right setting before reading prose.
  • Verifies every setting + MQTT key (ref_rssi, rx_adj_rssi, absorption, forget_ms) against firmware v4.1.0b0. Includes the EDDYSTONE_ADD_1M = -41 firmware constant that trips up hand-calibrators.
  • Failure-mode callouts cite source threads and credit the original users (per the project's "quote and credit, don't invent fresh wording" rule):
  • Frames Companion auto-optimization as the easy path so most users don't have to hand-tune.
  • New "Floorplan drift is a different problem" sidebar separates my distances are wrong (this page) from my coordinates are wrong (Companion-side); these two get conflated on a regular basis.
  • Page header carries Last verified against firmware v4.1.0b0 on 2026-05-10 so freshness is visible to readers.

Part of the first docs-from-Discussions pass. Boards (#320) and enrollment (#321) ship alongside as sibling PRs.

Test plan

  • Page renders correctly on the live preview (Starlight admonitions, table, headings).
  • Internal links resolve: /apple, /configuration/settings#calibration, /companion/optimization.
  • Mobile width: the floated calibration screenshot doesn't overlap the triage table.
  • After merge: ping Community Manager to add ## See the docs page → at the top of the canonical pin #2323 and bump Last updated:.

🤖 Generated with Claude Code

Rewrite guides/calibration.md as a proper how-to (Diataxis: how-to,
inverted pyramid). Lift content from the maintained community pin
#2323 plus four user-voice source threads (#353, ESPresense#213, #1687, #1817).

Highlights:

- 30-second triage table at the top so people land on the right
  setting before reading prose.
- Settings procedure verified against firmware v4.1.0b0 (main),
  including the MQTT keys (ref_rssi/rx_adj_rssi/absorption/forget_ms)
  and the EDDYSTONE_ADD_1M = -41 firmware constant.
- Failure-mode callouts cite source threads and quote/credit the
  original users rather than inventing fresh wording.
- Companion auto-optimization framed as the easy path.
- Floorplan-drift sidebar separates "my distances are wrong" from
  "my coordinates are wrong" — the two get confused on a regular
  basis.

Closes the calibration leg of the docs-from-Discussions pipeline
(ESPA-40). Boards and enrollment ship in sibling PRs.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 11, 2026

Warning

Rate limit exceeded

@Terastar-Paperclip has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 26 minutes and 13 seconds before requesting another review.

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 @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: d7bf9247-dc38-4e6f-8477-463713b634ba

📥 Commits

Reviewing files that changed from the base of the PR and between 8774f39 and f0ff0b7.

📒 Files selected for processing (1)
  • src/content/docs/guides/calibration.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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 and usage tips.

@Terastar-Paperclip
Copy link
Copy Markdown
Contributor Author

@DTTerastar — calibration how-to page is ready for your review whenever you have a window.

State

  • src/content/docs/guides/calibration.md (70 → 167 lines): triage table → procedure → per-setting detail → failure-mode callouts → Companion auto-opt → floorplan-drift sidebar.
  • MQTT keys + EDDYSTONE_ADD_1M verified against firmware v4.1.0b0.
  • Failure-mode callouts cite source threads + users (Zipties Update configuration.md (## node placement) #213, scargill #1687, plackettsj1 #1817, Erwinsmith101 #353) — quote-and-credit, no invented procedure.
  • CodeRabbit: SUCCESS. Mergeable. REVIEW_REQUIRED is the only gate.

On merge, Community Manager auto-pings discussion #2323 with the ## See the docs page → pointer comment (already wired via ESPA-40 wake).

No rush — flagging it because Paperclip's liveness check correctly noticed there was no agent-side path to advance from in_review. Whenever you merge (or push back), that closes the loop.

@DTTerastar DTTerastar enabled auto-merge (squash) May 11, 2026 19:12
@DTTerastar DTTerastar merged commit d967834 into ESPresense:main May 11, 2026
1 check 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.

3 participants