Documentation

Important

Work in Progress!

This section is a work in progress, and will be updated soon (When I get bored with my current work, or you decide to complete it ✌️).

An important aspect of building robotic systems is the documentation, because of the large amount of components involved one tends to forget their configuration and functionalities. Proper documentation is required for easier debugging, maintenance, and scalability of the system. You should write documentation for yourself, if not for others to read, like I have made this documentation for myself and in the process it helps others to contribute to your project.

How to write technical documentation

You can write sentences, you can write paragraphs. Can you organise all those paragraphs into a coherent document?

Markdown

Using Sphinx to write documentation

Sphinx is a documentation generator, the documentation you are currently reading is generated using Sphinx, and lots of other projects use it too.