Documentation generation

[Adam Janicki]

Summary

Adding this as an issue to centralize the work for looking into generating documentation for vASTly. In summary, there are few options available for auto-generating documentation from JSDocs.

Option 1: TypeDoc

TypeDoc is primarily used to generate documentation for TypeScript projects, but it can still work with JS.

Pros

TypeDoc auto-generates a directory of HTML + CSS which together make up a fully-functioning docs site.

Cons

The only downside of this package is that since it was built for typescript files, you have to specify a small tsconfig.json to use it.

{
    "compilerOptions": {
        "allowJs": true,
    },
    "include": [
        "src/**/*.js"
    ]
}

Option 2: JSDoc

Pros

Was made for working with JavaScript specifically, so there are no issues with making JavaScript compatible with the generator.

Cons

The generated documentation doesn't look great, and only generated a syntax highlighted version of the whole file, which isn't helpful at all.

---

With all this in mind, and lack of really any other options, moving forward with TypeDoc is the best choice.