From 6b41560d192f3025e0ad6ccab6ceba529040a521 Mon Sep 17 00:00:00 2001 From: Rohit Goswami Date: Tue, 17 Nov 2026 21:19:03 +0000 Subject: [PATCH] docs: clarify msrv and align examples manifest --- README.md | 1 + changelog.d/+msrv-docs-and-examples.doc.md | 1 + docs/examples/Cargo.toml | 1 + docs/src/getting-started.md | 8 +++++++- 4 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 changelog.d/+msrv-docs-and-examples.doc.md diff --git a/README.md b/README.md index 906d5a4..e8169c1 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,7 @@ The guide, , is an mdBook in [`docs/`](do ## Install The three crates share one version. Install the same version of each. +Minimum supported Rust version (MSRV): Rust 1.85. ```text cargo add rfc9162@0.10.0 diff --git a/changelog.d/+msrv-docs-and-examples.doc.md b/changelog.d/+msrv-docs-and-examples.doc.md new file mode 100644 index 0000000..fef417b --- /dev/null +++ b/changelog.d/+msrv-docs-and-examples.doc.md @@ -0,0 +1 @@ +The install and getting-started docs now state the minimum supported Rust version (1.85) before `cargo add`, and `docs/examples/Cargo.toml` now inherits the workspace `rust-version` so the examples package declares the same compiler floor as the crates. diff --git a/docs/examples/Cargo.toml b/docs/examples/Cargo.toml index f7bf9a4..9a98dce 100644 --- a/docs/examples/Cargo.toml +++ b/docs/examples/Cargo.toml @@ -2,6 +2,7 @@ name = "rfc9162-docs-examples" version = "0.0.0" edition = "2021" +rust-version.workspace = true publish = false license = "MIT" description = "Runnable examples for the rfc9162 documentation" diff --git a/docs/src/getting-started.md b/docs/src/getting-started.md index d52ef72..a5814dc 100644 --- a/docs/src/getting-started.md +++ b/docs/src/getting-started.md @@ -2,7 +2,13 @@ This program hashes three records, checks an inclusion proof for each, then checks that a fourth record is an append. It uses only `rfc9162`. Storage and signatures are the [tutorial](tutorials/build-a-log.md). -Install Rust from the [installation](install/index.md) page, then: +Install Rust from the [installation](install/index.md) page. `rfc9162` needs Rust 1.85 or newer: + +```text +rustc --version +``` + +Then: ```text cargo new ct-log