chore: update mdbook and mermaid (#1977)

chore: update mdbook and mermaid

Author: taddes

.github/workflows/publish-docs.yaml

@@ -14,8 +14,8 @@ jobs:
   build:
     runs-on: ubuntu-latest
     env:
-      MDBOOK_ENV: 0.4.51 # Current mdbook version. See `https://crates.io/crates/mdbook`.
-      MERMAID_ENV: 0.15.0 # For crate `mdbook-mermaid`. See: `https://github.com/badboy/mdBook-mermaid/`.
+      MDBOOK_ENV: 0.5 # Current `mdbook` version. See `https://crates.io/crates/mdbook`.
+      MERMAID_ENV: 0.17.0 # For crate `mdbook-mermaid`. See: `https://github.com/badboy/mdBook-mermaid/`. Always check version compatibility with mdbook.
       DEST_DIR: /home/runner/.cargo/bin
     steps:
       - uses: actions/checkout@v4

README.md

@@ -3,7 +3,7 @@
 # Syncstorage-rs
 
 Mozilla Sync Storage built with [Rust](https://rust-lang.org).
-For full documentation, please navigate to the service docs *WIP* [here](https://mozilla-services.github.io/syncstorage-rs/) or in the documentation directory in [docs/src](docs/src/). Our documentation is generated using [mdBook](https://rust-lang.github.io/mdBook/index.html) and published to GitHub Pages.
+For full documentation, please navigate to the service docs [here](https://mozilla-services.github.io/syncstorage-rs/) or in the documentation directory in [docs/src](docs/src/). Our documentation is generated using [mdBook](https://rust-lang.github.io/mdBook/index.html) and published to GitHub Pages.
 
 [mpl-svg]: https://img.shields.io/badge/License-MPL%202.0-blue.svg
 [mpl]: https://opensource.org/licenses/MPL-2.0

docs/src/doc-notes.md

@@ -10,13 +10,21 @@ To build the documentation, install mdBook:
 cargo install mdbook
 ```
 
+For mermaid diagram support, you also have to install [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid).
+Then you need to run an install command to create two minified `js` files `["mermaid.min.js", "mermaid-init.js"]` to render mermaid diagrams:
+
+```bash
+cargo install mdbook-mermaid
+mdbook-mermaid install path/to/book
+```
+
 To have a live interactive instance when working with docs, you can use mdBook's `watch` feature.
 
 ```bash
 mdbook watch path/to/book
 ```
 
-Or use the Makefile utility `make doc-watch` from the rood.
+Or use the Makefile utility `make doc-watch` from the root of syncstorage-rs.
 
 To build documentation locally, run: