ros2/ros_core_documentation

Documentation for the Core ROS 2 packages which does not fit into one of the individual packages' documentation.

Documentation is at https://docs.ros.org

ros_core_documentation's Issues

Broken API doc links to this site from index.ros.org

When browsing ROS2 packages, if I look at a specific package e.g. https://index.ros.org/p/launch_ros/ - the API link leads here http://docs.ros2.org/eloquent/api/launch_ros/ but the resources don't exist.

(related: the wiki link is grayed out, but not actually disabled, and leads to http://wiki.ros.org/launch_ros?distro=eloquent which also doesn't exist for ROS2 packages)

What's the plan for generating API documentation for ROS2 packages outside the few that are currently here?

redundancy: Relevance to `index.ros.org`?

At present, the description of this package is:

Documentation for the Core ROS 2 packages which does not fit into one of the individual packages' documentation. http://docs.ros2.org/

Which seems excellent, but it's still a bit confusing because it seems like some of the information in https://index.ros.org/doc/ros2/ is a high-level overview that doesn't fit into individual packages.

Can I ask if there's a plan to consolidate these information sources?
If not, is there perhaps an even more clear delineation that would minimize redundancy (and thus hopefully prevent overly stale information from cropping up, and having to make multiple PRs / cross references, etc.)?

Relates #12, in that its resolution might be ref'ing one link vs. two links vs. something else. Would be nice to be concise!

Theme error: unsupported theme option 'display_version' given

I got an error "Theme error: unsupported theme option 'display_version' given" on ubuntu 14.04.5 with python 2.7 system and the same error on Windows 10 with python 3.5 system.

undefined acronyms are confusing to new users

I'm working my way through the official tutorials, and am currently on creating custom ROS interfaces. It describes find_package(rosidl_default_generators REQUIRED) which I googled, leading here, but the terms are not well defined. I assume "IDL" stands for "interface definition language", but it's not at all clear.

I've noticed that ROS code has a tendency toward abbreviation which can be confusing. Another example: does "cli" mean "client" or "command line interface"?

Recommend defining acronyms as often as possible, and avoiding them entirely when possible

Add URL to html version of docs

I was directed to this repo from http://design.ros2.org/articles/ros_on_dds.html

But there was no link to the html version of this repo. Someone with admin access should add the link:
http://docs.ros2.org/

To the repo description, README, or both