Skip to content

docs: add OTA usage guide and update web-tools#56

Merged
zevorn merged 1 commit intomainfrom
feat/ota-docs-and-fixes
Mar 17, 2026
Merged

docs: add OTA usage guide and update web-tools#56
zevorn merged 1 commit intomainfrom
feat/ota-docs-and-fixes

Conversation

@zevorn
Copy link
Copy Markdown
Owner

@zevorn zevorn commented Mar 17, 2026

Summary

Add comprehensive OTA documentation to both English and Chinese docs.

usage.md (EN + ZH)

  • /ota shell commands added to command reference table
  • New OTA Tools section: ota_check, ota_update, ota_version, ota_rollback
  • Full OTA guide: how it works, configuration, version JSON format, local OTA server (make ota-server), trigger methods (shell + AI), GitHub Releases integration

web-tools.md (EN + ZH)

  • New Version selector step: latest (main) vs tagged releases
  • Document disabled state (no firmware) for tags without Release
  • Flash output now shows in Serial Monitor panel
  • Serial controls disabled during flashing (except expand)

Test plan

  • Docs render correctly in GitHub markdown preview
  • docs.html?doc=usage displays OTA sections
  • docs.html?doc=web-tools displays version selector docs

usage.md (EN + ZH):
- Add /ota shell commands to command reference table
- Add OTA Tools section (ota_check, ota_update, ota_version, ota_rollback)
- Add full OTA guide: how it works, configuration, version JSON format,
  local OTA server script, trigger methods, GitHub Releases integration

web-tools.md (EN + ZH):
- Add version selector step (latest/main vs tagged releases)
- Document "(no firmware)" disabled state for tags without Release
- Update flash output behavior (now in Serial Monitor panel)
- Note serial controls disabled during flashing

Signed-off-by: Chao Liu <chao.liu.zevorn@gmail.com>
@zevorn zevorn merged commit 85b9b2b into main Mar 17, 2026
1 check passed
@zevorn zevorn deleted the feat/ota-docs-and-fixes branch March 19, 2026 01:46
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