Skip to content

Commit

Permalink
Documentation - Folder organization for Centralized docs (#89)
Browse files Browse the repository at this point in the history
## Content

This PR includes a new folder structure for centralized documentation.
Some example markdown files are created and they are linked to the
related source files.
The content will be filled out after the team approves the doc structure
and pr #66 and #73 are merged.

## Pre-submit checklist

- Branch
    - [x] Commit sequence broadly makes sense
    - [x] Key commits have useful messages
- PR
    - [x] No clippy warnings in the CI
    - [x] Self-reviewed the diff
    - [x] Useful pull request description
    - [x] Reviewer requested
- Documentation
    - [x] Update documentation website (if relevant)

## Issue(s)
Closes #88
  • Loading branch information
curiecrypt authored Dec 9, 2024
1 parent 254d56b commit d0d3372
Show file tree
Hide file tree
Showing 9 changed files with 30 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/centralized_telescope/main.md
Original file line number Diff line number Diff line change
@@ -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.
3 changes: 3 additions & 0 deletions docs/centralized_telescope/params.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Parameters
It will include the documentation of the implementation related to `params`.
It also will cover the parameter derivation.
2 changes: 2 additions & 0 deletions docs/centralized_telescope/proof.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Proof
It will include the documentation of the implementation related to `proof`.
2 changes: 2 additions & 0 deletions docs/centralized_telescope/round.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# Round
It will include the documentation of the implementation related to `round`.
2 changes: 2 additions & 0 deletions src/centralized_telescope/mod.rs
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
2 changes: 2 additions & 0 deletions src/centralized_telescope/params.rs
Original file line number Diff line number Diff line change
@@ -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 {
Expand Down
2 changes: 2 additions & 0 deletions src/centralized_telescope/proof.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
//! ALBA's Proof structure
#![doc = include_str!("../../docs/centralized_telescope/proof.md")]

use crate::utils::types::Element;

/// Alba proof
Expand Down
2 changes: 2 additions & 0 deletions src/centralized_telescope/round.rs
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
12 changes: 12 additions & 0 deletions src/docs.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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 {}
}

0 comments on commit d0d3372

Please sign in to comment.