Skip to content

Documentation

Docs

Find the docs for the crate you are on. Each site is Diataxis: tutorial, how-to, explanation, reference. Prose is orgmode; HTML is the export.

Start here

readcon-core: CON checkpoints. Getting started, tutorial, spec, bindings.
minimage: Minimum-image wrap. A wrapped pair, embed C / C++ / Python, MIC and H, C API.

I/O

readcon-db: Corpus, indexes, campaign topology.

Kinetics

amsel: Source and crate docs until a Pages tree lands.
ChemGP: Source tree.

How the pages are written

Org under docs/orgmode/ or org/ is the source. export.el publishes HTML (or RST for the Sphinx trees). Do not edit the generated pages by hand.