Add linkcheck and claude fix internal links#14208
Add linkcheck and claude fix internal links#14208hamishwillee wants to merge 4 commits intomasterfrom
Conversation
Build ResultsPlatform Status
All builds passed. Pre-commit
Pre-commit hooks: 4 passed, 32 failed, 7 skipped. Updated: 2026-03-25 09:34:41 UTC • Triggered by: pre-commit |
There was a problem hiding this comment.
Pull request overview
This PR updates QGroundControl’s VitePress documentation to reduce broken internal links by normalizing anchors/IDs and pointing references at the pages where the referenced sections actually live.
Changes:
- Update multiple docs pages to use correct cross-page links/anchors (notably pointing Fly View action links to
fly_view/hud.mdsections). - Add explicit heading IDs where auto-generated anchors are ambiguous/duplicated (e.g. “Plan View” in stable v3 release notes).
- Replace some inline anchor markup (
<span id=...>) with<a id=...>and adjust in-page references accordingly.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/en/qgc-user-guide/viewer_3d/viewer_3d.md | Updates Fly View capability links to point to the corresponding sections in hud.md. |
| docs/en/qgc-user-guide/setup_view/tuning_px4.md | Fixes an incorrect in-page link for the pre-autotuning test section. |
| docs/en/qgc-user-guide/setup_view/sensors_ardupilot.md | Fixes “Flight Controller Orientation” links to point to the correct section ID. |
| docs/en/qgc-user-guide/settings_view/general.md | Replaces inline anchors with <a id=...> for stable deep links into the page. |
| docs/en/qgc-user-guide/releases/release_note_stable_v3.md | Adds explicit IDs for duplicated “Plan View” headings (v3.2/v3.3). |
| docs/en/qgc-user-guide/plan_view/plan_view.md | Updates deep links to the new explicit release note anchors; adjusts inline screenshot anchor. |
| docs/en/qgc-user-guide/fly_view/video_overlay.md | Fixes a broken reference by pointing to the instrument panel section. |
| docs/en/qgc-user-guide/fly_view/video.md | Points video/camera instrument page references to the correct anchors in hud.md. |
| docs/en/qgc-user-guide/fly_view/hud.md | Fixes/introduces anchors used by other pages (arm/disarm/emergency stop, map actions, RTL anchor, etc.). |
| docs/en/qgc-user-guide/fly_view/fly_view.md | Updates several task references to point at the correct anchors/pages. |
| docs/en/qgc-dev-guide/file_formats/plan.md | Fixes a Corridor Scan anchor reference to match the actual section ID. |
| - And most of the capabilities of the [Fly View](../fly_view/fly_view.md), including: | ||
| - Run an automated [pre-flight checklist](#preflight_checklist). | ||
| - Run an automated [pre-flight checklist](../fly_view/hud.md#preflight_checklist). | ||
| - Arm the vehicle (or check why it won't arm). | ||
| - Control missions: [start](#start_mission), [continue](#continue_mission), [pause](#pause), and [resume](#resume_mission). | ||
| - Guide the vehicle to [arm](#arm)/[disarm](#disarm)/[emergency stop](#emergency_stop), [takeoff](#takeoff)/[land](#land), [change altitude](#change_altitude), and [return/RTL](#rtl). | ||
| - Control missions: [start](../fly_view/hud.md#start_mission), [continue](../fly_view/hud.md#continue_mission), [pause](../fly_view/hud.md#pause), and [resume](../fly_view/hud.md#resume_mission). | ||
| - Guide the vehicle to [arm](../fly_view/hud.md#arm)/[disarm](../fly_view/hud.md#disarm)/[emergency stop](../fly_view/hud.md#emergency_stop), [takeoff](../fly_view/hud.md#takeoff)/[land](../fly_view/hud.md#land), [change altitude](../fly_view/hud.md#change_altitude), and [return/RTL](../fly_view/hud.md#rtl). |
There was a problem hiding this comment.
The PR description mentions adding a new local link checker command (e.g., yarn linkcheck) and an npm dependency, but the reviewed changes appear to only update documentation links/anchors and don't include any corresponding updates (like package.json script/dependency changes). If the linkcheck tooling is intended to be part of this PR, it looks like those commits/files may be missing.
There was a problem hiding this comment.
yarn is already a dependency of the package system. We could add the mavlink link checker too if you like. Depends on whether you want to add automated link checking like I do in PX4.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
@DonLakeFlyer The docs update should be OK. Added you as reviewer mostly to check you are OK with addition of the tool for link checking. |
This adds option
yarn linkcheckto do local checking of links. The tool relies on node, yarn, and https://www.npmjs.com/package/markdown_link_checker_sc from npm. This is the link checker I use on PX4-Autopilot.It allows checking of internal and external links.
I then ran this and used claude to fix up the link anchors.
The tools shows that there are a bunch of orpaned (unused) images, and a few orphaned pages. Note that you need to be careful deleting orphaned images reported on the English branch like this - because they might still be referenced in translations until you round-trip with crowdin.
Note that you can also check external links, but I rarely do that automatically, since fixing them requires a little more thought.
This is somewhat related to #13807
By submitting this pull request, I confirm that my contribution is made under the terms of the project's dual license (Apache 2.0 and GPL v3).