Source for the hylic documentation site. The site rebuilds and publishes from this repo's master branch via .github/workflows/pages.yml.
The book covers three crates from the hylic family. From hylic it has the recursive pattern and per-piece guides (fold, treeish, executor), an introduction to lifts, and a worked-example cookbook. From hylic-pipeline it has the pipeline overview, the sugar catalogue, and a chapter on writing custom lifts. The Funnel deep-dive covers the parallel executor in detail: the CPS walk, defunctionalised continuations, ticket system, pool dispatch, and per-axis chapters on queue topology, accumulation, and wake. Benchmark results from hylic-benchmark are rendered with an interactive viewer that marginalises on the policy matrix.
Code samples in the book are pulled from src/docs_examples.rs and the per-recipe files under src/cookbook/ via mdBook {{#include}} directives. cargo test -p hylic-docs compiles and runs every snippet the book embeds, so the rendered code is always type-correct against the version of hylic and hylic-pipeline the workspace points at.
cd book && mdbook build # → ../target/book/
cd book && mdbook serve # preview at http://localhost:3000/mdbook and mdbook-graphviz are required, plus graphviz at the system level. A local build expects the workspace layout (hylic/ and hylic-pipeline/ next to this crate), since {{#include}} paths reach into sibling crates. Not published to crates.io.
Licensed under the MIT License.