ci: merge doc wf into build.yml

Author: Manuthor

.github/workflows/main_base.yml

@@ -13,19 +13,25 @@ on:
       platforms:
         required: true
         type: string
+  push:
+  pull_request:
+  workflow_dispatch:
 
 jobs:
   cargo-clippy:
+    if: github.event_name == 'workflow_call'
     uses: Cosmian/reusable_workflows/.github/workflows/clippy.yml@develop
     with:
       toolchain: ${{ inputs.toolchain }}
 
   cargo-deny:
+    if: github.event_name == 'workflow_call'
     uses: Cosmian/reusable_workflows/.github/workflows/cargo-audit.yml@develop
     with:
       toolchain: ${{ inputs.toolchain }}
 
   cargo-machete:
+    if: github.event_name == 'workflow_call'
     uses: Cosmian/reusable_workflows/.github/workflows/cargo-machete.yml@develop
     with:
       toolchain: ${{ inputs.toolchain }}
@@ -37,20 +43,23 @@ jobs:
   #     toolchain: ${{ inputs.toolchain }}
 
   build-tests:
+    if: github.event_name == 'workflow_call'
     uses: Cosmian/reusable_workflows/.github/workflows/build_all.yml@develop
     secrets: inherit
     with:
       toolchain: ${{ inputs.toolchain }}
       debug_or_release: ${{ inputs.debug_or_release }}
 
   cargo-publish:
+    if: github.event_name == 'workflow_call'
     uses: Cosmian/reusable_workflows/.github/workflows/cargo-publish-workspace.yml@develop
     with:
       toolchain: ${{ inputs.toolchain }}
     secrets:
       token: ${{ secrets.CRATES_IO }}
 
   docker-image:
+    if: github.event_name == 'workflow_call'
     name: Build docker image
     uses: Cosmian/reusable_workflows/.github/workflows/build_docker_image.yml@develop
     with:
@@ -62,6 +71,7 @@ jobs:
   ### Releases
   ##############################################################################
   push-artifacts:
+    if: github.event_name == 'workflow_call'
     needs:
       - cargo-clippy
       - cargo-deny
@@ -98,3 +108,17 @@ jobs:
           repo: Cosmian/public_documentation
           ref: main
           token: ${{ secrets.PAT_TOKEN }}
+
+  build-documentation:
+    name: Build documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install mdBook toolchain
+        run: curl -fsSL https://raw.githubusercontent.com/Cosmian/doc-theme/main/scripts/setup-mdbook.sh | sh
+
+      - name: Build documentation
+        run: |
+          export PATH="$HOME/.cargo/bin:$PATH"
+          cd documentation && mdbook build

documentation/book.toml

@@ -22,9 +22,31 @@ enable = true
 enable = true
 level = 1
 
+[output.linkcheck]
+follow-web-links = true
+warning-policy = "error"
+exclude = [
+  'localhost',
+  '@',
+  # Cross-book references — other sections only exist in the combined book
+  'key_management_system',
+  'kms_clients',
+  'eviden_vm',
+  'eviden_ai',
+  'eviden_enclave',
+  'crates\.io',
+  'cosmian\.com',
+  'chrome://',
+  'csrc\.nist\.gov',
+  'nvlpubs\.nist\.gov',
+]
+
 [preprocessor.admonish]
 command = "mdbook-admonish"
 assets_version = "3.1.0"
 
+[preprocessor.tabs]
+command = "python3 ../../theme/scripts/mdbook_tabs.py"
+
 [preprocessor.mermaid]
 command = "mdbook-mermaid"

documentation/docs/SUMMARY.md

@@ -0,0 +1,13 @@
+# Summary
+
+- [Getting started](index.md)
+- [Quick start]()
+  - [Installation](quick_start.md)
+  - [Usage](usage.md)
+- [Configuration]()
+  - [Configuration file](configuration.md)
+- [User authentication](authentication.md)
+- [User authorization](authorization.md)
+- [Usage]()
+  - [Encrypt and index a dataset](database.md)
+  - [Use the CLI](quick_start_client.md)

documentation/docs/authentication.md

