---
title: Contributing
group: Contributing
---

# Contributing

## Updating Documentation

Documentation is setup to be hosted on github pages, it is generated using typedoc.

Typedoc documentation can be found here: <https://typedoc.org/>

### Guides

The files for the guides are located in the documentation folder, they are written in markdown

### Module Documentation

To update the typedoc generated documentation for the module, run the following commands in the root of the repo:

    npm install # Install only needs to be run first time.
    npm run docs