Skip to content

HoloOcean documentation#53

Merged
JMoore5353 merged 15 commits intomainfrom
jacob/holoocean-documentation
Jan 31, 2026
Merged

HoloOcean documentation#53
JMoore5353 merged 15 commits intomainfrom
jacob/holoocean-documentation

Conversation

@JMoore5353
Copy link
Contributor

Documentation for HoloOcean, including some rearranging and improvements to the Standalone and Gazebo simulator documentation as well.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds and reorganizes ROSflight documentation to include a new HoloOcean simulator guide, plus improved structure for simulator (Standalone/Gazebo/HoloOcean) and hardware/firmware documentation.

Changes:

  • Reworks MkDocs navigation to introduce section index pages and reorganize Simulator/Hardware/Firmware docs.
  • Adds new simulator docs pages for Standalone, Gazebo Classic, and HoloOcean (plus updated simulator architecture content).
  • Updates many existing tutorial and overview pages to point at the new locations/structure and adds new hardware/firmware guides.

Reviewed changes

Copilot reviewed 35 out of 55 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
mkdocs.yml Enables MkDocs Material navigation indexes + adds markdown extensions; updates nav structure.
docs/user-guide/tutorials/tuning-performance-in-sim.md Updates links to moved/renamed hardware + firmware docs.
docs/user-guide/tutorials/setting-up-rosplane-in-sim.md Updates links to moved firmware/hardware docs.
docs/user-guide/tutorials/setting-up-rosflight-sim.md Adds hero image + updates simulator-architecture links.
docs/user-guide/tutorials/setting-up-roscopter-in-sim.md Updates links to new firmware/hardware pages and ROScopter index.
docs/user-guide/tutorials/manually-flying-rosflight-sim.md Updates parameter/hardware setup links after doc reorg.
docs/user-guide/tutorials/index.md Adds tutorials section landing page used by navigation.indexes.
docs/user-guide/rosplane/rosplane-setup.md Updates “overview” link to new ROSplane index page.
docs/user-guide/rosplane/index.md Expands ROSplane overview and adds section scaffolding.
docs/user-guide/rosflight-sim/index.md Adds simulator section landing page describing supported visualizers.
docs/user-guide/rosflight-sim/standalone-sim.md Adds detailed standalone simulator guide and launch/config info.
docs/user-guide/rosflight-sim/gazebo-sim.md Adds Gazebo Classic simulator guide and constraints for distros.
docs/user-guide/rosflight-sim/holoocean-sim.md Adds HoloOcean simulator guide including installation/launch steps.
docs/user-guide/rosflight-sim/simulator-architecture.md Expands simulator architecture docs (joystick details, figures, etc.).
docs/user-guide/rosflight-firmware/parameter-configuration.md Updates parameter docs (mixer params, links, wording).
docs/user-guide/rosflight-firmware/mixer.md Adds new mixer documentation page.
docs/user-guide/rosflight-firmware/code-architecture.md Fixes image paths and adds cross-links to related docs.
docs/user-guide/rosflight-firmware/autonomous-flight.md Improves autonomous flight docs; adds tabbed C++/Python examples.
docs/user-guide/roscopter/index.md Updates tutorial links and fixes minor wording.
docs/user-guide/overview.md Updates “getting started” guidance and links to new section index pages.
docs/user-guide/installation/installation-sim.md Adds apt update/upgrade step before rosdep install.
docs/user-guide/installation/installation-hardware.md Adds apt update/upgrade step + updates moved links.
docs/user-guide/images/flight_stack.svg Adds/updates diagram asset used by firmware architecture docs.
docs/user-guide/images/arming-fsm.svg Adds/updates arming FSM diagram asset used by firmware architecture docs.
docs/user-guide/images/HAL.svg Adds/updates HAL diagram asset used by firmware architecture docs.
docs/user-guide/hardware-and-rosflight/getting-started.md Updates links to moved firmware/autonomy docs and improves wording.
docs/user-guide/hardware-and-rosflight/hardware-setup.md Introduces reorganized hardware setup guide under new section.
docs/user-guide/hardware-and-rosflight/flight-controller-setup.md Adds a detailed build/flash guide to user-facing docs.
docs/user-guide/hardware-and-rosflight/rc-configuration.md Adds RC configuration + safety pilot explanation and related diagrams.
docs/user-guide/hardware-and-rosflight/preflight-checks.md Adds a pre-flight checklist page.
docs/user-guide/hardware-and-rosflight/improving-firmware-performance.md Adds firmware performance tuning guide moved under hardware section.
docs/user-guide/customizing-rosflight.md Updates references/links to new firmware + autonomy docs locations.
docs/user-guide/concepts/running-simulations-with-rosflight.md Removes old simulator overview page (replaced by new sim section index).
docs/user-guide/concepts/hardware-setup.md Removes old hardware setup page (replaced by new hardware section).
docs/user-guide/concepts/flight-controller-setup.md Removes old FC setup page (replaced by new hardware section).
docs/user-guide/concepts/detailed-launching-guide.md Removes old detailed launching guide (replaced by new sim pages).
docs/stylesheets/extra.css Adds optional custom CSS (currently not enabled in mkdocs config).
docs/developer-guide/roscopter/roscopter-dev-overview.md Removes placeholder ROScopter dev overview page.
docs/developer-guide/firmware/unit-tests.md Updates firmware unit-test build instructions.
docs/developer-guide/firmware/debugging.md Updates links to the new user-guide firmware build/flash instructions.
docs/developer-guide/firmware/building-and-flashing.md Removes developer-guide build/flash page (content moved to user guide).
docs/developer-guide/contribution-guidelines.md Adjusts formatting/emphasis in contribution guidelines.
Comments suppressed due to low confidence (3)

docs/user-guide/rosflight-sim/simulator-architecture.md:457

  • The Gazebo section’s figure caption says "Standalone sim software modules" and the preceding sentence says "does not work on versions of above ROS2 Humble". The caption should match the Gazebo figure, and the sentence should be reworded (e.g., "newer than ROS 2 Humble").
    docs/user-guide/rosflight-sim/simulator-architecture.md:472
  • The HoloOcean section’s figure caption currently says "Standalone sim software modules". This should be updated to match the HoloOcean figure (and keep the figure numbering consistent).
    docs/user-guide/rosflight-sim/simulator-architecture.md:365
  • This introduces a visible "TODO" in the rendered documentation. If the wind model details aren’t ready yet, consider converting this to an HTML comment (so it doesn’t render), or link to a tracking issue instead of leaving a TODO in user-facing docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@JMoore5353 JMoore5353 force-pushed the jacob/holoocean-documentation branch from 5587407 to be63140 Compare January 31, 2026 00:02
@JMoore5353 JMoore5353 marked this pull request as ready for review January 31, 2026 03:33
@JMoore5353 JMoore5353 merged commit 1405a0d into main Jan 31, 2026
1 check passed
@JMoore5353 JMoore5353 deleted the jacob/holoocean-documentation branch January 31, 2026 03:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant