History

Zhaofeng Li 3e552f50a9 manual/release-notes: Prepare for 0.4.0 release		2023-05-14 23:05:08 -06:00
..
src	manual/release-notes: Prepare for 0.4.0 release	2023-05-14 23:05:08 -06: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	manual: Migrate to cli.rs domain	2022-05-08 17:43:48 -07:00
book.toml	manual: Migrate to cli.rs domain	2022-05-08 17:43:48 -07:00
colorized-help.nix	Add `repl` subcommand	2022-08-16 20:16:00 -06:00
default.nix	manual: Migrate to cli.rs domain	2022-05-08 17:43:48 -07:00
preprocess.py	Apply flake8 to manual preprocessor	2022-06-24 17:34:37 -07:00
README.md	Migrate other doc links to new domain	2022-05-13 19:14:58 -07: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)