Template for Documentation of Packages

The following is the template that shall be followed to create a documentation of all the packages that are written for the vehicle. This has to be done using the markdown language, the cheatsheet for which is available here. To maintain uniformity, it is recommended that these guidelines are strictly followed.

Naming the Documentation

The name of the documentation file should be that of the package name. For instance, for our hardware_arduino this would be hardware_arduino.md.

Contents

The contents would be divided into the following manner:

1. Overview of the Package
2. Installation
3. Building the Package
4. Nodes in the Package
5. Running the Package
6. Known Issues
7. Demo Videos

1. Overview

This comprises of the overview and a brief summary about the packages and its plug-ins. All the necessary details which one should know about must be mentioned here and its usage must also be specified.

2. Installation

This comprises of the installation procedure and the installation links for the package. All the installation terminal commands must be specified here only..........Dependencies stuff goes here too.

3. Building the package

This comprises of the links or the exact tutorials to implement that package in the code and how to link it through our existing nodes. Instructions to build the package

4. Nodes in the package

Explain purpose of each node (in 50 words). Along with that make a table that includes the topics that are subscribed to and the topic to which data is published. Mention also the topic datatype. Also write about the parameter stuff, config stuff, which node requires dynamic reconfig.....Could go into the tutorials...........

5. Running the package

6. Known Issues

7. Demo Videos