Conversation
Adds a standalone documentation site under docs/ built with VitePress and deployed to GitHub Pages (px4.github.io/Hawkeye) on push to main. Content covers installation, three progressive getting-started paths (live SITL, ULog replay, multi-drone swarm), HUD and camera guides, CLI flags, and split reference pages for keybinds, position data tiers, coordinate systems, and data sources. Trims README to install + quickstart and points users at the docs site for everything else, so there's a single source of truth for each topic. Relocates docs/screenshot.png to docs/assets/screenshot.png.
Adds docs/developer/ with source-build and testing guides, moving build-from-source and Makefile target details out of the README and docs/installation.md so each topic has a single source of truth. README and installation page now cover only the Homebrew formula and .deb package paths; source builds, Windows, and test workflows live in the new Developer section. Bumps the Pages workflow to latest action versions and Node 24 LTS: - actions/checkout v4 to v6 - actions/setup-node v4 to v6 (Node 20 to 24) - actions/configure-pages v5 to v6 - actions/upload-pages-artifact v3 to v5 - actions/deploy-pages v4 to v5
mrpollo
force-pushed
the
mrpollo/docs-site
branch
from
58a94a9 to
6c4a966
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 a standalone documentation site under
docs/built with VitePress and deployed to GitHub Pages (https://px4.github.io/Hawkeye/) on push tomain. The rationale was to keep Hawkeye's deep documentation inside this repo and only post a short user-facing stub to the main PX4 docs, per feedback from Hamish on PX4/PX4-Autopilot#26965.Content covers install (Homebrew,
.deb), three progressive getting-started paths (live SITL with Docker/deb/source options, ULog replay, multi-drone swarm), HUD and camera guides, CLI flags, and split reference pages for keybinds, position data tiers, coordinate systems, and data sources. A new Developer section covers source builds and the test suite, so the README stays focused on install + quickstart.Follow-up: once Pages is enabled in repo settings (source: GitHub Actions) and the site is live, the PX4 docs PR can be slimmed to a user-guide stub that links here.
Deployment
The
Docsworkflow builds and deploys on every push tomainthat touchesdocs/**,package.json, or the workflow itself. It uses the latestactions/*versions (checkout v6, setup-node v6, configure-pages v6, upload-pages-artifact v5, deploy-pages v5) and Node 24 LTS.To enable after merge
Go to Settings → Pages and set source to GitHub Actions (one-time). First deploy publishes automatically.