Skip to content

docs: README review - broken link, a wrong claim, and the missing recent fixes - #17

Merged
Em3ritus merged 1 commit into
mainfrom
docs/readme-review-2026-10-07
Oct 7, 2026
Merged

Em3ritus merged 1 commit into
mainfrom
docs/readme-review-2026-10-07

Conversation

@Em3ritus

@Em3ritus Em3ritus commented Oct 7, 2026

Copy link
Copy Markdown
Owner

A pass over the README, checking each claim against the code on main.

Fixed

Checked and left alone (all match the code): posture words, pairing/health strings, the 15-min ADDR_MAX_ONAIR_MS, five probe archetypes, the 21% named-probe share, the six presets, GPIO6 battery divider, the IDF versions vs CI, no flash/NVS encryption, every referenced file and tool README.

🤖 Generated with Claude Code

…ent fixes

- Jump-to: the Architecture link pointed at #architecture--the-nodes; the
  heading's dash became a hyphen, so the anchor is #architecture---the-nodes.
  Add the "What it doesn't do" section, which had no link.
- Recent updates claimed Wi-Fi probe shape is learned at runtime. It isn't:
  probe_frame.c ships a fixed table of five capture-derived archetypes. Only
  BLE AD structure is learned. Say what actually happened to each.
- Recent updates and CHANGELOG had nothing on #12, #14 or #15 (the flasher
  key block, C5 rev v1.2 flashing, C6 enrollment), the fixes users hit.
- Name the surveillance signatures (Flock, Axon) the detector carries.
- Reflow the follower bullet from #16.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Em3ritus
Em3ritus merged commit 0c3b918 into main Oct 7, 2026
4 checks passed
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.

1 participant