Introduction

Documentation, just like these guidelines, are extremely important for future developers, students, or scientists, so that they can have a quick reference somewhere on the web to answer their questions. Without documentation, seeking information can take up the majority of one's time. It's important that most of any code developed has documentation that is easily readable, modular, and has a consistent format, all to allow ease of access.

Here at CHIME, there are four different ways we document information:

• Comments (For adding auxiliary information)
• Docstrings (For creating automated documentation web pages per repository, by utilizing docstring comments following a convention)
• Markdown (For quickly building simple styled text files, such as a README.md per repository)
• MkDocs (For building documentation UIs like these guidelines, from Markdown files)