Docs

Repository with docs for our API service

Setup

This repository uses MkDocs with Material theme. We use Docker for development.

Development

See here for more info on how to develop using their the theme's docker image. To start a development server:

$ docker compose up

Your server will be available on localhost:8000.

Quirks

Please, use the docker compose configuration to start you container. It avoids some weird problems with file permissions and such.