Gazebo Sim documentation

General
1

Hello guys,
It has been now 2 weeks that I use the new gazebo version (gz) and wow is the doc unhelpfull. Every time I search some thing I find the old version tutorial…
I have a few examples for example :

  • I want to know how to use the mesh tag in my .world file and the only tutorial that I found is Pavillon CustomWorld from ArticulatedRobotics.
  • How do I use the size tag ? Is it applicable for every geometry ?
  • I want to import uri no good explanation how to do it (yes there is a tutorial but it’s not intuitive…
    And a lot more…

I am not here to just say this is bad but I want to know if other people feel lost like me and how can we change this situation ?

Hope I don’t make to many people angry !

5 Likes
2

You are not the only one. Thanks for posting.

3

Hi @joschma , welcome to the community! You won’t make anyone angry with constructive feedback. It’s necessary. I can also say, I bet that you will make the community facilitators and in this case the Gazebo PMC really happy if the feedback also comes with a contribution to improve the open source resources!

In this case for example in the uri bullet point above, if you found the documentation non-intuitive, once you figured it out on your project you could submit a pull request to update and improve the docs for the next doc user!

These resources are built by and for the community. There are many ways to participate and contribute! :smiley:

5 Likes
4

The documentation for sdformat is on the sdformat.org website.

E.g. see here for the mesh tag.

What I am missing is a high-level overview of the internal structure of Gazebo Sim and how everything interacts. E.g.:

  • Communication from server to gui (and vice verse?),
  • interaction between the different plugins, e.g. from ECM to physics plugin, or from ECM to rendering scene etc.
1 Like
5

@joschma you are aware that there is a forum for these kinds of requests right?

We really can’t do much to help if we don’t know about the problem in the first place. The appropriate place to request documentation updates is here. What would really help us out is that when you figure out something that is not presently documented you take the time to leave the docs better than you found them by sending us a documentation PR.

2 Likes