adding uml class diagram of example_1

[peakyquest]

I put together the UML class diagram and tried to keep it simple. I also added a notes section that connects it with example_1, so users can better follow what each block represents. I also made the flow diagram in draw.io and added the .svg file in the doc folder. Additionally, I’m including the .png format below for easier viewing.

After review and finalization, I plan to work on documentation that explains each process in detail. Please let me know whether these files should be kept inside the doc folder or placed within the example_1 directory.

[peakyquest]

I have added a README file to the example_1 directory.
Please review the changes and advise if any modifications are required either in the UML diagram or in the README content.

[christophfroehlich]

I have added a README file to the example_1 directory. Please review the changes and advise if any modifications are required either in the UML diagram or in the README content.

Please don't, we use the doc/index.rst to be published on control.ros.org
And please remove all the LLM icon decorations in the text.

[peakyquest]

Do you want me to delete the README file from the doc folder and move its content into doc/index.rst? I’ll also remove the references to LLM icons from the text.

[peakyquest]

About the UML diagram, do I need to make changes on that as well?

[christophfroehlich]

Do you want me to delete the README file from the doc folder and move its content into doc/index.rst? I’ll also remove the references to LLM icons from the text.

just leave the README as it is, it it just a summary and points to the rst file.

[peakyquest]

I’ve removed the icons and pointed the summary in the userdocs.rst. I hope this is what you were asking for, I apologizes as I am still learning

[christophfroehlich]

The idea was to include the text (formatted as RSt) in userdoc.rst, to have it automatically published https://control.ros.org/rolling/doc/ros2_control_demos/example_1/doc/userdoc.html
The syntax is a bit different, you can iterate with the github UI preview or install sphinx and build it locally, see https://github.com/ros-controls/control.ros.org/?tab=readme-ov-file#build-instructions

[peakyquest]

Thanks for the clarification! I’ve now included the README content, properly formatted in reStructuredText, into the userdoc.rst file so it will be automatically published on the documentation site.

[peakyquest]

All requested modifications have been incorporated into the pull request. Looking forward to your feedback.

[github-actions]

This PR is stale because it has been open for 45 days with no activity. Please tag a maintainer for help on completing this PR, or close it if you think it has become obsolete.