Document entire codebase

[jdtzmn]

Summary

The generated documentation website PR (#333) automates the generation of a static documentation website for all of the existing doc comments. In the future, we should add doc comments to every single piece of the codebase, as well as linting errors when a function does not have comments.

An initial attempt into this has been started on the jacob/typedoc-with-linting branch, where linting rules have been set up to help with finding pieces of code that are missing documentation.

Scope

We'd have to update documentation for something like 400 functions. The work is straightforward but there are a lot of them.

• [ ] Add doc comments to the entire codebase
• [x] Add linting rules that warn a user when a function is missing required documentation

Urgency

This would improve the documentation a lot. While not necessarily urgent that we get this done (in that it doesn't cause bugs or issues), this should be done.