📚 Towards the MRS UAV System 1.5 - please help updating the documentation - Githubissues

ctu-mrs / mrs_uav_system

The entry point to the MRS UAV system.

https://ctu-mrs.github.io/

BSD 3-Clause "New" or "Revised" License

436 stars 86 forks source link

📚 Towards the MRS UAV System 1.5 - please help updating the documentation #169

Open klaxalk opened 1 year ago

klaxalk commented 1 year ago

Here is the list of TODOs for the new MRS UAV System 1.5:

<\<WIP>> = Work In Progress = it should not contain old/wrong info anymore

README TODOs:

High priority

[ ] https://github.com/ctu-mrs/mrs_uav_system <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_uav_core <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_uav_modules <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_uav_gazebo_simulation <\<WIP>>
[ ] https://github.com/ctu-mrs/octomap_mapping_planning <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_singularity <\<WIP>>

Low priority

[ ] https://github.com/ctu-mrs/mrs_uav_managers <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_uav_hw_api <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_uav_coppelia_simulation <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_uav_dji_tello_api
[ ] https://github.com/ctu-mrs/mrs_uav_px4_api
- we should add requirements for PX4 settings and params
[ ] https://github.com/ctu-mrs/mrs_lib <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_multirotor_simulator <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_rviz_plugins <\<WIP>>
[ ] https://github.com/ctu-mrs/mrs_uav_controllers <\<WIP>>
[x] https://github.com/ctu-mrs/mrs_uav_state_estimators
[ ] https://github.com/ctu-mrs/mrs_hector_core
[ ] https://github.com/ctu-mrs/mrs_open_vins_core
[x] https://github.com/ctu-mrs/mrs_uav_autostart
[ ] https://github.com/ctu-mrs/mrs_uav_status
[ ] https://github.com/ctu-mrs/mrs_uav_trackers <\<WIP>>
[x] https://github.com/ctu-mrs/mrs_uav_trajectory_generation
[ ] https://github.com/ctu-mrs/mrs_aloam_core
[ ] make sure the links on the right-hand-side of Github don't point to the old system repositories
[ ] put disclaimers to all READMEs of the MRS package (list of our packages)
[ ] Update the system diagram in the main readme

Documentation TODOs:

[x] Update the ROS interface https://ctu-mrs.github.io/docs/system/uav_ros_interface.html
[ ] Update and simplify https://ctu-mrs.github.io/docs/software/catkin/managing_workspaces/managing_workspaces.html <\<WIP>>
[x] Delete this https://ctu-mrs.github.io/docs/system/flying_without_mrs_odom.html
[x] Update https://ctu-mrs.github.io/docs/system/preparing_for_a_real-world_experiment.html
[ ] Update https://ctu-mrs.github.io/docs/system/bashrc_configuration.html <\<WIP>>
[ ] Update https://ctu-mrs.github.io/docs/system/custom_configs.html <\<WIP>>
[x] Delete https://ctu-mrs.github.io/docs/system/speed_tracker.html
[x] Update https://ctu-mrs.github.io/docs/system/relative_commands.html
[ ] Update https://ctu-mrs.github.io/docs/simulation/howto.html <\<WIP>>
[ ] Update and potentially merge https://ctu-mrs.github.io/docs/simulation/gazebo/gazebo/drone_spawner.html with the README <\<WIP>>
[ ] Update https://ctu-mrs.github.io/docs/simulation/gazebo/gazebo/custom_world.html
[x] Update https://ctu-mrs.github.io/docs/introduction/how_to_update.html
[ ] Update https://ctu-mrs.github.io/docs/introduction/how_to_compile.html <\<WIP>>
[ ] Update https://ctu-mrs.github.io/docs/software/known_issues.html
[ ] Update https://ctu-mrs.github.io/docs/software/ros_remote.html (the CheatSheet has the most up-to-date info)
[x] Delete https://ctu-mrs.github.io/docs/software/mavros.html, is not relevant anymore
[ ] Update https://ctu-mrs.github.io/docs/software/gitman.html <\<WIP>>
[ ] Update https://ctu-mrs.github.io/docs/system/frames_of_reference.html <\<WIP>>
[ ] Update https://ctu-mrs.github.io/docs/system/trajectories.html
[ ] Update https://ctu-mrs.github.io/docs/simulation/gazebo/gazebo/simulation_speed.html
[x] Create a Python script + documentation for the thrust curve parameter estimation
[ ] Add comments and descriptions to mrs_msgs

Packages TODOs

[ ] mrs_uav_deployment should be split into public and private versions
[x] we should switch from Singularity to the new FOSS Apptainer
[x] Put debug_roslaunch to mrs_uav_shell_additions or somewhere where it makes sense.

Examples TODOs

[ ] Create a state estimator example
[x] refactor the old UAV examples
[ ] Recreate the old Gazebo Tmux examples, now, there are only a few <\<WIP>>

Automation TODOs:

[x] resurrect the automated documentation build for mrs_msgs
[x] resurrect the ROS test pipeline for mrs_lib <\<WIP>>
[x] add the automated documentation build for mrs_modules_msgs
[x] resurrect the automated documentation build for mrs_lib
[x] resurrect the ROS Tests from mrs_uav_testing on the GitHub server <\<WIP>>
[x] update the Docker server-site builds of the MRS UAV System
[ ] add automated docs for mrs_uav_managers and the controller/tracker/estimator interfaces
[ ] add automated docs for mrs_uav_hw_api and fill in the docs for the plugin API <\<WIP>>