Docs: lift boards canonical pin into permanent reference page#334
Conversation
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 —, , and ‑ 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>
WalkthroughThe 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. ChangesNodes Reference Page Restructuring
Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 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 |
Deploying espresense with
|
| Latest commit: |
d88353d
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c11c5ee3.espresense.pages.dev |
| Branch Preview URL: | https://docs-boards-reference-tier.espresense.pages.dev |
There was a problem hiding this comment.
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 "→" in the table row containing "Generic
D1 Mini ESP32 (Micro-B and USB-C) | Multiple users report working in practice;
same no-brand → 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
📒 Files selected for processing (1)
src/content/docs/nodes.md
…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>
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.mdas a Diataxis-mode reference page lifted from the canonical pin ESPresense/ESPresense#2334:—/ in favour of literal—and spaces (CommonMark/Starlight handle them fine).Test plan
npx astro build— clean, 36 pages./nodesrenders 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).Supersedes #320.
Made with Orca 🐋
Summary by CodeRabbit