Skip to content

docs(firmware): follow-up review fixes for the firmware reference - #128

Merged
snovak7 merged 1 commit into
mainfrom
docs/epm-t143-gh127-follow-up-review-firmware-learning
Oct 20, 2026
Merged

snovak7 merged 1 commit into
mainfrom
docs/epm-t143-gh127-follow-up-review-firmware-learning

Conversation

@snovak7

@snovak7 snovak7 commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Follow-up review pass on the firmware learning reference (story 10-4, first pass in #126). Four review layers re-checked the diff since the baseline. The edge-case and verification-gap layers found nothing, and a script check confirmed that every backticked identifier in docs/firmware/ exists in the code. Six low-severity wording fixes:

  • setup.proto: the WIFI_SECURITY_WPA2_PERSONAL comment covers WPA and mixed WPA/WPA2, as the Hub maps them (comment-only).
  • deep-sleep.md: AD-17 cited by its real title.
  • identity.md: the release-guard excerpt is labelled as the Node's.
  • ble-setup.md: "ATT MTU minus 3" reconciled with the crate's "ATT MTU − 4".
  • buttons.md: take_pins! named as a macro.
  • Node and Hub READMEs link the firmware reference.
  • Story 10-4 spec: follow-up triage log (20 findings: 0 high, 0 medium, 15 low, 5 false) and run result.

Closes #127

Test plan

  • RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --locked --features coldframe-hal/mock over the 7 packages/rs crates
  • cargo fmt --check, cargo clippy --workspace --all-targets --locked -- -D warnings
  • cargo test --workspace --locked (350 passed)
  • docs/check-links.sh (821 resolve), docs/check-commands.sh --list, docs/test.sh (50/50)
  • buf lint / buf breaking (not installed locally; the change is comment-only, so CI covers it)

🤖 Generated with Claude Code

https://claude.ai/code/session_017VX7RCLKLixMA3yYfkJNZm

- WIFI_SECURITY_WPA2_PERSONAL proto comment covers WPA and mixed
  WPA/WPA2, matching the Hub's mapping (comment-only)
- deep-sleep.md cites AD-17 by its real title
- identity.md labels the release-guard excerpt as the Node's
- ble-setup.md reconciles "ATT MTU minus 3" with the crate's MTU - 4
- buttons.md names take_pins! as a macro
- Node and Hub READMEs link the firmware reference
- story 10-4 spec: follow-up review triage log and run result

Closes #127

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_017VX7RCLKLixMA3yYfkJNZm
@snovak7 snovak7 self-assigned this Oct 20, 2026
@snovak7
snovak7 merged commit cd033ba into main Oct 20, 2026
17 checks passed
@snovak7
snovak7 deleted the docs/epm-t143-gh127-follow-up-review-firmware-learning branch October 20, 2026 12:32
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.

Follow-up review: firmware learning reference (bmad-loop story 10-4)

1 participant