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

The documentation for the Gazebo simulation needs to be updated #2484

Closed
serkanMzlm opened this issue Jul 18, 2024 · 3 comments
Closed

The documentation for the Gazebo simulation needs to be updated #2484

serkanMzlm opened this issue Jul 18, 2024 · 3 comments
Labels
enhancement New feature or request

Comments

@serkanMzlm
Copy link
Contributor

serkanMzlm commented Jul 18, 2024

The documentation for Gazebo Sim is inadequate. It would be much better if it were organized like the ROS2 documentation. The training is helpful for beginners, but as you delve into more complex topics like writing plugins, finding and understanding the documentation becomes difficult. The tutorial at this link could be expanded and made more detailed, making it a valuable resource for both beginner and advanced users.

  • The training can be divided into three sections: beginner, intermediate, and advanced, just like in ROS. Explanations can be provided on the page accordingly, ensuring that it appeals to every user

  • Pages that are no longer in use should not be referenced.

image

  • When I look at the tutorials for the classic version of Gazebo, I see that they are much better. Everything is explained in much more detail and in a clearer manner. However, for some reason, the documentation has deteriorated as the version has been updated.

image

  • Writing plugins in C++ can be explained in more detail.
@serkanMzlm serkanMzlm added the enhancement New feature or request label Jul 18, 2024
@azeey
Copy link
Contributor

azeey commented Jul 18, 2024

The tutorials in https://gazebosim.org/api/sim/8/tutorials.html have more organization. There's an open issue to make those tutorials more discoverable from the gazebosim.org/docs website.

@serkanMzlm
Copy link
Contributor Author

@azeey Yes, I also proceeded from this page, but in general, I think the documentation needs to be more detailed and divided into sections for beginners, intermediate, and advanced users.

@azeey
Copy link
Contributor

azeey commented Jul 22, 2024

The link I shared does have multiple sections include the ones you mentioned. As far as more detailed documentation, this is always needed. Any help around this would be appreciated. However, since this is not a specific enough issue, I'll go ahead and close it.

@azeey azeey closed this as not planned Won't fix, can't repro, duplicate, stale Jul 22, 2024
@github-project-automation github-project-automation bot moved this from Inbox to Done in Core development Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Archived in project
Development

No branches or pull requests

2 participants