robotology / yarp

YARP - Yet Another Robot Platform
http://www.yarp.it
Other
524 stars 195 forks source link

Cleanup Yarp Motor Interfaces documentation #1139

Open traversaro opened 7 years ago

traversaro commented 7 years ago

We have several points of introduction to the Yarp Motor Interfaces. I list the one that I found, and my proposal on what to do with them:

Material Proposed action Implemented
https://github.com/robotology/yarp/blob/master/doc/yarp_motor_control.dox KEEP IT, Make this the main entry point for documentation of Yarp Motor Interfaces, cleanup of old and outdated material and add links to any relevant material.
http://web.archive.org/web/20191020030920/http://wiki.icub.org/wiki/Motor_control DELETE IT , Superseded by http://wiki.icub.org/brain/icub_motor_control_tutorial.html . However this page as a nice reference to the difference between remote and local devices, and it worth making sure that yarp_motor_control.dox contains everything related to that.
http://web.archive.org/web/20190909220405/http://wiki.icub.org/wiki/YARP_Motor_Control Merge its content with https://github.com/robotology/yarp/blob/master/doc/yarp_motor_control.dox, and DELETE IT
http://www.yarp.it/group__dev__iface__motor.html Group containing all the motor control interfaces. KEEP IT and link it to the main yarp_motor_control.dox page
http://web.archive.org/web/20191101171749/http://wiki.icub.org/wiki/Force_Control#Available_control_modes DELETE IT, and move the interesting part to some doxygen documentation
https://github.com/robotology/icub-tutorials/blob/master/doc/motor_control_tutorial.dox This is tough. It is probably the best tutorial on motor control, so it would make sense to have something similarly in YARP rather then icub-tutorials. The possibility are to move it in YARP, and have some similar tutorial in YARP, leaving this one in icub-tutorials. I DO NOT KNOW
http://web.archive.org/web/20190909220720/http://wiki.icub.org/wiki/Control_Modes The PDF describing the documentation of the control modes is a great work, but it is definitely more YARP-related then just being related to iCub, but I don't know where we could put it. Committing the PDF to the repo is probably undesirable, right? I DO NOT KNOW
drdanz commented 7 years ago

+1 for removing all YARP-only documentation from iCub wiki and move it in YARP

Material Proposed action
http://wiki.icub.org/wiki/Control_Modes The PDF describing the documentation of the control modes is a great work, but it is definitely more YARP-related then just being related to iCub, but I don't know where we could put it. Committing the PDF to the repo is probably undesirable, right? I DO NOT KNOW

The PDF is a very good work, but I'd like to see it in YARP documentation and PDF is not the right choice. It is not easy to search inside it, and this makes it difficult to keep it updated. For example, I think that @randaz81 is working on a couple of new control modes, but I don't know if he will remember to update this doc... 😉

Perhaps we can copy-paste it in a markdown file and perhaps use either doxygen or some other specific tool (for example this) to re-generate the PDF? (Assuming that we actually need it, having them in yarp documentation looks good enough to me)

randaz81 commented 7 years ago

I'm currently working on http://wiki.icub.org/wiki/Control_Modes