Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #410

Closed
PerFrivik opened this issue Nov 15, 2023 · 2 comments
Closed

Improve documentation #410

PerFrivik opened this issue Nov 15, 2023 · 2 comments
Labels
bug Something isn't working

Comments

@PerFrivik
Copy link

Improve documentation. Why can't there be message generation like in ROS. Lets say I want to know what nav_msgs/Odometry is, all I need to do is google the message type and I get this beautiful thing:

https://docs.ros.org/en/noetic/api/nav_msgs/html/msg/Odometry.html

I tried the same for gz::msgs::Actuators, but did not find anything and had to go far into the source code to find anything at all.

@PerFrivik PerFrivik added the bug Something isn't working label Nov 15, 2023
@mjcarroll
Copy link
Contributor

For versions up to garden, the documentation is available in docs.gazebosim.org, for example: Odometry or Actuators

In harmonic forward, since the message generation pipeline has changed, we are missing some of the documentation on generated message types, which has been reported here: #399

Additionally, there is on-going work to improve the documentation site to address things like search engine optimization to easily surface this information.

I'm going to close this as a duplicate of #399 and use that to track this for now. Thank you for reporting.

@github-project-automation github-project-automation bot moved this from Inbox to Done in Core development Nov 20, 2023
@PerFrivik
Copy link
Author

Alright, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Archived in project
Development

No branches or pull requests

2 participants