Skip to content

Conversation

@azeey
Copy link
Contributor

@azeey azeey commented Dec 20, 2025

🎉 New feature

Summary

Currently, the navigation menu on gazebosim.org/docs is a flat list and can be difficult to navigate. There also no clear organization between items that are tutorials vs how-to guildes vs reference, etc. This PR organizes the documents based on the diataxis framework.

To make all of this possible, the build script had to be modifed.

  1. Navigation menu is now only defined in the index.yaml files in the versioned directories (e.g. jetty/index.yaml). The top level index.yaml no longer contains pages. This allows for more control over the order of items and organizing them into different sections.
  2. Since the pages are now in the versioned directories, files that are common to all gazebo versions have been moved to the common directory. This is to make it explicit in the index.yaml files where these files are coming from. Otherwise, there it would be confusing since the common files are no longer peers of the index.yaml files that reference them. When referencing these files in index.yaml, the prefix common: has to be used now.
  3. The build script adds functionality to add sections.
  4. Pages without a file, but with children will be considered organizational elements and the appropriate file for sphinx is automatically generated.

TODO

  • Sections are only defined for jetty (so, only build_multiversion.py -r jetty works right now)
  • Define User and Developer personas
  • Update README

Preview

image

Checklist

  • Signed all commits for DCO
  • Updated documentation (as needed)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers
  • Was GenAI used to generate this PR? If so, make sure to add "Generated-by" to your commits. (See this policy for more info.)

Generated-by: Gemini 2.5

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by and Generated-by messages.

This also moves the `pages` entries from the root `index.yaml`
to the `index.yaml` of the versioned directories. This allows more
control over the navigation menu (order of elements)

Generated-By: Gemini 2.5
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
Signed-off-by: Addisu Z. Taddese <addisu@openrobotics.org>
@github-actions github-actions bot added 🌱 garden Gazebo Garden 🎵 harmonic Gazebo Harmonic 🏛️ ionic 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress 🏰 citadel Ignition Citadel 📜 blueprint Ignition Blueprint 🔮 dome Ignition Dome 🪵 jetty labels Dec 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📜 blueprint Ignition Blueprint 🏰 citadel Ignition Citadel 🔮 dome Ignition Dome 🏢 edifice Ignition Edifice 🏯 fortress Ignition Fortress 🌱 garden Gazebo Garden 🎵 harmonic Gazebo Harmonic 🏛️ ionic 🪵 jetty

Projects

Status: Inbox

Development

Successfully merging this pull request may close these issues.

1 participant