Closed prashanthr05 closed 3 years ago
Relevant links for this must be added when updating the README for https://github.com/robotology/whole-body-estimators/issues/55
friendly ping @HosameldinMohamed @fjandrad @traversaro !!
Ok. Minor comment: can we make sure that this page is linked by the README or by some more central piece of documentation (doxygen?).
Ok, I will work on that before merging.
Ciao guys!
I updated the overall documentation for wholeBodyDynamics
device within this PR. I would ask you to re-review it.
For a demo, please see https://github.com/prashanthr05/whole-body-estimators/tree/doc/howto.
Feel free to update the documentation by adding relevant paper references (which is the only thing missing currently).
Thank @prashanthr05 for handling this! If we want to keep the docs in the README (that I think is indeed a good idea) I suggest to remove them from the doxygen blocks, otherwise the two copies of the docs will probably diverge soon.
Thank @prashanthr05 for handling this! If we want to keep the docs in the README (that I think is indeed a good idea) I suggest to remove them from the doxygen blocks, otherwise the two copies of the docs will probably diverge soon.
Looks like I missed porting part of the documentation from the doxygen to the README, relating to the FT Offsets and temperature coefficients.
I will update that and remove the doxygen then.
Thank @prashanthr05 for handling this! If we want to keep the docs in the README (that I think is indeed a good idea) I suggest to remove them from the doxygen blocks, otherwise the two copies of the docs will probably diverge soon.
Looks like I missed porting part of the documentation from the doxygen to the README, relating to the FT Offsets and temperature coefficients.
I will update that and remove the doxygen then.
I've done this in https://github.com/robotology/whole-body-estimators/pull/84/commits/c91e03625b95a82799d8fe1f8940f3d36120690f
@HosameldinMohamed I request you to look at the relevant changes and merge the PR if you approve. Thanks in advance..!
Friendly ping @HosameldinMohamed
Thanks @HosameldinMohamed !
docs
folderdocs
folderwholeBodyDynamcis
device to a folder level README (removed the doxygen documentation to avoid any future divergence of redundant documentations cc @traversaro's wise words)Fixes #50 Fixes #55