Commit Graph
13 Commits
Author SHA1 Message Date
Hamish Willee c9b9e4e25e docs(docs): fix link checker errors in uORB summary and external links (#29100)
* docs(msg_docs): sync uORB summary and remove stale pages

The link checker reported SensorsStatusGnss and VehicleGnssHeading as
missing from the table of contents, and SensorGps as an orphan.

SensorGps and EstimatorGpsStatus document messages that no longer exist
(renamed to SensorGnss in #24399 and removed in #28520), so the pages
are deleted. The uORB block in SUMMARY.md now matches the output of
Tools/msg/generate_msg_docs.py.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>

* docs: fix external links reported by the link checker

Updates permanently redirected links to their targets, and points the
discontinued Bitcraze Crazyradio PA and Z-ranger deck v2 links at pages
that still exist.

The 3DR Control N1 link is ignored for 6 months: the site serves a
certificate that does not cover its hostname, which only the vendor can
fix.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>

* docs: remove orphaned images

The two ICE control diagrams were superseded by SVG versions, and the
jMAVSim screenshot was left behind when the jMAVSim docs were replaced
with SIH and Hawkeye. No page in any language references them.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>

---------

Signed-off-by: Hamish Willee <hamishwillee@gmail.com>
2026-10-13 02:35:09 +11:00
Hamish Willee 860aca9864 docs(docs): fix broken links and missing uORB TOC entries (#28827)
* docs(msg): add missing uORB message pages to SUMMARY

The msg_docs block in SUMMARY.md is not regenerated by the metadata sync,
so seven message pages were unreachable from the sidebar (PageNotInTOC).
Replace the block with the fragment written by generate_msg_docs.py,
which also moves VehicleControlMode to the unversioned list.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>

* docs: fix broken and permanently redirected external links

CUAV moved its docs to a /en/<product>/ layout, so the Nora, C-RTK 9Ps
and C-RTK2 links returned 404. Other vendor links (InvenSense, Bosch,
ARK, CORVON) permanently redirect; point them at the final URL.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>

* docs: fix remaining dead external links

RaccoonLab's store product pages, the CubeNode pin descriptions,
wiki.ubuntu.com/LTS and the Bitbucket NuttX repos no longer resolve.
RaccoonLab now only has docs pages for these devices, so link those.

ubuntu.sh and macos.sh already install kconfig-frontends, so the NuttX
porting guide no longer tells Ubuntu users to build it from source; the
old steps are kept in a comment.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>

* docs: ignore unresolvable external links for 6 months

These links fail the external link check for reasons a docs edit can't
fix: bot blocking (raccoonlab.co, gitlab.arm.com), expired vendor
certificates (svehicle.cn, jmarple.ai), and the ARKV6X-RT order link,
which is waiting on a replacement URL from ARK.

Assisted-by: Claude:claude-opus-5-5
Signed-off-by: Hamish Willee <hamishwillee@gmail.com>

---------

Signed-off-by: Hamish Willee <hamishwillee@gmail.com>
2026-09-24 09:55:45 +10:00
Hamish Willee a906b72868 docs(docs): Fix external links and add ignore deferals to retested cases (#28400) 2026-08-27 15:53:41 +10:00
Hamish Willee 8ed15e6b19 docs(docs): Fix broken external links (#28300)
* docs(docs): Fix external links and associated tidy
* docs(docs): Fix up sidebar discontinued convention
* docs(docs): Fix up alternate sidebar
2026-08-20 11:53:24 +10:00
Hamish Willee f68a3af4b6 docs(docs): tidy orphans etc (#28113) 2026-07-31 08:55:09 +10:00
Hamish Willee 96e760a782 docs(docs): Fix almost all broken external links (#27790)
* docs(docs): Add missing uorb topics sidebar
* docs(docs): discontinue cuav v5 plus/nano
* docs(docs): Fix 404 and 303 status HTTP links
* docs(docs): more link fixes
* update(drivers): Docs fix to fix up link
* docs(docs): Fix up all remaining  broken links and add exclusions
2026-07-02 16:58:40 +10:00
Hamish Willee b3fbf37fae ci(docsorchestrator): Update to latest markdown link checker and link fixes (#27098) 2026-04-16 13:39:28 +10:00
Hamish Willee 2fd131d3cf Link fixes 4 (#26633)
* Airframe - replace Babyshark with QAV250

* Link fixes
2026-03-04 09:45:50 +11:00
Jacob Dahl 59358ae60d fix newline at at eof 2026-02-26 11:10:01 -09:00
Hamish Willee c0af8b9952 docs: Link fixes such as 301 redirects (#26586) 2026-02-26 18:33:37 +11:00
Matthias Grob 2bc04f91f8 docs: fix all end of file newlines
Note: Some files are autogenerated and I did not yet
go through each source of generation to fix it there.
Instead I adjusted the filter to only exclude those
such that we can fix things in steps.
2025-06-26 11:03:23 -07:00
Hamish Willee 09d734955d Add ignore errors 2025-06-04 12:39:33 +10:00
Hamish WilleeandRamon Roche 88d623bedb Move PX4 Guide source into /docs (#24490)
* Add vitepress tree

* Update existing workflows so they dont trigger on changes in the docs path

* Add nojekyll, package.json, LICENCE etc

* Add crowdin docs upload/download scripts

* Add docs flaw checker workflows

* Used docs prefix for docs workflows

* Crowdin obvious fixes

* ci: docs move to self hosted runner

runs on a beefy server for faster builds

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: don't run build action for docs or ci changes

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* ci: update runners

Signed-off-by: Ramon Roche <mrpollo@gmail.com>

* Add docs/en

* Add docs assets and scripts

* Fix up editlinks to point to PX4 sources

* Download just the translations that are supported

* Add translation sources for zh, uk, ko

* Update latest tranlsation and uorb graphs

* update vitepress to latest

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Ramon Roche <mrpollo@gmail.com>
2025-03-13 16:08:27 +11:00