Docs: lift boards canonical pin into permanent reference page#320
Docs: lift boards canonical pin into permanent reference page#320Terastar-Paperclip wants to merge 1 commit into
Conversation
WalkthroughThe nodes documentation page is comprehensively reorganized and expanded. A new front matter section, verification notice, and tiered board selection guidance lead readers. Community-tested boards are grouped by chip variant (ESP32-S3, ESP32-C3, Original). A detailed caveats table and new "steer away" section address edge cases and exclusions. Power and cabling guidance is restructured into typed subsections. Footnotes are refreshed with discussion URL references. ChangesNodes Hardware Reference Documentation
Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ 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 |
DTTerastar
left a comment
There was a problem hiding this comment.
ESP32-C6 is NOW supported!
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>
9faedf2 to
30afb96
Compare
There was a problem hiding this comment.
🧹 Nitpick comments (1)
src/content/docs/nodes.md (1)
89-89: 💤 Low valueConsider hyphenating pack quantities for style consistency.
Compound modifiers like "3 pack" should be hyphenated as "3-pack" when they precede a noun, per standard English style guides. This applies to several product descriptions in the power and cabling section.
📝 Proposed style fixes
-* [20W USB-C Wall Charger (3 pack)](https://amzn.to/4hFLcBz) +* [20W USB-C Wall Charger (3-pack)](https://amzn.to/4hFLcBz)-* [Dual USB-A 3 pack](https://amzn.to/4iA0EAq) — compact cube design +* [Dual USB-A 3-pack](https://amzn.to/4iA0EAq) — compact cube design-* [16 ft, 2 pack](https://amzn.to/3zzTTXW) -* [1 ft, 6 pack](https://amzn.to/3kyD8Is) -* [Straight adapter 4 pack](https://amzn.to/4hNrh3O) -* [Right-angle adapter 4 pack](https://amzn.to/4bWWH6o) +* [16 ft, 2-pack](https://amzn.to/3zzTTXW) +* [1 ft, 6-pack](https://amzn.to/3kyD8Is) +* [Straight adapter 4-pack](https://amzn.to/4hNrh3O) +* [Right-angle adapter 4-pack](https://amzn.to/4bWWH6o)As per coding guidelines, the static analysis tool LanguageTool flagged this style inconsistency.
Also applies to: 99-99, 103-106
🤖 Prompt for 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. In `@src/content/docs/nodes.md` at line 89, Update the product descriptions to hyphenate compound modifiers like "3 pack" to "3-pack" for style consistency; specifically replace occurrences such as "[20W USB-C Wall Charger (3 pack)]" with "[20W USB-C Wall Charger (3-pack)]" and make the same change for the other flagged entries (references 99-99 and 103-106) to ensure all pack quantities use the "N-pack" form.
🤖 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.
Nitpick comments:
In `@src/content/docs/nodes.md`:
- Line 89: Update the product descriptions to hyphenate compound modifiers like
"3 pack" to "3-pack" for style consistency; specifically replace occurrences
such as "[20W USB-C Wall Charger (3 pack)]" with "[20W USB-C Wall Charger
(3-pack)]" and make the same change for the other flagged entries (references
99-99 and 103-106) to ensure all pack quantities use the "N-pack" form.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e9a64adf-5182-4264-a48d-be2bbf49df4c
📒 Files selected for processing (1)
src/content/docs/nodes.md
Summary
Rewrites
src/content/docs/nodes.mdas a Diataxis-mode reference page lifted from the canonical pin ESPresense/ESPresense#2334:Last verified against firmware v4.0.6 — 2026-05-11— so the reference stays auditable.No quality claims appear that aren't already in #2334 or already in nodes.md. Affiliate links are carried over verbatim from the previous nodes.md.
Closes ESPA-52.
Test plan
npx astro build— clean, /nodes renders with 6 tables, footnote refs resolve, all 33 pages built.Follow-up
Once merged, ESPA-40 tracks pinging the Community Manager to update #2334 with a pointer to the new reference page.
🤖 Generated with Claude Code
Summary by CodeRabbit