Skip to content
Snippets Groups Projects

Improve documentation

Merged Cagil Guemues requested to merge improve_documentation into main

After fiddling with PDF generation, I came to the conclusion that generating a master PDF for the entire project documentation is a bit unrealistic.

There are certain issues with changing imagedir attribute and things don't get rendered correctly. I think we might stick with HTML as a main documentation for our project.

  • Added cover page (most probably won't be used)
  • bump motion control module
  • added motion_control and bsp_motctrl documentation to the navigation entry for quick access
  • added Hardware setup guide

TODO: There is still a software setup guide part is missing. It would be nice if @randall can do that part? It's also fine to merge it without it.

Merge request reports

Approved by

Merged by Cagil GuemuesCagil Guemues 1 year ago (Sep 20, 2023 10:46am UTC)

Merge details

  • Changes merged into main with e6b8ea9c (commits were squashed).
  • Deleted the source branch.

Pipeline #94950 passed

Pipeline passed for e6b8ea9c on main

Activity

Filter activity
  • Approvals
  • Assignees & reviewers
  • Comments (from bots)
  • Comments (from users)
  • Commits & branches
  • Edits
  • Labels
  • Lock status
  • Mentions
  • Merge request status
  • Tracking
Please register or sign in to reply
Loading