(WIP) MetricQ RPC documentation

This repository attempts to document the MetricQ RPC interface using the AsyncAPI specification.

Accessing the documentation

Documentation build from the master branch and deployed here.

Building it yourself

Build using the dockerized version of the AsyncAPI Generator:

# ./docker-build.sh

Or install the necessary dependencies (e.g. AsyncAPI Generator, the HTML template):

$ npm install --only=dev

Then, run:

$ ag -p sidebarOrganization=byTags \
    --output docs  \
    manager.asyncapi.yaml ./template

...and find the generated HTML files in docs/.