Skip to content

Markdown audit — 1.17.1.5 USA Cascade

Audited on 2026-09-05 against firmware source 26303793, the resolved build configuration, and the qualified 1.17.1.5 staging manifests. The scope was all 71 tracked Markdown files present at the start, including root documents, docs, examples, tools, tests, variants, and vendored library documentation. Generated/ignored build directories and external repositories were outside that scope.

Corrections

  • Added role-specific feature switches, exact Companion/infrastructure MQTT and logging controls, board exceptions, SNMP, and the USB web console.
  • Added an exact-name variant map; every one of its 1,325 covered entries resolves to a staged firmware file. The 36 excluded entries are identified rather than linked to substitute hardware.
  • Corrected universal 254-neighbor claims, Full Companion MQTT filename/CLI assumptions, TLora Full WebConfig availability, and partition/NVS guidance.
  • Documented the power-saving guards present at audit time; current instructions now use the shared get powersaving / set powersaving on|off command set. Corrected the RS232 baud range and SNMP environment list.
  • Linked OTAFIX 2.4.6 and its board/storage requirements from operator guides; aligned the two manual USA OTA quickstarts with 910.525 MHz.
  • Marked old provider catalogs and dated hardware results as historical; documented the legacy tag workflow that also matches repeater-room-*.
  • Fixed the vendored MQTT documentation link and documentation-site links that incorrectly treated repository source files as generated site pages.

Verification and limits

All original Markdown files were scanned for relative links, section anchors, source-path references, version/default claims, and role/OTA terminology. Flagged operator instructions were checked against CommonCLI, its observer extension, Companion command handlers, board configuration, and release manifests. Brace-expanded source references and SDK-relative paths were retained as such. Historical measurements, changelogs, upstream findings, contribution/security policies, and licenses were not rewritten as new validation results.

The documentation site passed a strict MkDocs Material build. Relative repository links and section anchors were checked separately, including documents outside the MkDocs source directory. Console and current bootloader links were checked on their primary sites. This was not a crawl of every third-party URL or a new hardware/firmware qualification; no claim is made that every board was physically tested or every protocol statement independently re-proved.

Original file coverage

“Retained” means no correction was identified by this documentation audit; it does not certify all historical statements as current hardware behavior.

File Disposition
AGENTS.md Scanned; retained
ALERTS.md Scanned; retained
CHANGELOG.md Historical record retained
CONTRIBUTING.md Scanned; retained
MEMORY_MONITORING.md Scanned; retained
MQTT_IMPLEMENTATION.md Corrected or clarified
MQTT_INTERNALS.md Corrected or clarified
MQTT_OWNERSHIP.md Historical record retained
MQTT_SNMP.md Corrected or clarified
README.md Corrected or clarified
RELEASE.md Corrected or clarified
RESTORE_UPSTREAM_NOTES.md Historical record retained
SECURITY.md Scanned; retained
STABILITY_TESTABILITY_HANDOFF.md Historical record retained
UPSTREAM_BUGS.md Scanned; retained
WEB_CONFIG_REVIEW.md Corrected or clarified
arch/stm32/Adafruit_LittleFS_stm32/README.md Vendored documentation/license retained
arch/stm32/Adafruit_LittleFS_stm32/src/littlefs/LICENSE.md Vendored documentation/license retained
arch/stm32/Adafruit_LittleFS_stm32/src/littlefs/README.md Vendored documentation/license retained
docs/WiFi.md Corrected or clarified
docs/cli_build_matrix.md Corrected or clarified
docs/cli_command_availability.md Corrected or clarified
docs/cli_commands.md Corrected or clarified
docs/companion_offline_queue.md Scanned; retained
docs/companion_protocol.md Scanned; retained
docs/companion_radio_full.md Corrected or clarified
docs/docs.md Scanned; retained
docs/esp32_memory_budget.md Scanned; retained
docs/faq.md Corrected or clarified
docs/filter_tool.md Scanned; retained
docs/firmware_picker.md Corrected or clarified
docs/flood_filtering.md Scanned; retained
docs/full_companion_features.md Corrected or clarified
docs/full_companion_usb_switcher.md Corrected or clarified
docs/gps_tracking.md Scanned; retained
docs/halo_keymind_settings.md Corrected or clarified
docs/hardware_validation_checklist.md Corrected or clarified
docs/host_cli_service.md Scanned; retained
docs/index.md Corrected or clarified
docs/kiss_modem_protocol.md Scanned; retained
docs/lora_ota_automation.md Corrected or clarified
docs/mbedtls-tls-footprint.md Scanned; retained
docs/nrf52_companion_storage_recovery.md Scanned; retained
docs/nrf52_power_management.md Scanned; retained
docs/number_allocations.md Scanned; retained
docs/ota_easy.md Corrected or clarified
docs/ota_meshtower_v2_sdcard.md Corrected or clarified
docs/ota_nrf52_bootloader_update.md Corrected or clarified
docs/ota_nrf52_qspi.md Corrected or clarified
docs/ota_protocol.md Corrected or clarified
docs/ota_user_guide.md Corrected or clarified
docs/packet_format.md Scanned; retained
docs/payloads.md Scanned; retained
docs/qr_codes.md Scanned; retained
docs/rak3401_mota_chain.md Historical record retained
docs/releases/1.17.1.5.md Corrected or clarified
docs/spiffs_regular_file_reads.md Scanned; retained
docs/stats_binary_frames.md Scanned; retained
docs/telemetry_decoder.md Scanned; retained
docs/terminal_chat_cli.md Scanned; retained
docs/usb_serial_backpressure.md Scanned; retained
examples/host_cli_service/README.md Scanned; retained
lib/PsychicMqttClient/CHANGELOG.md Vendored documentation/license retained
lib/PsychicMqttClient/README.md Corrected or clarified
mesh-america/README.md Corrected or clarified
test/README.md Scanned; retained
test/test_mqtt_prefs_codec/FIXTURES.md Historical record retained
tools/mota/README.md Scanned; retained
tools/sensecap_indicator_font/README.md Scanned; retained
tools/sensecap_indicator_rp2040/README.md Scanned; retained
variants/sensecap_indicator-espnow/README.md Scanned; retained