Skip to content

docs(hardware-overview): correct stale DroneCAN claim for INAV 10.0 - #16

Open
daijoubu wants to merge 1 commit into
iNavFlight:masterfrom
daijoubu:fix/hardware-overview-dronecan-sensor-stale
Open

docs(hardware-overview): correct stale DroneCAN claim for INAV 10.0#16
daijoubu wants to merge 1 commit into
iNavFlight:masterfrom
daijoubu:fix/hardware-overview-dronecan-sensor-stale

Conversation

@daijoubu

@daijoubu daijoubu commented Sep 3, 2026

Copy link
Copy Markdown

Summary

The CAN section in the getting-started hardware overview still says "INAV does not support any DroneCAN based sensors yet". That is true for 9.1.0 but not for 10.0: DroneCAN support for battery monitors and GNSS receivers ships in 10.0 (the underlying drivers are in maintenance-10.x; related firmware PR iNavFlight/inav#11683 is already merged). The unversioned docs/ tree describes 10.0, so the claim is wrong on this page.

The 9.1.0 versioned snapshot keeps the original wording — it was true at the time of that release and is frozen per the project's versioning policy.

Changes

  • docs/03-getting-started/01-hardware-overview.mdx: replace the "INAV does not support any DroneCAN based sensors yet" sentence in the CAN section with a 10.0-era description of the new DroneCAN support.

Verification

  • npm run build succeeds with the change applied. Pre-existing </p> HTML-minifier warnings in the same file are unrelated to this change (same count before and after).
  • One-sentence-per-line MDX style preserved, matching the rest of the file.
  • No other files modified.

The CAN section in the getting-started hardware overview still says
"INAV does not support any DroneCAN based sensors yet", which is true
for 9.1.0 but not for 10.0. DroneCAN battery monitor and GNSS receiver
support ship in 10.0 (drivers in maintenance-10.x, param-getset firmware
PR #11683 already merged); the unversioned docs/ tree describes 10.0.

The 9.1.0 versioned snapshot keeps the original wording — it was true
at the time of that release and is frozen per the project's versioning
policy.
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document DroneCAN sensor support in INAV 10.0 hardware overview

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Correct stale CAN guidance in the unversioned INAV 10.0 documentation.
• Identify DroneCAN support for battery monitors and GNSS receivers.
High-Level Assessment

The targeted wording correction is optimal because the unversioned documentation describes INAV 10.0, while preserving the frozen 9.1.0 snapshot maintains historical accuracy.

Files changed (1) +1 / -1

Documentation (1) +1 / -1
01-hardware-overview.mdxCorrect DroneCAN support guidance for INAV 10.0 +1/-1

Correct DroneCAN support guidance for INAV 10.0

• Replaces the obsolete claim that INAV supports no DroneCAN sensors. Documents INAV 10.0 support for DroneCAN battery monitors and GNSS receivers over CAN.

docs/03-getting-started/01-hardware-overview.mdx

@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 add REVIEW.md to your repo root and Qodo follows it on every PR

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

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