Content

This is the first draft of the comprehensive documentation for the Telescope-ALBA protocol. The scope and content will differ from the existing documentation currently available.

The goal of this document is to bridge theory and practical implementation by providing a seamless connection between code documentation (rust doc) and user-friendly explanations based on the paper.

This draft was generated using the cargo doc tool. Once published online, the output could serve as an intuitive interface for the library. (See this.)

This PR includes:

• A crate called cargodocs to operate modules' documentation.
• Directory /cargodocs to include following markdowns:
  • centralized.md
  • decentralized.md
  • intro.md
  • lottery.md
  • overview.md
  • wdecentralized.md
• katex-header.html, especially for LaTeX math symbols.

Pre-submit checklist

• Branch
  • Tests are provided (if possible)
  • Commit sequence broadly makes sense
  • Key commits have useful messages
• PR
  • No clippy warnings in the CI
  • Self-reviewed the diff
  • Useful pull request description
  • Reviewer requested
• Documentation
  • Update README file (if relevant)
  • Update documentation website (if relevant)

Comments

• The existing README has been updated but will be changed and improved.
• It is based on the branch raph@alba-bound, so it will only include the centralized case documentation.
• For now, the content of overview.md, intro.md, and centralized.md are taken from the hackmd document but will be revised.
• There will be cross-references between the code documentation and the markdown files.

Run the command to compile documentation locally:

RUSTDOCFLAGS="--html-in-header src/katex-header.html" cargo doc --no-deps --open

Issue(s)

Relates to #51