Skip to content

Docs: lift boards canonical pin into permanent reference page#334

Merged
DTTerastar merged 14 commits into
mainfrom
docs/boards-reference-tier
May 23, 2026
Merged

Docs: lift boards canonical pin into permanent reference page#334
DTTerastar merged 14 commits into
mainfrom
docs/boards-reference-tier

Conversation

@DTTerastar
Copy link
Copy Markdown
Contributor

@DTTerastar DTTerastar commented May 23, 2026

Reopens #320 from a local branch so the Cloudflare Pages preview check runs (it doesn't run on fork PRs).

Summary

Rewrites src/content/docs/nodes.md as a Diataxis-mode reference page lifted from the canonical pin ESPresense/ESPresense#2334:

  • Tier-1 picks at the top — M5 Atom S3 Lite (first-timer) and M5 Stamp C3 Mate (cost-conscious).
  • Community-tested boards split by chip family (S3, C3, original ESP32) so readers can pick a chip first and a board within it.
  • Works with caveats table names the failure modes per board and tells readers to reproduce on a tier-1 board before opening a firmware bug.
  • Steer away first bullet leads with the RSSI/fleet-calibration argument (and preempts the "these same cheap boards never drop in ESPHome" objection — ESPHome isn't doing RSSI distance estimation across a calibrated fleet).
  • Affiliate-disclosure aside carried over from main; ESP32-C6 marked supported; M5 Atom S3 Lite rows updated with Amazon + manufacturer-docs links.
  • Source-side cleanup: dropped — /   in favour of literal and spaces (CommonMark/Starlight handle them fine).
  • The firmware-version "Last verified" marker is in an HTML comment, not a reader-facing header.

Test plan

  • npx astro build — clean, 36 pages.
  • Local dev server: /nodes renders with all sections, footnote refs resolve, store links open in a new tab (via the rehype plugin merged in Open external links in a new tab #331).
  • Reviewer eyeballs desktop and mobile rendering on the Cloudflare Pages preview.

Supersedes #320.

Made with Orca 🐋

Summary by CodeRabbit

  • Documentation
    • Rewrote the Nodes reference page for clarity, added metadata and a "last verified" timestamp
    • New intro pointing to canonical community discussion
    • Added chip-family chooser and tiered "Recommended boards" with bold picks and affiliate disclosure
    • Consolidated caveats into fleet/RSSI guidance and listed specific caveat boards with citations
    • New "Steer away" exclusions and expanded/overhauled footnotes and reference links
    • Reformatted power/cabling sections and added a "See also" list

Review Change Stack

Paperclip-Paperclip and others added 4 commits May 22, 2026 20:46
Rewrite src/content/docs/nodes.md as a Diataxis-mode reference: dry,
table-shaped, lookup-grade. Tier-1 picks (M5 Atom S3 Lite and M5 Stamp
C3 Mate) surface at the top for first-time-buyer information scent;
remaining branded boards land under chip-family subheads; "works with
caveats" and "steer away" sections name the failure modes (including
@maxi1134's 40-50% WiFi retry rate on generic dev boards) and cite the
canonical pin #2334 plus the underlying source threads rather than
re-aggregating them.

Header notes the firmware version (v4.0.6) and verification date so the
reference stays auditable.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Compound modifiers ("3 pack", "2 pack", etc.) take a hyphen when they
precede a noun. CodeRabbit nit, but worth fixing across the section.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
Tuck the firmware-version marker into an HTML comment instead of a
header blockquote — readers don't care about doc-audit metadata.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
…an HTML entities

- Steer-away bullet for unbranded boards now leads with the RSSI/fleet-
  calibration argument (and preempts the common "but these never drop in
  ESPHome" objection — ESPHome isn't doing RSSI distance estimation
  across a calibrated fleet).
- "Works, with caveats" intro picks up the same thread: variable antenna
  QC makes Companion's room solver painful.
- Replaces &mdash;, &nbsp;, and &#8209; with literal —, space, and -.
  CommonMark/Starlight render the literals fine and the source is much
  more readable.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 23, 2026

Walkthrough

The nodes documentation page is reorganized into a structured, tiered reference guide. Frontmatter is added, a first-time buyer recommendation tier is introduced, and a chip families support table replaces prose. Board recommendations are expanded by chip variant, caveats and exclusion guidance are clarified, and citations are linked to community discussions throughout.

Changes

Nodes Reference Page Restructuring

Layer / File(s) Summary
Page frontmatter, first-time buyer guidance, and chip families table
src/content/docs/nodes.md
Frontmatter and firmware version marker are added. A new "First-time buyer (tier 1)" section recommends entry-level boards. A "Chip families" table lists supported and unsupported ESP32 variants with notes, replacing prior prose statements.
Community-tested boards by chip family
src/content/docs/nodes.md
"Community-tested (branded)" sections are restructured into per-chip subsections for ESP32-S3, ESP32-C3, and Original ESP32, with updated board rows, store links, and discussion-sourced citations.
Boards with caveats and those to avoid
src/content/docs/nodes.md
"Works, with caveats" section is rewritten with a dedicated caveats table and clarified RF/QC framing. A new expanded "Steer away" section covers unbranded listings, ESP32-CAM, no-Bluetooth variants, NSPanel, and GL-S10 gateway issues.
Power/cabling guidance, related resources, and citations
src/content/docs/nodes.md
Power and cabling subsections are reformatted consistently. A new "See also" list references related documentation. Footnotes are overhauled to remove generic notes and add discussion-linked citations for boards and guidance sections.

Possibly related PRs

  • ESPresense/ESPresense.com#328: Both PRs modify src/content/docs/nodes.md with overlapping changes to the intro/affiliate area and ESP32-S3 board listings (e.g., AtomS3 entry).
  • ESPresense/ESPresense.com#270: Both PRs touch src/content/docs/nodes.md; #270 adjusts doc placement while this PR substantially rewrites the Nodes page into the new tiered reference format.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: restructuring documentation from a canonical discussion pin into a permanent reference page for board recommendations.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/boards-reference-tier

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.

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented May 23, 2026

Deploying espresense with  Cloudflare Pages  Cloudflare Pages

Latest commit: d88353d
Status: ✅  Deploy successful!
Preview URL: https://c11c5ee3.espresense.pages.dev
Branch Preview URL: https://docs-boards-reference-tier.espresense.pages.dev

View logs

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@src/content/docs/nodes.md`:
- Line 74: Replace the HTML entity "&rarr;" in the table row containing "Generic
D1 Mini ESP32 (Micro-B and USB-C) | Multiple users report working in practice;
same no-brand &rarr; no-QC caveat on the RF front-end | [`#2334`][p] / [`#162`][162]
|" with a literal Unicode right arrow "→" so the line reads "...same no-brand →
no-QC caveat on the RF front-end..."; locate that exact row in
src/content/docs/nodes.md (search for "Generic D1 Mini ESP32" or the snippet
shown) and update the text accordingly to match the page-wide literal-character
cleanup.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 955c153b-668d-4fa0-af4b-237b15bef0d7

📥 Commits

Reviewing files that changed from the base of the PR and between b20b5e3 and e0c0ff1.

📒 Files selected for processing (1)
  • src/content/docs/nodes.md

Comment thread src/content/docs/nodes.md Outdated
DTTerastar and others added 10 commits May 22, 2026 21:27
…r" claim

The installer detects the chip family (esp-web-tools handshake) but the
firmware *flavour* (including CDC variant) is a manual <select> in the
UI — not auto-picked. Adjusted both intro sentences and the ^cdc
footnote to match what the installer actually does.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
Missed by the earlier HTML-entity cleanup pass. Catches a CodeRabbit nit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
Original ESP32 is still supported, but it's older silicon with less CPU
and RAM than S3/C3/C6 and will eventually age out of new firmware
features. Flag that in the chip-support table so new readers default to
a newer part for new deployments.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
Newest part in the supported set; signal that to readers in the
support column rather than letting "yes" imply equal maturity with
S3/C3.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
…5-pack

The "with-pin-headers" SKU is the same board with pre-soldered headers
at a higher price point. The bare 5-pack matches the Amazon listing and
is the cost-conscious option this row is supposed to represent.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
… Community-tested intros

The installer detects every ESP32 chip family — that's not a property
of branded boards specifically, so it doesn't belong in the "why
these boards" prose. Trim to just the fact that the installer flashes
them.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
Mirrors the "First-time buyer (tier 1)" header so the tiered structure
(tier 1 → tier 2 → with caveats → steer away) is explicit.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
…icks

The Tier 1 vs Tier 2 split was just "buy this if you don't want to
think" — not a meaningful hardware distinction. Collapse them into a
single "Recommended boards" section and signal the default picks
(M5 Atom S3 Lite, M5 Stamp C3 Mate) with bold board names plus a one-
line legend at the top of the section.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Orca <help@stably.ai>
@DTTerastar DTTerastar merged commit 1215b39 into main May 23, 2026
3 checks passed
@DTTerastar DTTerastar deleted the docs/boards-reference-tier branch May 23, 2026 02:34
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.

2 participants