Skip to content

feat(docs): build a Node and a Hub from the docs - #120

Merged
snovak7 merged 4 commits into
mainfrom
feat/epm-t140-gh119-build-a-node-and-a-hub-from-the-docs
Oct 19, 2026
Merged

snovak7 merged 4 commits into
mainfrom
feat/epm-t140-gh119-build-a-node-and-a-hub-from-the-docs

Conversation

@snovak7

@snovak7 snovak7 commented Oct 19, 2026

Copy link
Copy Markdown
Contributor

Summary

  • hardware/: a reference Node and Hub design under Apache-2.0, labelled "not yet bench-verified". It has ASCII block diagrams and connection tables, a BOM with the requirement each part must meet, and a full pin-to-pin wiring list tied to pins.rs (switched probe power, high-side switched battery divider). It also has enclosure notes and probe sealing.
  • docs/build/: an adopter build guide.
    • flash.md opens with the irreversible eFuse burn and dev mode. It covers flashing over USB with espflash from release binaries (with a SHA256SUMS check) or from source, first boot and the setup code (Hub at first boot, Node on a 3 s press), download mode, the buttons, WPA2, and erase-region recovery.
    • power.md covers panel placement above the canopy, the ≤ ~100 µA sleep budget and how to measure it, and why soil % and battery % are approximate.
  • A new Docs workflow, which is not a required check, and ci.yml is untouched:
    • docs/check-links.sh resolves every relative link and referenced repo path.
    • docs/check-commands.sh runs every <!-- ci:run --> block against the firmware crates (build only) and checks the subcommands of <!-- ci:hardware --> blocks.
    • docs/test.sh holds 44 fixture tests, including a check that the documented toolchain pins match ci.yml.

Story 10-2 (bmad-loop). It is finished as far as an agent can take it. A human still owes the bench build, a real flash, datasheet checks and the sleep-current measurement; these are listed under operator_actions in the spec.

Closes #119

Test plan

  • docs/test.sh: 44 passed
  • docs/check-links.sh: 419 links and paths in 25 files resolve
  • docs/check-commands.sh: 14 blocks pass locally (Hub and Node release and dev-mode builds, save-image --merge, espflash subcommands)
  • gitleaks over the branch commits: no leaks
  • Docs workflow green on this PR (first run on GitHub)
  • Bench: build, flash and measure a real Node and Hub (operator actions)

🤖 Generated with Claude Code

https://claude.ai/code/session_01XJ9QyLY9aHkpAdZQsUJN3n

snovak7 and others added 4 commits October 19, 2026 20:53
…ed and reviewed via bmad-loop (awaiting operator)
Add a reference Node and Hub design under hardware/ (schematics as
connection tables, BOM, wiring with the switched probe power and battery
divider, enclosure and probe sealing) and an adopter build guide under
docs/build/ (flashing with espflash from release binaries or source,
first boot and the setup code, the irreversible eFuse burn and dev mode,
power budget and placement). A new Docs workflow resolves every relative
link and referenced path and runs the guide's build commands against the
firmware crates, build only.

Closes #119

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01XJ9QyLY9aHkpAdZQsUJN3n
@snovak7 snovak7 self-assigned this Oct 19, 2026
@snovak7
snovak7 merged commit 05c2837 into main Oct 19, 2026
16 checks passed
@snovak7
snovak7 deleted the feat/epm-t140-gh119-build-a-node-and-a-hub-from-the-docs branch October 19, 2026 20:56
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.

Build a node and a hub from the docs

1 participant