Documentation - Folder organization for Centralized docs

docs/centralized_telescope/main.md

@@ -0,0 +1,3 @@
+# Telescope - Construction with Bounded DFS
+This is the main page of centralized documentation.
+It will include a generic explanation of the protocol.

docs/centralized_telescope/params.md

@@ -0,0 +1,3 @@
+# Parameters
+It will include the documentation of the implementation related to `params`.
+It also will cover the parameter derivation.

docs/centralized_telescope/proof.md

@@ -0,0 +1,2 @@
+# Proof
+It will include the documentation of the implementation related to `proof`.

docs/centralized_telescope/round.md

@@ -0,0 +1,2 @@
+# Round
+It will include the documentation of the implementation related to `round`.

src/centralized_telescope/mod.rs

@@ -1,6 +1,8 @@
 //! ALBA's bounded DFS scheme using Blake2b as hash function.
 //! (c.f. Section 3.2.2 of Alba paper)
 
+#![doc = include_str!("../../docs/centralized_telescope/main.md")]
+
 mod algorithm;
 
 pub mod init;

src/centralized_telescope/params.rs

@@ -1,5 +1,7 @@
 //! ALBA's Setup structure
 
+#![doc = include_str!("../../docs/centralized_telescope/params.md")]
+
 /// Setup input parameters
 #[derive(Debug, Clone, Copy)]
 pub struct Params {

src/centralized_telescope/proof.rs

@@ -1,5 +1,7 @@
 //! ALBA's Proof structure
 
+#![doc = include_str!("../../docs/centralized_telescope/proof.md")]
+
 use crate::utils::types::Element;
 
 /// Alba proof

src/centralized_telescope/round.rs

@@ -1,5 +1,7 @@
 //! ALBA's Round structure and associated functions
 
+#![doc = include_str!("../../docs/centralized_telescope/round.md")]
+
 use super::types::Hash;
 use crate::utils::sample;
 use crate::utils::types::Element;

src/docs.rs

@@ -4,3 +4,15 @@
 
 #[doc = include_str!("../docs/varmap.md")]
 pub mod variables {}
+
+#[doc = include_str!("../docs/centralized_telescope/main.md")]
+pub mod centralized {
+    #[doc = include_str!("../docs/centralized_telescope/params.md")]
+    pub mod params {}
+
+    #[doc = include_str!("../docs/centralized_telescope/proof.md")]
+    pub mod proof {}
+
+    #[doc = include_str!("../docs/centralized_telescope/round.md")]
+    pub mod round {}
+}