Add documentation about firmware versioning scheme #220
Conversation
|
Visit the preview URL for this PR (updated for commit 9ca7be6): https://hw-api-documentation--pr220-firmware-versioning-tyqhihrb.web.app (expires Thu, 11 Dec 2025 10:24:26 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 4accc1c887f1346ec9c563d5645c74c94f610c07 |
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation about the firmware versioning scheme used by HomeWizard products to the existing versioning documentation page.
Key Changes:
- Added a new "Firmware Versions" section explaining the
x.yyandx.yyzzversion formats - Included practical examples showing how to parse version numbers (e.g.,
1.23,2.1501) - Added links to firmware release notes and update verification guide
- Updated spell checker configuration to accept the version format notation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/versioning.mdx | Adds new section documenting firmware version formats, with examples and links to release notes and update guides |
| .cspell.yml | Adds x.yyzz version notation to dictionary to prevent false spelling errors |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - `y` is the **minor** version | ||
| - `z` is the **patch** version (optional) |
There was a problem hiding this comment.
The description is ambiguous about digit representation. The format x.yyzz uses two digits for minor (yy) and two digits for patch (zz), but the bullet list suggests y and z are single entities. Consider clarifying: "In the x.yyzz format, the minor version uses two digits and the patch version uses two digits" or revising the format notation to use subscripts or clearer notation.
| - `y` is the **minor** version | |
| - `z` is the **patch** version (optional) | |
| - `yy` is the **minor** version (two digits) | |
| - `zz` is the **patch** version (optional, two digits) |
| {"error": "request:api-version-not-supported"} | ||
| ``` | ||
|
|
||
| ## Firmware Versions |
There was a problem hiding this comment.
The heading should end with a period to match the existing documentation convention. Throughout this file, all major headings (##) end with periods (e.g., "## Version Scheme.", "## Requesting a Specific API Version."). Should be ## Firmware Versions.
| ## Firmware Versions | |
| ## Firmware Versions. |
1 participant
No description provided.