docs(sim): add Try PX4 quick-start and pre-built packages reference#26957
Open
docs(sim): add Try PX4 quick-start and pre-built packages reference#26957
Conversation
… update - Add docs/en/dev_setup/try_px4.md: one-command quick start with Docker - Add docs/en/simulation/px4_sitl.md: reference for .deb packages and container images (replaces packaging/px4_sitl_deb.md) - Update README.md with "Try PX4" section and docker run one-liner - Update landing page, Getting Started, toolchain page, simulation index, and SUMMARY.md with links to new pages - All container references use :latest tag Signed-off-by: Ramon Roche <mrpollo@gmail.com>
|
No broken links found in changed files. |
Contributor
Author
|
@farhangnaderi, could you put your academic hat on, forget everything you know about PX4 for a second, and try to go through the docs on this PR? It introduces a new SITL container (~30mb) that can run SITL. I'm being kinda bold here and promoting this feature as "try PX4 in 1 easy step." |
mrpollo
force-pushed
the
mrpollo/deb-package-docs
branch
from
7c5d265 to
c55c60a
Compare
Signed-off-by: Ramon Roche <mrpollo@gmail.com>
Document all container port mappings (QGC, MAVSDK, uXRCE-DDS, MAVSim Viewer) with a quick-reference table. Signed-off-by: Ramon Roche <mrpollo@gmail.com>
mrpollo
force-pushed
the
mrpollo/deb-package-docs
branch
from
c55c60a to
3c8bfc8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation for the SITL containers and .deb packages introduced in #26495. The containers are now live on Docker Hub:
px4io/px4-sitl-sih:latestandpx4io/px4-sitl-gazebo:latest.The main addition is a Try PX4 Simulation page that leads with a single
docker runcommand and gets someone flying in under a minute. It lives in Getting Started, right after Recommended Hardware/Setup, so it's one of the first things new users see.The existing
.debpackage reference has been moved frompackaging/px4_sitl_deb.mdtosimulation/px4_sitl.mdand expanded to cover both containers and.debpackages on one page. Sections are ordered by how people use them: what's available, install, configure, connect QGC/MAVSDK, connect ROS 2.Other changes:
index.md) reworked to lead with "Try PX4" before "For Developers"dev_env.md) gets a tip redirecting simulation-only users to pre-built packagesgetting_started.mdandSUMMARY.mdupdated with links to the new pages.debpackagesAlso upgrades all GitHub Actions in the SITL workflow to Node.js 24 compatible versions (
actions/checkout@v6,actions/cache@v5,actions/upload-artifact@v7,actions/download-artifact@v8,docker/setup-buildx-action@v4,docker/build-push-action@v7) to fix the Node.js 20 deprecation warning ahead of the June 2026 deadline.