List of packages that needs doc update: #3
Description
Machines in Motion repositories
Here is the list of the packages that needs a bit of doc update in the readme or in API html doc.
The list is long but could be shorter depending on the outcome of this discussion:
#2
- https://github.com/machines-in-motion/machines-in-motion.github.io
- https://github.com/machines-in-motion/mim_msgs
- https://github.com/machines-in-motion/risk_sensitive_control
- @hammoudbilal
- repackaging
- readme
- https://github.com/machines-in-motion/dg_blmc_robots
- to be determined
- readme
- API doc-strings
- Additionnal doc in markdown
- https://github.com/machines-in-motion/treep_machines_in_motion
- @MaximilienNaveau
- readme
- https://github.com/machines-in-motion/package_template
- @MaximilienNaveau
- Readme
- Check the API generated html
- https://github.com/machines-in-motion/yaml_utils
- to be determined
- Readme
- API doc
- https://github.com/machines-in-motion/mim_estimation (private but we want to open it)
- @ahmadgazar
- Readme
- API doc
- https://github.com/machines-in-motion/real_time_tools
- to be determined
- Readme
- API doc
- https://github.com/machines-in-motion/time_series
- @luator
- readme
- check the API html generation.
- https://github.com/machines-in-motion/mpi_cmake_modules
- @MaximilienNaveau
- readme
- html doc
- https://github.com/machines-in-motion/dg_tools
- @avadesh02
- readme
- html doc
- https://github.com/machines-in-motion/kino_dynamic_opt
- @Neotriple
- check main readme
- check API doc (repackage to have 1 doc instead of 3 packages?)
- solver
- HTML doc
- solver_lqr
- html doc
- momentumopt
- html doc
- https://github.com/machines-in-motion/dynamic_graph_manager
- @hammoudbilal and @MaximilienNaveau
- Readme
- API doc
- https://github.com/machines-in-motion/bullet_utils
- @huaijiangzhu
- Readme, how to install the dependencies
- API doc see mpi_cmake_modules demo for how to make the
setup.py
- https://github.com/machines-in-motion/mim_control
- @jviereck
- Readme?
- API doc
Open Dynamic Robot Initiative
-
https://github.com/open-dynamic-robot-initiative/robot_properties_bolt
- @Lhumd
- Readme
- API doc + General Doc (How to simulate, point to bolt package)
-
https://github.com/open-dynamic-robot-initiative/bolt
- @Lhumd
- Readme
- API doc + General Doc (programs (calibration), demo, example DG as optional, point to robot_properties_bolt)
-
https://github.com/open-dynamic-robot-initiative/teststand
- @ShahramKhorshidi
- Readme
- API doc + General Doc (programs (calibration), demo, example DG as optional etc)
-
https://github.com/open-dynamic-robot-initiative/robot_properties_teststand
- @ShahramKhorshidi
- Readme
- API doc + General Doc (programs (calibration), demo, example DG as optional etc)
-
https://github.com/open-dynamic-robot-initiative/blmc_robots
- @jviereck
- Readme: Remove everything besides solo from the package open-dynamic-robot-initiative/solo#97
- API doc + General Doc (programs (calibration), demo)
-
https://github.com/open-dynamic-robot-initiative/robot_properties_solo
- @jviereck or @huaijiangzhu or @avadesh02 or ...
- Readme: https://github.com/open-dynamic-robot-initiative/robot_properties_solo/pull/34/files
- API doc + General Doc (simulation, config, etc)
-
https://github.com/open-dynamic-robot-initiative/odri_control_interface
-
https://github.com/open-dynamic-robot-initiative/blmc_drivers
- @MaximilienNaveau
- Readme
-
https://github.com/open-dynamic-robot-initiative/ati_ft_sensor
- @Lhumd
- Readme
- Pull out the doc from the MPI confluence and add it to the package!
- API doc.