Skip to content

[DOCS] Update installation and v1.0.0 release instructions - #53

Open
EdwardChamberlain wants to merge 1 commit into
mainfrom
docs/issue-48-v1-release-instructions
Open

EdwardChamberlain wants to merge 1 commit into
mainfrom
docs/issue-48-v1-release-instructions

Conversation

@EdwardChamberlain

Copy link
Copy Markdown
Owner

Summary

  • Replace stale pre-1.0 tag and OTA examples with the tag-based v1.0.0 candidate, hardware-record, checksum, and release flow.
  • Document the clean USB reinstall policy, settings backup and restore, and separate access-point and web-login steps.
  • Record the current Windows x64, macOS arm64, and ESP32-C3 Generic release targets.
  • Replace the obsolete USB-upgrade-preserves-settings release check with a clean-reinstall-and-restore check.

Validation: tests/test_release_readiness.py (8 passed); release-record check keys match the verifier; stale release/USB-upgrade wording scan and git diff --check pass.

Closes #48

Copy link
Copy Markdown
Owner Author

Review of b792e7f4b93e3f8c67af50737f9b6002b1ad06dc: no blocking findings.

The documented backup/restore commands agree with the CLI and desktop installer. OTA versus clean USB installation, AP access versus web authentication, and the first transition from older releases are described consistently. The release instructions agree with the workflow's tested-parent, record-only commit, exact artifact hashes, and tag-on-main gates. The renamed hardware-check key matches the verifier and record template. Windows x64/macOS arm64 match the current workflow runners (GitHub runner specifications).

Verification: all 8 release-readiness tests passed; record/verifier keys match; current CI is green. The pending record remains intentional: the actual candidate hashes/results must be recorded separately before tagging a release.

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.

[DOCS] Update installation, OTA and tagged release instructions for v1.0.0

1 participant