Our project documentation is in the docs folder. It is written in Markdown and is compiled into HTML using MkDocs.
MkDocs can be run locally using the make serve-docs command which runs the docs
docker container. Alternatively, you can run the docs docker container by enabling the
docs compose profile.
The documentation will be served at http://0.0.0.0:8002.
Note: you may need the following available if you wish to run this on your local machine: https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/ For macOS, you can install the required dependencies using Homebrew:
brew install cairo freetype libffi libjpeg libpng zlib