Repository navigation
feat(docs): firmware learning reference and warning-free API docs - #126
Merged
Merged
Conversation
Add docs/firmware/: an index (reading order, crate map, the two toolchains) and one page each on the eFuse identity and key hierarchy, frame sealing and the replay window, ESP-NOW and channel following, deep sleep and the power budget, the setup button, the BLE setup protocol and the Hub radio coexistence findings, each pointing to the code by path and symbol. Document every public item of packages/rs: proto comments now become the rustdoc of the generated wire types (setup_v1 and device_v1 are documented re-export modules, no missing_docs allow remains), and the two rustdoc warnings are fixed at their source (crypto-spec generator, sensing link). The Docs workflow gains a Rust docs job that runs cargo doc with RUSTDOCFLAGS=-D warnings, and check-commands covers docs/firmware. Story 10.4 (EPM-T142). Closes #125 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_018Sd7EdRqgJpnHKoTh2Fsia
This was referenced Oct 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Story 10.4 — Zoho EPM-T142 (task list: Coldframe V1 – bmad-loop story 10-4).
Summary
docs/firmware/: index + 7 topic pages (identity/eFuse + HKDF, sealing + replay, ESP-NOW + channel following, deep sleep + power budget, buttons, BLE setup + PoP, radio coexistence), each with code pointers by path and symbol.packages/rs/*is documented: proto comments become rustdoc for the generated wire types (missing_docsallow removed;setup_v1/device_v1are documented re-export modules); 8 proto enum values got comments (comment-only).envlink in sensing).cargo doc --no-depsover the 7 crates,RUSTDOCFLAGS=-D warnings, incl.coldframe-hal/mock); root Cargo files added to its path filters;check-commands.shnow coversdocs/firmware/*.md(with a fixture test).ci.ymluntouched.README.md,apps/rs/README.md,packages/rs/README.md.Test plan
RUSTDOCFLAGS="-D warnings" cargo doc --no-deps --locked --features coldframe-hal/mock -p …(7 crates): 0 warningscargo fmt --check,cargo clippy --workspace --all-targets --locked -- -D warnings,cargo test --workspace --lockedpnpm --filter @coldframe/crypto-spec run check: outputs freshdocs/test.sh(50/50),docs/check-links.sh(819 resolve),docs/check-commands.sh --listcargo build --releaseofapps/rs/nodeandapps/rs/hub(esp toolchain)buf lint/ breaking andactionlint(not installed locally; CI)Closes #125
🤖 Generated with Claude Code
https://claude.ai/code/session_018Sd7EdRqgJpnHKoTh2Fsia