Commit Graph
16 Commits
Author SHA1 Message Date
Hamish Willee 272f3280d7 docs(boards): restructure Pixhawk 4 page to the board template (#29590)
* docs(boards): restructure Pixhawk 4 page to the board page template

Move the existing content into the flight-controller page template's
sections, headings and anchors, with no change to what the page says,
so that the content additions that follow can be reviewed on their own.

The Quick Summary list becomes Specifications sub-sections, the
connector image moves into Pinouts and the dimensions image into
Mechanical Data, Voltage Ratings moves before Serial Port Mapping,
and Further info becomes Further Information. Port labels are in code
style, and units follow the docs style guide. Links to the changed
anchors are updated.

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

* docs(boards): add Pixhawk 4 PWM outputs, power and setup sections

Fill in the sections the board page template expects, from the board
source (boards/px4/fmu-v5) and Holybro's datasheet, pinouts and
product page.

- Mark the board discontinued by Holybro but still supported by PX4,
  with matching SUMMARY, sidebar and category entries
- Specifications: current IO processor, sensor buses, USB, parameter
  storage, SD card, max input voltage and current sensing, and the
  datasheet weight
- PWM Outputs: IO and FMU outputs, no DShot, timer groups, and the
  capture inputs on CAP & ADC IN
- Power, SD Card, Radio Control, GPS & Compass, Telemetry and CAN
- Serial Port Mapping: USART1, flow control column, printed port
  labels, and the same table on the serial port mapping page
- Debug Port: Pixhawk Debug Mini, and the console UART

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

* docs(boards): fix Pixhawk 4 specs, links and wording from review

Take the weight and operating temperature from Holybro's latest
datasheet, and link that datasheet in place of the older in-repo copy,
which contradicted the page.

Give the serial and I2C interface lines in the board page template's
form, where the board source and Holybro's pinout agree, and add the
template content the page was missing: the servo rail note, capture
pins as outputs, DSM/S.BUS receiver power pins, the internal compass,
and how to enable a second GPS (GPS_2_CONFIG has no default).

Also fix the wiring quick start's link text for the renamed Pinouts
heading, and make S.BUS spelling and port labels consistent.

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

* docs(boards): apply Holybro corrections and discontinued markers to Pixhawk 4

Holybro confirmed the board is discontinued and corrected the weight,
operating temperature, input voltage limits, RC port routing and DShot
support. The discontinued markers follow the earlier discontinued board
pages, and the Pixhawk Standard list now separates discontinued boards.

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

---------

Signed-off-by: Hamish Willee <hamishwillee@gmail.com>
2026-11-05 08:45:43 +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 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
Ramon Roche 2f459921f6 docs: add official PX4 developer kits and manufacturer program
Document the Official PX4 Developer Kit program: a new top-level
Developer Kits section listing the certified kits (ModalAI Starling 2
Max, DroneBlocks DEXI 5, Holybro X500 v2), a new DEXI 5 page, and a
manufacturer-facing page describing the program requirements, benefits,
and eligibility.

Restructure the hardware navigation so all certified kits live in one
place instead of being split across Complete Vehicles and Kits, drop
discontinued build guides from the sidebar (still linked from the kit
build guides page), and group the manufacturer guides under a new
Manufacturers section in Development > Hardware.

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-07-02 12:15:03 -07: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
Ramon Roche d8a2aeb4ae docs(hardware): expand USB VID/PID options in board support guide (#27771)
List the VID/PID sourcing options in order of preference: buy your own
from USB-IF, obtain a free pair from a community registry or chip-vendor
program, or use the Dronecode VID. Add a note clarifying that Dronecode
membership is not required to get a board supported in PX4.

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-06-30 08:42:13 +10:00
Ramon RocheandHamish Willee 19d669e542 docs(hardware): rewrite manufacturer board support guide (#27675)
* docs(hardware): rewrite board support guide around real process

The board support guide described a theoretical category-first process that
no longer matches how board support actually happens. Manufacturers were
left unsure of the concrete steps, leading to repeated email requests for
guidance.

Restructure the guide around the actual GitHub-driven flow: build your own
firmware target, reserve a board ID via a PX4-Bootloader PR, provide a
unique USB VID/PID, demonstrate flight with logs, and open the PR. Keep the
support categories as a reference section that explains support
responsibility rather than process.

Spell out that QGroundControl uses the USB VID/PID to identify hardware, and
warn that reusing another vendor's pair causes misidentification. Promote
the ArduPilot board-ID alignment note and point it at the current hwdef
location. Demote VER/REV ID to a clearly-deprecated edge case: explain the
resistor/EEPROM mechanism and its original cross-vendor baseboard/FMU intent,
note the ecosystem has deviated from it, and that Dronecode no longer offers
standards validation. Update the Discord link to chat.dronecode.org.

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

* docs(hardware): align porting guide with board support guide

The porting guide's 'Officially Supported Hardware' section restated the
board support process and contradicted the rewritten board support guide.
It also told manufacturers to ship hardware to the dev team for port
validation, a service Dronecode no longer offers.

Replace that section with a short pointer to the board support guide, which
is now the single source of truth for the support process, and keep only the
high-level support benefits and maintenance expectations. The technical
porting content (architecture, file layout, host OS config, RC UART wiring)
is unchanged.

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

* docs(hardware): make board support guide discoverable for manufacturers

The board support guide was only reachable by navigating into the hardware
integration section. A manufacturer browsing the user-facing autopilot pages,
the exact audience, had no path to it, and one of those pages still stated
the obsolete 4-month compatibility commitment.

Add 'how to get your board supported' pointers from the manufacturer-supported
and experimental autopilot pages, the flight controller index, and the
development landing page. Remove the stale 4-month rule from the
manufacturer-supported page. Strengthen the guide's opening paragraph so the
phrases manufacturers actually search appear up front.

Word the links to avoid conflating the guide (how to get a board supported)
with the 'Manufacturer Supported' category (one of several support levels).

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

* docs(docs): Minor tweaks

---------

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Co-authored-by: Hamish Willee <hamishwillee@gmail.com>
2026-06-17 18:11:37 +10:00
Onur Özkan 0d18be5049 fix(scripts): replace hardcoded /bin/bash shebangs
Several helper scripts assumes bash is available at /bin/bash. That breaks on systems
such as NixOS, where bash is resolved from PATH instead of a fixed /bin location and
causes failures like `bad interpreter` during `make format`, e.g., on my host machine:

```sh
$ make format

/PX4-Autopilot/Tools/astyle/check_code_style.sh: /PX4-Autopilot/Tools/astyle/fix_code_style.sh: /bin/bash: bad interpreter: No such file or directory
```

This change switches these entrypoints to `#!/usr/bin/env bash` so they locate bash properly.

No functional changes intended.

Signed-off-by: Onur Özkan <work@onurozkan.dev>
2026-04-01 12:25:28 -08:00
Onur Özkan 7d392394dd fix(build): add kconfig support for fortified toolchains 2026-03-31 22:23:50 -08:00
PX4BuildBot 3038ac9b7d docs: auto-sync metadata [skip ci]
Co-Authored-By: PX4 BuildBot <bot@px4.io>
2026-03-18 23:04:11 +00:00
Ramon Roche adb2df5ca7 feat(boards/modalai/voxl2): add Debian packaging framework
Add a scalable .deb packaging framework for VOXL2, built on the
existing cmake/package.cmake CPack infrastructure. The framework
handles multi-processor boards by having the POSIX (_default) build
own the .deb and pull in the companion SLPI build's artifacts.

Board-specific files:
- cmake/package.cmake: CPack variable overrides (name, deps, version)
- cmake/install.cmake: install() rules for all .deb contents
- debian/postinst: px4-* symlinks, DSP signature, directory setup
- debian/prerm: service stop, symlink cleanup
- debian/voxl-px4.service: systemd unit (after sscrpcd)

Infrastructure changes:
- cmake/package.cmake: hook for board-specific CPack overrides
- platforms/posix/CMakeLists.txt: hook for board install.cmake
- Makefile: %_deb pattern rule (build _default, then cpack -G DEB)
- CI: auto-discover _deb targets, collect .deb artifacts, upload
  to GitHub Releases

Future boards: add cmake/package.cmake + cmake/install.cmake and
CI discovers it automatically. No new file formats or tools needed.

Signed-off-by: Ramon Roche <mrpollo@gmail.com>
2026-03-18 08:51:27 -07:00
Hamish Willee b37733459d docs: Codespell check on English sources + swd fixes (#26657) 2026-03-05 12:50:59 +11:00
Hamish Willee 209c971c1b docs: Link fixes in docs - including 404 fixes (#26605)
* Redirect 301/308 HTTP link fixes
* Easy 404 fixes - easy
* Add internal anchor fixes and generate msg docs fix
2026-02-28 17:09:53 +11:00
Hamish Willee 2c31e2bad5 Fix all possible HTTP to HTTPS docs links (#25153) 2025-07-03 18:09:58 +10:00
Hamish Willee 375f421c61 Link fixes galore (#25151) 2025-07-03 14:53:12 +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