chore: improve doc for topos-tce-storage (#354)

Signed-off-by: Simon Paitrault <simon.paitrault@gmail.com>

.github/workflows/coverage.yml

@@ -16,7 +16,7 @@ jobs:
     runs-on: ubuntu-latest-16-core
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: ./.github/actions/install-rust
         with:

.github/workflows/doc.yml

@@ -0,0 +1,45 @@
+name: Build and host documentation on GH pages
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  build:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout 
+      uses: actions/checkout@v4
+    - name: Install nightly toolchain
+      run: rustup toolchain install nightly 
+    - name: Build Documentation
+      run: cargo +nightly doc --no-deps --workspace -F full
+      env:
+        RUSTDOCFLAGS: "--cfg docsrs"
+        RUSTFLAGS: "--cfg docsrs"
+    - name: Add index file
+      run: |
+        mkdir host-docs
+        echo "<meta http-equiv=\"refresh\" content=\"0; url=topos\">" > target/doc/index.html
+        cp -r target/doc/* ./host-docs
+    - name: Upload documentation
+      uses: actions/upload-pages-artifact@v2.0.0
+      with:
+        path: "host-docs/"
+
+  deploy:
+    name: Deploy documentation
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v2

.github/workflows/docker_build_push.yml

@@ -49,7 +49,7 @@ jobs:
           docker tag ghcr.io/${{ github.repository}}:${{ env.docker_tag }} ${{ env.EXPECTED_IMAGE_NAME }}
 
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Running TCE cluster
         run: |

.github/workflows/docker_utils.yml

@@ -36,7 +36,7 @@ jobs:
       tags: ${{ steps.meta.outputs.tags }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v2

.github/workflows/pr-checking.yml

@@ -20,7 +20,7 @@ jobs:
     name: Validate PR commits
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - uses: wagoid/commitlint-github-action@v5

.github/workflows/quality.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: ./.github/actions/install-rust
         with:
@@ -33,7 +33,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: ./.github/actions/install-rust
         with:
@@ -54,7 +54,7 @@ jobs:
       RUST_BACKTRACE: 1
     steps:
       - name: Checkout topos repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Install Rust
         uses: ./.github/actions/install-rust
@@ -67,7 +67,7 @@ jobs:
         uses: arduino/setup-protoc@v1
 
       - name: Checkout topos-smart-contracts repo
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           repository: topos-protocol/topos-smart-contracts
           ref: ${{ env.CONTRACTS_REF }}
@@ -99,7 +99,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: ./.github/actions/install-rust
         with:
@@ -117,7 +117,7 @@ jobs:
     runs-on: ubuntu-latest-16-core
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - uses: ./.github/actions/install-rust
         with:

.github/workflows/release.yml

@@ -19,7 +19,7 @@ jobs:
       matrix:
         target: [ x86_64-unknown-linux-gnu ]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/install-rust
         with:
           target: ${{ matrix.target }}

.github/workflows/test.yml

@@ -20,7 +20,7 @@ jobs:
       fail-fast: false
     name: stable - Test
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/install-rust
         with:
           AWS_ACCESS_KEY_ID: ${{ secrets.ROBOT_AWS_ACCESS_KEY_ID}}
@@ -36,7 +36,7 @@ jobs:
       fail-fast: false
     name: nightly - Test
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/install-rust
         with:
           toolchain: nightly
@@ -55,7 +55,7 @@ jobs:
       matrix:
         value: ["first", "second", "third"]
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: ./.github/actions/install-rust
         with:
           AWS_ACCESS_KEY_ID: ${{ secrets.ROBOT_AWS_ACCESS_KEY_ID}}