Merge branch 'main' into service-client-api

Author: rex-schilasky

.github/workflows/generate-docs.yml

@@ -13,34 +13,16 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v3
 
-      - name: Set up Rust (nightly) with docs
-        uses: actions-rs/toolchain@v1
+      - name: Install mdBook
+        uses: taiki-e/install-action@v2
         with:
-          toolchain: nightly
-          override: true
-          components: rust-docs
+          tool: mdbook
 
-      - name: Cache Cargo registry
-        uses: actions/cache@v3
-        with:
-          path: |
-            ~/.cargo/registry
-            ~/.cargo/git
-          key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }}
-
-      - name: Cache target directory
-        uses: actions/cache@v3
-        with:
-          path: target
-          key: ${{ runner.os }}-cargo-target-${{ hashFiles('**/Cargo.lock') }}
-
-      # - name: Generate Rust API documentation (docs-only workspace)
-      #   run: |
-      #     export RUSTDOCFLAGS="--cfg docsrs"
-      #     cargo +nightly doc --no-deps --workspace --manifest-path .doc/Cargo.toml
+      - name: Build mdBook
+        run: mdbook build docs
 
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./target/doc
+          publish_dir: ./docs/book

README.md

@@ -1,6 +1,8 @@
 # rustecal
 
-Rust bindings for the high-performance [eCAL](https://github.com/eclipse-ecal/ecal) middleware, providing efficient pub/sub and service-based communication for interprocess and distributed systems.
+[![Docs](https://img.shields.io/badge/docs-mdbook-blue)](https://rex-schilasky.github.io/rustecal/)
+
+Safe and idiomatic Rust bindings for the [eCAL](https://github.com/eclipse-ecal/ecal) middleware — a high-performance IPC framework designed for distributed real-time systems.
 
 ---