So far we have been implementing documentation as we go with inline comments that haven't followed any particular format. This should be cleaned up by using a js API documentation generator, for which we will choose jsdoc.
This will require a few things:
Standard format for all docstrings throughout the code base
npm script which builds the documentation
Update the main workflow to build and deploy the documentation on push
Setup Github pages to host the documentation site to which the doc build is deployed
So far we have been implementing documentation as we go with inline comments that haven't followed any particular format. This should be cleaned up by using a js API documentation generator, for which we will choose jsdoc. This will require a few things: