Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

API reference

Generated by rustdoc from the code on every build of this site, private items included: it is for working on the project, not a library to depend on. The comments it shows are the ones in the code, so this is the reference that cannot drift from it.

CrateWhat it holds
pacenotes_sharedThe protocol types both sides compile against: serde only.
pacenotes_serverThe package and auth server: routes, the access decision, the store and manifest gen, conflict reports, the credential CLI.
Installer — libraryThe installer’s Win32-free logic: the tree and choice models, cache, ledger, engine, restore points, zip, sha256, the run log.
Installer — applicationThe Windows binary: the wizard and its scenes, the worker thread, WinHTTP, the UI vocabulary, strings, elevation.
mdbook_repo_linksThis book’s preprocessor, which points links to repository files at GitHub.

The installer’s two halves share a crate name, so each has a reference of its own. Their default server address is always the example one from installer/.env.example, never a deployment’s.

To build these pages locally, run docs/build.sh; see Development guide.