The OSRF’s work with 3di, funded by the OSRA, to improve the documentation of our projects is about to reach an important milestone. This week, we will be merging in the pull request that rearranges the documentation table of contents for the Rolling Ridley distribution’s documentation.
This is the start of implementing the new information architecture and an overhaul of the ROS documentation, which will soon after be followed by revised content, new tutorials, learning paths, better installation documentation - and then similar revisions of the documentation of our other projects. However, we do expect some disruption. This first PR is big (716 files changed!) and some things are likely to break. Our intention is to get this major change in, and then clean up any fallout it causes.
If you spot something broken, please help out with the clean up by sending in a PR to fix it. This will help us move through the documentation overhaul much faster, and improve the ROS documentation for you and every other ROS user. You can send a PR to fix anything in the documentation easily by clicking the “Edit on GitHub” link you’ll find in the top-right corner of every page. That will let you edit that page and submit a PR all from your browser - no checkout required!