@@ -77,7 +77,7 @@ sequenceDiagram
 
 ## Eviden CLI Configuration
 
-[Eviden CLI](../kms_clients/index.md) is helpful to authenticate with the Findex server using OpenID Connect.
+[Eviden CLI](../key_management_system/kms_clients/index.md) is helpful to authenticate with the Findex server using OpenID Connect.
 The CLI has to be installed locally and configured with the Findex server URL and OAuth2 configuration.
 
 !!! info

documentation/docs/database.md

@@ -80,7 +80,7 @@ The server presents the following endpoints:
 | `/indexes/{index_id}/batch_read`    | retrieve encrypted indexes |
 | `/indexes/{index_id}/guarded_write` | insert encrypted indexes   |
 
-And consequently, the Findex [REST client implementation] (crate/client/src/rest_client.rs)
+And consequently, the Findex REST client implementation (crate/client/src/rest_client.rs)
 implements the client side of the communication with the server.
 
 Furthermore, the encryption is done by the client before sending the data to the server.

documentation/docs/index.md

@@ -22,7 +22,7 @@ Findex has been published as a scientific paper in the IACR ePrint archive: <htt
 
 Findex server is a high-performance, open-source server application written in Rust that implements the Findex protocol and offers a REST API to store encrypted indexes and perform search queries on them.  Findex Server mainly is an authentication layer and therefore all data-critical manipulations are performed by a database.
 
-The server is designed to be used in conjunction with the [Eviden CLI](../kms_clients/index.md), a command-line interface that allows users to interact with the server.
+The server is designed to be used in conjunction with the [Eviden CLI](../key_management_system/kms_clients/index.md), a command-line interface that allows users to interact with the server.
 
 ### Threat Model
 
@@ -79,7 +79,7 @@ architecture-beta
 
 By leveraging client-side encryption, Findex ensures that sensitive data remains secure and private, even when stored and processed on an untrusted server.
 
-The Findex server, written in Rust and using the Actix-web framework, is a REST-API server used to store encrypted indexes and perform search queries on them. It is designed to be used in conjunction with the [Eviden CLI](../kms_clients/index.md), which is a command-line interface that allows users to interact with the server.
+The Findex server, written in Rust and using the Actix-web framework, is a REST-API server used to store encrypted indexes and perform search queries on them. It is designed to be used in conjunction with the [Eviden CLI](../key_management_system/kms_clients/index.md), which is a command-line interface that allows users to interact with the server.
 
 ### Features
 

documentation/docs/quick_start_client.md

@@ -1,16 +1,16 @@
 # Using the Eviden CLI
 
-The [Eviden CLI](../kms_clients/index.md) allows to interact both with the
+The [Eviden CLI](../key_management_system/kms_clients/index.md) allows to interact both with the
 **KMS server** and **Findex server**. Then you can realize the following operations
 illustrated in [encrypted database](./database.md#how-to-securely-index-new-data).
 
 As prerequisites, you need to have:
 
 - the Eviden CLI installed on your machine. You can download the latest version of the Cosmian CLI from the [Cosmian package website](https://package.cosmian.com/cli).
-- a running KMS server: follow the instructions in the [quick start guide](../key_management_system/installation/installation_getting_started.md/).
+- a running KMS server: follow the instructions in the [quick start guide](../key_management_system/installation/installation_getting_started.md).
 - a running Findex server: follow the instructions in the [quick start guide](./quick_start.md).
 
-Depending on the authentication of these 2 servers, the configuration will have to be adapted. Refer to the [configuration documentation](../kms_clients/configuration.md) for more information.
+Depending on the authentication of these 2 servers, the configuration will have to be adapted. Refer to the [configuration documentation](../key_management_system/kms_clients/configuration.md) for more information.
 
 As a summary, below are described the steps:
 
@@ -96,4 +96,4 @@ Decrypted record: SouthboroughMAUnited States9686
 
 ## Configuration
 
-Please refer to the [configuration documentation](../kms_clients/configuration.md) for more information on how to configure the Eviden CLI.
+Please refer to the [configuration documentation](../key_management_system/kms_clients/configuration.md) for more information on how to configure the Eviden CLI.