Documentation

Build from source

Install the locked tools and build from the repository root:

rustup show
mise install --locked
cargo build --release

The executable is target/release/peryx on Unix and target/release/peryx.exe on Windows. Start a local process with:

./target/release/peryx serve

Repeat mise install --locked when a checkout changes mise.toml or mise.lock. Browser recipes manage the separate mise.browser.toml and mise.browser.lock inputs. Run rustup show when the compiler version changes; it downloads the version pinned by rust-toolchain.toml. A linker or system-library error means the host lacks a build dependency for its target. Check the failing package name and install that dependency through the host package manager.

Use just docs, just site-links, and just pre-commit before sending documentation changes. The contributing guide lists the full validation suite.