Add workflow to deploy the documentation

name: Deploy docs

on:

  push:

    branches:

      - main

    paths:

      - 'docs/**'

  workflow_dispatch:

permissions:

  contents: read

  pages: write

  id-token: write

concurrency:

  group: "pages"

  cancel-in-progress: false

jobs:

  build-docs:

    runs-on: ubuntu-latest

    steps:

      - name: Checkout

        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2

      - uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0

        with:

          path: |

            ~/.cargo/.crates.toml

            ~/.cargo/.crates2.toml

            ~/.cargo/bin/

            ~/.cargo/registry/index/

            ~/.cargo/registry/cache/

            ~/.cargo/git/db/

          key: ${{ runner.os }}-cargo-${{ hashFiles('**/Cargo.lock') }}

      - name: Install mdbook and extensions

        run: ./docs/install.sh

      - name: Setup Pages

        id: pages

        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0

      - name: Build docs

        run: mdbook build docs --dest-dir=book/docs/latest

      - name: Test docs

        run: mdbook test docs

      - name: Upload artifact

        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3.0.1

        with:

          path: ./book/docs

  deploy-docs:

    environment:

      name: pages

      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest

    needs: build-docs

    steps:

      - name: Deploy to GitHub Pages

        id: deployment

        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5