docs

Developer Docs

Prerequisites

To build the docs, you need mdbook, mdbook-plantuml and PlantUML on your PATH.

The first two can be installed through cargo:

$ cargo install mdbook mdbook-plantuml

Make sure that you have ~/.cargo/bin/ on your PATH.

Building

You can build the HTML with mdbook build.

To serve the docs on localhost:3000 and watch for changes, use mdbook serve.