Skip to content

Conversation

@Bi0T1N
Copy link
Contributor

@Bi0T1N Bi0T1N commented Dec 12, 2025

Description

This provides a dropdown in the docs on the right side to select the desired docs for a specific version.

Related Issue

Resolves #4537

Motivation and Context

A dropdown in the docs will improve the user experience and ease the understanding which version of the docs are currently viewed (see #4537).
It also allows to switch between multiple versions but this needs more changes since the docs for all versions need to be published. Dropdown selection for versions is used very often in documentation (e.g. https://docs.python.org/3.14/) and the design is inspired by ROS 2

How Has This Been Tested?

By running the commands in a devcontainer that are provided in the docs subfolder. Browsing the docs was tested with Firefox under Linux.

Screenshots (if appropriate):

Header Header_dropdown header_documentation header_api

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@sonarqubecloud
Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
B Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

@Bi0T1N
Copy link
Contributor Author

Bi0T1N commented Dec 12, 2025

The remaining issue is that the docs for different versions need to be created and published. Currently there are only docs for 5.12 and latest. But I couldn't find where this is done. Or is this a manual task? 🤷

@arturcic
Copy link
Member

The remaining issue is that the docs for different versions need to be created and published. Currently there are only docs for 5.12 and latest. But I couldn't find where this is done. Or is this a manual task? 🤷

v5.12 I manually ported back into the main branch, but I think we can automate this at publishing minor/major versions, @gep13 could probably help us with some suggestions

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.

[ISSUE]: Documentation "5.12.0"/"latest" link is confusing

2 participants