The goal for package-level ROS 2 documentation is the same as for ROS 1 - to provide a single domain to easily discover all documentation.
We do understand the significance and the urgency of the matter - actually we are aware of this topic for quite some time. Unfortunately until now the necessary resources to develop the necessary tools and infrastructure weren’t available / other ROS 2 work items had a higher priority (e.g. specific feature development). Atm we can’t promise that Open Robotics will have the bandwidth to develop the necessary parts in the near term.
Some context about the involved parts:
- A similar infrastructure as for ROS 1 which runs documentation jobs on build.ros2.org on a per repository level and generates static documentation (html / css) for API docs as well as free-form text docs.
- Merge / cross reference this generated documentation with other available metadata (like e.g. index.ros.org).
- Coexist and cross reference content which is not ROS distro specific (like generic content in the ROS 1 wiki).
- Consolidate the different documentations parts and URLs already existing [1][2][3].
- Probably support documenting different versions of a package (e.g. latest development branch, released versions, synced versions).
- Support for tutorials being backed by actual code which can be unit tested.
- Scalable to thousands of ROS packages which https://index.ros.org/doc/ros2/ currently isn’t.
- Support to remove obsolete content (e.g. removed packages / repositories).