# Guidelines for Documentation Authors <!-- omit in toc -->


- [1. Source Control Images/Videos](#1-source-control-imagesvideos)
- [2. Stylistic Recommendations](#2-stylistic-recommendations)
- [3. Feel Free to Add Other Recommendations/Guidelines](#3-feel-free-to-add-other-recommendationsguidelines)

## 1. Source Control Images/Videos

- Text based assets are preferred in order to keep the git repository's size to
a minimum.
- Videos should be uploaded to popular video sharing platform(s) and linked to.
- Diagrams/Figures should be generated from their text based representations so that changes can be tracked easily without having to read binary code. (PlantUML, Mermaid, etc. are great tools for this)

## 2. Stylistic Recommendations

TODO

## 3. Feel Free to Add Other Recommendations/Guidelines