Skip to content

Latest commit

 

History

History
36 lines (25 loc) · 1.77 KB

File metadata and controls

36 lines (25 loc) · 1.77 KB

Lean Toolchain documentation

This site tracks the Lean 4 library in this repository: cryptographic primitives (LeanToolchain/Crypto), discrete linear algebra (LeanToolchain/Math), benchmarks, and the template-based Rust generator behind the rust/ crate.

Start here

Topic Where to read
Clone, build, first commands Quick start
Lean, Elan, Rust setup Installation
Contributing rules, toolchain bumps, sorry policy Contributing (links to repo root)
SentinelOps vs GitHub Actions CI overview
What lake exe extract actually does Rust code generation
Lean coding style, proof tips Style guide
Crypto API (Lean + generated Rust contract) Crypto API
Vectors, matrices, norms (Lean) Math API
Vec design notes Vector implementation

Repository entrypoints

Building these docs

From the repository root (with mkdocs and the Material theme installed, for example pip install mkdocs-material):

mkdocs build -f docs/mkdocs.yml

The HTML output defaults to site/ relative to the current working directory unless overridden in your mkdocs setup.

Toolchain

The Lean release is pinned in lean-toolchain; mathlib is pinned in lakefile.lean and must stay compatible with that Lean version.