History

Zhaofeng Li d74df64826 Update nixpkgs, fix manual build		2022-01-01 16:41:35 -08:00
..
src	manual: Make mdbook-linkcheck happy	2022-01-01 16:41:35 -08:00
theme	Add manual	2021-11-17 22:21:00 -08:00
.gitignore	Add manual	2021-11-17 22:21:00 -08:00
book.stable.toml	Move closer to release	2021-11-18 13:15:20 -08:00
book.toml	Move closer to release	2021-11-18 13:15:20 -08:00
default.nix	Update nixpkgs, fix manual build	2022-01-01 16:41:35 -08:00
preprocess.py	Move closer to release	2021-11-18 13:15:20 -08:00
README.md	Move closer to release	2021-11-18 13:15:20 -08:00

README.md

Manual

You can read the rendered version here.

Building the Manual

The manual is rendered using mdBook. To build the manual, do nix build .#manual. You can also do nix build .#manualFast for a version without the CLI usage reference.

Marking Text for Specific Versions

You can mark text to be only visible in the unstable version of the manual:

<!-- UNSTABLE_BEGIN -->
You are currently reading the unstable version of the Colmena Manual.
Features described here will eventually become a part of version @apiVersion@.
<!-- UNSTABLE_END -->

The opposite can be done with the STABLE_{BEGIN,END} markers:

<!-- STABLE_BEGIN -->
You are currently reading the version @apiVersion@ of the Colmena Manual.
<!-- STABLE_END -->

Substitutions

@version@ - Full version string
@apiVersion@ - Stable API version string (major.minor)