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

No specification for v12, v13, or v14 + general documentation request #1485

Open
benbaarber opened this issue Oct 4, 2024 · 0 comments
Open

Comments

@benbaarber
Copy link

I have been working with gazebo harmonic which ships with sdf v14. There seems to be helpful specification on sdformat.org for v11 and prior versions, but none at all for any of the newer versions. I am continuously running into issues with unsupported and undocumented elements. How am I or anyone else using gazebo supposed to know all the ins and outs of the newer SDF versions if there are no docs? Where do I find this information? Am I expected to read the source code? Not even being sarcastic, genuinely just wondering what me and other users are supposed to do here.

I know open source moves fast, and can be unforgiving work, and I commend the open robotics team for creating such a powerful open source ecosystem for robotics. That said, I have worked with many open source tools, and gazebo and its supporting tools have the steepest learning curve and the most pitfalls and missing or incorrect documentation I have ever seen. I think it would be massively beneficial to your project, and especially to your users, to slow down a bit on the new features and lean in heavily to documenting existing ones.

I'm a huge fan of the work you all have put into this, and I think I speak for a lot of people when I say we need docs. The most powerful tool in the world could still be useless if nobody knows how to use it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Inbox
Development

No branches or pull requests

1 participant