adding uml class diagram of example_1#914
adding uml class diagram of example_1#914peakyquest wants to merge 7 commits intoros-controls:masterfrom
Conversation
github-actions
bot
requested review from
DasRoteSkelett,
Maverobot,
anfemosa,
bmagyar,
christophfroehlich,
olivier-stasse and
progtologist
|
I have added a README file to the example_1 directory. |
Please don't, we use the doc/index.rst to be published on control.ros.org |
|
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. |
|
About the UML diagram, do I need to make changes on that as well? |
just leave the README as it is, it it just a summary and points to the rst file. |
|
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
left a comment
christophfroehlich
left a comment
There was a problem hiding this comment.
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
|
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. |
|
All requested modifications have been incorporated into the pull request. Looking forward to your feedback. |
|
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. |
destogl
force-pushed
the
uml_diagram_example_1
branch
from
0f23eed to
804b6fb
Compare
There was a problem hiding this comment.
Here few comments:
- on the right side instead os "system" left from the arrow, I would write "hardware component". It might actually be even better to have a rectangle added arround System and SystemInterface. I am also mssing concreate implemenation of the HWComponent in this diagram.
- We should also add relation between HardwareInfo and URDF, as this is filled from URDF.
- we should remove the "position_controller::..." as this is just confusing and we will probably remove those at some point.
| From the UML: | ||
|
|
||
| - ``hardware_interface::SystemInterface`` → implemented by the RRBot hardware plugin | ||
| - ``hardware_interface::ResourceManager`` → manages your hardware plugin after loading it |
There was a problem hiding this comment.
| - ``hardware_interface::ResourceManager`` → manages your hardware plugin after loading it | |
| - ``hardware_interface::ResourceManager`` → loads and manages the hardware plugins |
3 participants
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.