Align Documentation With Current Firmware Behavior

2026-08-30 19:11:39 +02:00
parent f227a2026f
commit 7b87375980
6 changed files with 56 additions and 140 deletions
@@ -44,12 +44,6 @@ No authored `src/*.{c,h}` `TODO`, `FIXME`, `XXX`, or `HACK` markers were found d
 These observations should be checked when touching the relevant area; they are not automatically bugs requiring unrelated cleanup.

 - `src/main.c` logs a Phase 7E startup banner although the implementation/roadmap is at Phase 8C.
- `docs/command_reference.md` calls `web credentials show` physical-console-only in one row, while current source and surrounding text allow it to authenticated admin SSH.
- The same reference describes interactive `user key add <username>` as a physical UART0 prompt, but transport-neutral prompt code allows it over admin SSH.
- Historical Phase 7 electrical-test steps expect Select to remain read-only and describe a powered state before automatic OLED initialization; current firmware has local controls and initializes the display during boot.
- `README.md`'s NVS partition-purpose list omits the `local_ui/config` blob.
- `README.md` links Adafruit product 6253, while `src/board_pins.h` and `docs/wiring.md` identify product 5988. **Needs verification:** whether this is an intentional male/female breakout distinction.
- `docs/user_administration_tests.md` contains historical Phase 8A/8B behavior that differs from current Phase 8C admin SSH routing. Treat phase-specific sections as historical procedures.
 - Manual completion candidates omit implemented `wifi next-profile`.
 - Some source comments still call shared commands UART0-only or call the current local status/control task read-only.
 - `USER_DATABASE_LOAD_EMPTY` and the corresponding `main.c` log branch appear reserved or vestigial; the current missing-storage success path migrates valid legacy credentials. **Needs verification** before removing or repurposing.
@@ -60,7 +54,6 @@ These observations should be checked when touching the relevant area; they are n
 - Complete the documented Phase 8C target-hardware validation before marking it complete.
 - Confirm task-local Newlib standard-stream behavior if ESP-IDF/Newlib configuration changes; admin SSH command output relies on dispatcher-task stream redirection.
 - Revalidate software-crypto/watchdog behavior before changing crypto acceleration or PSRAM placement.
- Verify the Adafruit breakout product identity and reconcile hardware documentation.
 - If HTTPD concurrency configuration changes, verify whether the boot-local Basic-authentication cache needs explicit locking.
 - Treat serial-service exclusivity as an architectural contract: its public read/write APIs do not themselves prove that only the broker calls them.