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

Documentation Improvement #2175

Open
aristow1 opened this issue Feb 13, 2025 · 1 comment
Open

Documentation Improvement #2175

aristow1 opened this issue Feb 13, 2025 · 1 comment

Comments

@aristow1
Copy link

i have been going through the documentation latetly : https://cyclonedds.io/docs/cyclonedds/0.10.5/ trying to get some information.
for a DDS Vendor, such as cyclone, i find that the documentation layout is inferior to other DDS Vendors and i say this without meaning any disrespect. i have been a cyclonedds user for almost a year now and i would like to see a very structured nicely layed out documentation because i truly get frustrated every time when im trying to find something in the docu.
and can you please explain to me what this is ? : https://cyclonedds.io/docs/cyclonedds/latest/installation/installation.html . its the first link displayed by google when i type cyclonedds docu. and why is it missing many informations on different topics such as installation.
and what is cyclone 0.11.0 ? i thought the latest version is the 0.10.5 as shown here: https://cyclonedds.io/docs/

please make the documentation uniform with a nice UI for the users

@aristow1
Copy link
Author

i also want to mention, when trying to read the API documentation here : https://cyclonedds.io/docs/cyclonedds/latest/api/pub.html
on the top left corner of the page its showing v0.11.0. this is confusing for new people.

@aristow1 aristow1 changed the title Documentation Improvment Documentation Improvement Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant