fix: doc building actions

Signed-off-by: Simon Paitrault <[email protected]>

.github/workflows/test.yml

@@ -14,6 +14,21 @@ concurrency:
   cancel-in-progress: ${{ github.ref != 'refs/heads/main' }}
 
 jobs:
+  test-doc:
+    name: Test documentation
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout 
+      uses: actions/checkout@v4
+    - uses: ./.github/actions/install-rust
+      with:
+        toolchain: nightly
+        AWS_ACCESS_KEY_ID: ${{ secrets.ROBOT_AWS_ACCESS_KEY_ID}}
+        AWS_SECRET_ACCESS_KEY: ${{ secrets.ROBOT_AWS_SECRET_ACCESS_KEY}}
+
+    - name: Build Documentation
+      run: cargo +nightly doc --no-deps --all --all-features
+
   test_stable:
     runs-on: ubuntu-latest-16-core
     strategy:

crates/topos-tce-storage/README.md

@@ -34,7 +34,7 @@ the data while the `store` manages the data access and its behavior.
 Here's the list of the different stores and their responsibilities:
 
 - The [`EpochValidatorsStore`](struct@epoch::EpochValidatorsStore) is responsible for managing the list of validators for each `epoch`.
-- The [`FullNodeStore`](struct@fullnode::FullNodeStore) is responsible for managing all persistent data such as [`Certificate`] delivered and associated `streams`.
+- The [`FullNodeStore`](struct@fullnode::FullNodeStore) is responsible for managing all persistent data such as [`Certificate`](struct@topos_core::uci::Certificate) delivered and associated `streams`.
 - The [`IndexStore`](struct@index::IndexStore) is responsible for managing indexes and collect information about the broadcast and the network.
 - The [`ValidatorStore`](struct@validator::ValidatorStore) is responsible for managing the pending data that one validator needs to keep track, such as the certificates pool.
 
@@ -43,9 +43,9 @@ For more information about a `store`, see the related doc.
 Next, we've the list of the different tables and their responsibilities:
 
 - The [`EpochValidatorsTables`](struct@epoch::EpochValidatorsTables) is responsible for storing the list of validators for each `epoch`.
-- The [`ValidatorPerpetualTables`](struct@validator::ValidatorPerpetualTables) is responsible for storing the delivered [`Certificate`]s and the persistent data related to the Broadcast.
+- The [`ValidatorPerpetualTables`](struct@validator::ValidatorPerpetualTables) is responsible for storing the delivered [`Certificate`](struct@topos_core::uci::Certificate)s and the persistent data related to the Broadcast.
 - The [`ValidatorPendingTables`](struct@validator::ValidatorPendingTables) is responsible for storing the pending data, such as the certificates pool.
-- The [`IndexTables`](struct@index::IndexTables) is responsible for storing indexes about the delivery of [`Certificate`]s such as `target subnet stream`.
+- The [`IndexTables`](struct@index::IndexTables) is responsible for storing indexes about the delivery of [`Certificate`](struct@topos_core::uci::Certificate)s such as `target subnet stream`.
 
 ### Special Considerations
 

crates/topos-tce-storage/src/epoch/mod.rs

@@ -7,8 +7,8 @@ use arc_swap::ArcSwap;
 use crate::errors::StorageError;
 use crate::types::{EpochId, Validators};
 
-pub(crate) use self::tables::EpochValidatorsTables;
-pub(crate) use self::tables::ValidatorPerEpochTables;
+pub use self::tables::EpochValidatorsTables;
+pub use self::tables::ValidatorPerEpochTables;
 
 mod tables;
 

crates/topos-tce-storage/src/index/mod.rs

@@ -17,8 +17,8 @@ use crate::{
     types::{CertificateSequenceNumber, TargetSourceListColumn, TargetStreamsColumn},
 };
 
-#[allow(unused)]
-pub(crate) struct IndexStore {
+pub struct IndexStore {
+    #[allow(unused)]
     certificate_order: DBColumn<CertificateSequenceNumber, CertificateId>,
 }
 

crates/topos-tce-storage/src/lib.rs

@@ -32,7 +32,7 @@
 //! Here's the list of the different stores and their responsibilities:
 //!
 //! - The [`EpochValidatorsStore`](struct@epoch::EpochValidatorsStore) is responsible for managing the list of validators for each `epoch`.
-//! - The [`FullNodeStore`](struct@fullnode::FullNodeStore) is responsible for managing all persistent data such as [`Certificate`] delivered and associated `streams`.
+//! - The [`FullNodeStore`](struct@fullnode::FullNodeStore) is responsible for managing all persistent data such as [`Certificate`](struct@topos_core::uci::Certificate) delivered and associated `streams`.
 //! - The [`IndexStore`](struct@index::IndexStore) is responsible for managing indexes and collect information about the broadcast and the network.
 //! - The [`ValidatorStore`](struct@validator::ValidatorStore) is responsible for managing the pending data that one validator needs to keep track, such as the certificates pool.
 //!
@@ -41,9 +41,9 @@
 //! Next, we've the list of the different tables and their responsibilities:
 //!
 //! - The [`EpochValidatorsTables`](struct@epoch::EpochValidatorsTables) is responsible for storing the list of validators for each `epoch`.
-//! - The [`ValidatorPerpetualTables`](struct@validator::ValidatorPerpetualTables) is responsible for storing the delivered [`Certificate`]s and the persistent data related to the Broadcast.
+//! - The [`ValidatorPerpetualTables`](struct@validator::ValidatorPerpetualTables) is responsible for storing the delivered [`Certificate`](struct@topos_core::uci::Certificate)s and the persistent data related to the Broadcast.
 //! - The [`ValidatorPendingTables`](struct@validator::ValidatorPendingTables) is responsible for storing the pending data, such as the certificates pool.
-//! - The [`IndexTables`](struct@index::IndexTables) is responsible for storing indexes about the delivery of [`Certificate`]s such as `target subnet stream`.
+//! - The [`IndexTables`](struct@index::IndexTables) is responsible for storing indexes about the delivery of [`Certificate`](struct@topos_core::uci::Certificate)s such as `target subnet stream`.
 //!
 //! ## Special Considerations
 //!