This site

The documentation is Markdown in docs/content/, turned into a site by Hugo with the Hextra theme. It is the one part of the repository that needs tools from outside it. Those are pinned in flake.nix, so building the site needs Nix and nothing else installed by hand.

Build it

nix build .#docs

The site is written to result/. The build treats every warning as an error, so a link to a page that does not exist stops it.

Work on it

nix develop -c hugo server --source docs

This serves the site locally and rebuilds it as files change.

How it is published

A push to main runs the workflow in .github/workflows/docs.yml. It builds the site the same way and uploads result/ to Cloudflare Pages, which serves it at qdx.recregt.com. A pull request runs the build only, without publishing.

Examples must run

Every complete program shown in these pages was compiled and run, and its output copied from the run. When you change an example, run it again and paste what it prints. The finished program from the guide is also run by the test suite, from examples/scores/.