Skip to content

docs: add general INAV upgrade guide to Getting Started - #22

Open
Raffi1202 wants to merge 1 commit into
iNavFlight:masterfrom
Raffi1202:docs/port-upgrading-guide
Open

docs: add general INAV upgrade guide to Getting Started#22
Raffi1202 wants to merge 1 commit into
iNavFlight:masterfrom
Raffi1202:docs/port-upgrading-guide

Conversation

@Raffi1202

Copy link
Copy Markdown

Part of moving the GitHub wiki onto the docs site. Ports "Upgrading from an older version of INAV to the current version" to docs/03-getting-started/07-upgrade-inav.mdx.

Written version-independent on purpose

The wiki page was pinned to specific releases and went stale every cycle. This one describes the procedure instead: back up the configuration, note version and target, adjust the settings the new release changed, flash with Full chip erase, restore, upload the OSD font again, recalibrate, and check on the bench before flying.

Release-specific settings changes are deliberately not duplicated here - the page points at the release notes, which is the one place they are maintained.

Checked, not transcribed

The wiki text was stale, so every step was verified against the current sources:

  • Configurator button labels and the backup, restore and migration flow: locale/en/messages.json, tabs/cli.html, tabs/firmware_flasher.html, tabs/firmware_flasher_restore.js, js/backup_restore.js, js/migration
  • CLI behaviour of diff, diff all, dump, defaults and save: src/main/fc/cli.c
  • the OSD font warning: src/main/io/osd.c

Also

Both links to the old wiki page in docs/02-release-notes.mdx now point at the new page.

That file is also touched by #19, on different lines. The two merge cleanly, checked with git merge-tree.

Ports the wiki page "Upgrading from an older version of INAV to the
current version" into the docs site as a version-independent procedure:
back up the configuration, note version and target, adjust the settings
for the new release, flash with Full chip erase, restore, upload the OSD
font again, recalibrate and check on the bench.

The wiki text was stale, so every step was checked against the current
sources instead of transcribed. Configurator button labels and the
backup, restore and migration flow come from the Configurator source
(locale/en/messages.json, tabs/cli.html, tabs/firmware_flasher.html,
tabs/firmware_flasher_restore.js, js/backup_restore.js, js/migration).
The CLI behaviour of diff, diff all, dump, defaults and save comes from
the firmware source (src/main/fc/cli.c), and the OSD font warning from
src/main/io/osd.c. Release-specific settings changes are not duplicated
here, the page points at the release notes for those.

Both links to the old wiki page in the release notes now point at the
new page.
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can switch off images and animations for a plain-text comment

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Add version-independent INAV upgrade guide

📝 Documentation 🕐 10-20 Minutes

Grey Divider

AI Description

• Adds a version-independent, seven-step INAV upgrade procedure with safety checks.
• Documents backup, migration, flashing, restoration, OSD, calibration, and bench verification.
• Redirects legacy release-note links from the GitHub Wiki to maintained documentation.
Diagram

graph TD
  B["Back up config"] --> V["Record target"] --> N["Review release notes"] --> F["Flash and erase"] --> R{"Restore method"}
  R --> A["Auto migration"] --> C["Post-upgrade checks"]
  R --> M["Manual CLI"] --> C
Loading
High-Level Assessment

The version-independent procedure is the best approach because upgrade mechanics remain centralized while release-specific setting changes stay in the release notes. Embedding version-by-version changes or retaining the Wiki page was considered but would duplicate information and predictably become stale.

Files changed (2) +211 / -2

Documentation (2) +211 / -2
02-release-notes.mdxRedirect upgrade references to the maintained guide +2/-2

Redirect upgrade references to the maintained guide

• Replaces both links to the legacy GitHub Wiki upgrade page with relative links to the new Getting Started guide.

docs/02-release-notes.mdx

07-upgrade-inav.mdxDocument the complete INAV upgrade workflow +209/-0

Document the complete INAV upgrade workflow

• Adds a version-independent upgrade guide covering configuration backups, release-note review, full-chip-erase flashing, automatic and manual restoration, OSD fonts, recalibration, and bench testing. It also explains version compatibility, unsupported legacy hardware, and when very old configurations should be rebuilt.

docs/03-getting-started/07-upgrade-inav.mdx

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