From 6973c38de2cc35c8ebc5b5444e998bbc5b6d762e Mon Sep 17 00:00:00 2001 From: Jacek Sieka Date: Tue, 29 Oct 2024 08:57:11 +0100 Subject: [PATCH] bump mdbook version req * use same versions as style guide * remove obsoletion notice from summary - this is not supported by mdbook: https://github.com/rust-lang/mdBook/issues/1766 --- Makefile | 4 ++-- docs/README.md | 4 ++-- docs/the_auditors_handbook/src/SUMMARY.md | 3 --- 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/Makefile b/Makefile index a68198e53..855a637ce 100644 --- a/Makefile +++ b/Makefile @@ -801,10 +801,10 @@ book: "$(MAKE)" -C docs book auditors-book: - [[ "$$(mdbook --version)" == "mdbook v0.4.35" ]] || { echo "'mdbook v0.4.35' not found in PATH. See 'docs/README.md'. Aborting."; exit 1; } + [[ "$$(mdbook --version)" == "mdbook v0.4.36" ]] || { echo "'mdbook v0.4.35' not found in PATH. See 'docs/README.md'. Aborting."; exit 1; } [[ "$$(mdbook-toc --version)" == "mdbook-toc 0.14.1" ]] || { echo "'mdbook-toc 0.14.1' not found in PATH. See 'docs/README.md'. Aborting."; exit 1; } [[ "$$(mdbook-open-on-gh --version)" == "mdbook-open-on-gh 2.4.1" ]] || { echo "'mdbook-open-on-gh 2.4.1' not found in PATH. See 'docs/README.md'. Aborting."; exit 1; } - [[ "$$(mdbook-admonish --version)" == "mdbook-admonish 1.13.1" ]] || { echo "'mdbook-open-on-gh 1.13.1' not found in PATH. See 'docs/README.md'. Aborting."; exit 1; } + [[ "$$(mdbook-admonish --version)" == "mdbook-admonish 1.14.0" ]] || { echo "'mdbook-open-on-gh 1.13.1' not found in PATH. See 'docs/README.md'. Aborting."; exit 1; } cd docs/the_auditors_handbook && \ mdbook build diff --git a/docs/README.md b/docs/README.md index 948686931..3dd3b367e 100644 --- a/docs/README.md +++ b/docs/README.md @@ -10,10 +10,10 @@ Some books in this folder were produced using [mdBook](https://github.com/rust-l ```bash # Install or update tooling (make sure you add "~/.cargo/bin" to PATH): -cargo install mdbook --version 0.4.35 +cargo install mdbook --version 0.4.36 cargo install mdbook-toc --version 0.14.1 cargo install mdbook-open-on-gh --version 2.4.1 -cargo install mdbook-admonish --version 1.13.1 +cargo install mdbook-admonish --version 1.14.0 # Work on the book locally - open "http://localhost:4000" for live version cd docs/the_auditors_handbook diff --git a/docs/the_auditors_handbook/src/SUMMARY.md b/docs/the_auditors_handbook/src/SUMMARY.md index dcbab0594..6de089903 100644 --- a/docs/the_auditors_handbook/src/SUMMARY.md +++ b/docs/the_auditors_handbook/src/SUMMARY.md @@ -1,8 +1,5 @@ # Summary -!!! warning - This auditors' handbook is frozen and obsolete; the [Nim language manual](https://nim-lang.org/docs/manual.html) alongside [other Nim documentation](https://nim-lang.org/documentation.html), [Status Nim style guide](https://status-im.github.io/nim-style-guide/), [Chronos guides](https://github.com/status-im/nim-chronos/blob/master/docs/src/SUMMARY.md), and [Nim by Example](https://nim-by-example.github.io/getting_started/) supercede it. - - [Introduction](01_introduction.md) - [The Nim Programming Language](02_the_Nim_programming_language.md) - [Nim routines, procedures, functions, templates, macros](02.1_nim_routines_proc_func_templates_macros.md)