My 2c as a fairly casual user of this documentation - I feel like the current approach (as I understand it) is the right direction but a little clunky.
I also want to preface this by noting that I understand that documentation is a difficult thing to manage, especially in a project this large and distributed, so props to everyone who has worked hard on it so far!
I think it makes sense to avoid duplication of information, and the GitHub readme for a repo is quickly becoming the first place to look for documentation on anything, not just ROS packages.
The ROS Index seems to show this readme as the default which I think is great (I’ve not paid attention to how it handles sub-packages in repos etc, presumably a separate readme at the root of each package?) This way the documentation is kept close to the code, and in all the places people would normally expect it to be.
But accessing it I feel is a bit clunky. Firstly, the wiki tends to rank highly on searches, so you often hit it first. The wiki helpfully tells you in the sidebar:
The ROS Wiki is for ROS 1. Are you using ROS 2 (Dashing/Foxy/Rolling)? Check out the ROS 2 Documentation
So you click the documentation link and it takes you to the main ROS docs, which are great but also probably have nothing to do with the package whose wiki page you were just on, and of course no amount of navigating there is going to get you to them - instead you need to go to the index.
So you eventually find the index page for your package (somehow) and the readme is helpful, but you think “it would be nice if there were more tutorials/guides on this”. You notice the Tutorials tab and click it, which takes you back to the wiki (but to the package’s tutorials sub-page)!
See ROS Wiki Tutorials for more details.
Now, this is a reasonable link to have since the Index is also relevant for ROS 1 packages, and the wiki often has useful information for both ROS 1 & 2. But it’s not at all clear when you’re clicking on it that it may be outdated information, and because it’s auto-generated it may link to a page that doesn’t exist (such as my example above).
I’m left unclear as to where additional tutorials/guides for ROS 2 are actually meant to live. I think the most reasonable place is as other Markdown files in the repo, and to have way for them to be viewed within the Index but I’m not sure how that would work (I’m just realising, perhaps that is the “Source Tutorials” sub-heading on the Index? If so, is that auto-indexed?)
One other note, there is also the “API Docs” button on the Index page which redirects to an appropriate docs.ros.org URL (regardless of whether it exists). How does one go about having documentation properly indexed there? Is that a thing in bloom/rosdistro?
Thanks again for all the documentation that has been created so far, the content is fantastic (especially docs.ros.org) but sometimes just a little hard to navigate unless you know exactly where to look