--amend

Author: arnetheduck

.github/workflows/docs.yml

@@ -18,27 +18,7 @@ jobs:
         uses: actions/checkout@v4
         with:
           submodules: true
-      - uses: actions-rs/[email protected]
-        with:
-          crate: mdbook
-          use-tool-cache: true
-          version: "0.4.51"
-      - uses: actions-rs/[email protected]
-        with:
-          crate: mdbook-toc
-          use-tool-cache: true
-          version: "0.14.2"
-      - uses: actions-rs/[email protected]
-        with:
-          crate: mdbook-open-on-gh
-          use-tool-cache: true
-          version: "2.4.3"
-      - uses: actions-rs/[email protected]
-        with:
-          crate: mdbook-admonish
-          use-tool-cache: true
-          version: "1.20.0"
-
+      - uses: Swatinem/rust-cache@v2
       - uses: jiro4989/setup-nim-action@v1
         with:
           nim-version: '1.6.20'
@@ -47,7 +27,6 @@ jobs:
         run: |
           nim --version
           nimble --version
-          nimble install -dy
           nimble mdbook
           nimble docs || true
 

docs/src/SUMMARY.md

@@ -1,15 +1,8 @@
 - [Introduction](./introduction.md)
-- [Examples](./examples.md)
 
 # User guide
 
-- [Core concepts](./concepts.md)
-- [`async` functions](async_procs.md)
-- [Errors and exceptions](./error_handling.md)
-- [Threads](./threads.md)
-- [Tips, tricks and best practices](./tips.md)
-- [Porting code to `chronos`](./porting.md)
-- [HTTP server middleware](./http_server_middleware.md)
+- [Getting started](./getting_started.md)
 
 # Developer guide
 

docs/src/async_procs.md

@@ -1 +1,15 @@
 # Updating this book
+
+This book is built using [mdBook](https://rust-lang.github.io/mdBook/), which in
+turn requires a recent version of `rust` and `cargo` installed.
+
+```sh
+# Install correct versions of tooling
+nimble mdbook
+
+# Run a local mdbook server
+mdbook serve docs
+```
+
+A [CI job](../../.github/workflows/docs.yml) automatically published the book
+to [GitHub Pages](https://pages.github.com/).

docs/src/book.md

@@ -46,7 +46,7 @@ task test, "Run all tests":
     run threads, "tests/test_all"
 
 task mdbook, "Install mdbook (requires cargo)":
-  cargo install mdbook@0.4.51 mdbook-toc@0.14.2 mdbook-open-on-gh@2.4.3 mdbook-admonish@1.20.0
+  exec "cargo install [email protected] [email protected] [email protected] [email protected]"
 
 task docs, "Generate API documentation":
   exec "mdbook build docs"