DOCUMENTATION / LEARN → LOOK UP → UNDERSTAND

Organised by the question you arrived with.

Tutorial, reference, how-to and explanation stay separate, so the contract can be looked up without reading an argument about architecture first.

TUTORIAL

Get one real answer out of it

First packed container

Install one package, send one request on stdin and read the answer in the order it is meant to be read.

Open ↗

HOW-TO

Solve one specific task

Extending an engine

Five in-process extension points, and the rule that decides when a rule belongs in the request instead.

Open ↗

REFERENCE

Look up the exact contract

Request and result contract

The public fields, what each status means, and the rule a capability must satisfy before it is one.

Open ↗

The objective vector

How results are ranked, why every key is an exact integer, and what an equal score does not imply.

Open ↗

EXPLANATION

Understand why it is built this way

Why a library, not a service

The layer boundary that keeps a solver free of networks, clocks and databases.

Open ↗

FIRST TIME HERE?

Start with one packed container.

Install one package and pack eight cubes into one carton. Once you have read a real status, a real score and a real refusal, the rest of the contract explains itself.

Open the tutorial ↗