Skip to content

Documentation

The documentation in the repository is divided into a few main parts:

  1. Rust crate documentation (/target/doc/)
  2. User documentation (/docs/)
  3. Developer documentation (/docs/dev/)
  4. Compiled and aggregated docs (/site/)

The Rust-related documentation is created by rustdoc. The user and developer documentation is a set of Markdown files that are generated into a static website using Zensical. All these generated HTML files are aggregated into /site/ to be served via GitLab Pages and the justfile in the top-level of the repository provides some recipes for easily generating them all.