Stark prover documentation

.github/workflows/gh-pages.yml

@@ -0,0 +1,32 @@
+name: github pages
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  deploy:
+    runs-on: ubuntu-20.04
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.4.10'
+
+      - name: Install Katex
+        run: cargo install mdbook-katex
+
+      - run: mdbook build docs
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.ref == 'refs/heads/main' }}
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/book

Makefile

@@ -1,3 +1,5 @@
+.PHONY: test clippy docker-shell nix-shell benchmarks benchmark docs
+
 test:
 	cargo test
 
@@ -17,3 +19,6 @@ benchmarks:
 # BENCHMARK should be one of the [[bench]] names in Cargo.toml
 benchmark:
 	cargo criterion --bench ${BENCH}
+
+docs:
+	cd docs && mdbook serve --open

README.md

@@ -103,6 +103,14 @@ If you use ```Lambdaworks``` libraries in your research projects, please cite th
 
 ### Gadgets
 
+## Documentation
+
+To serve the documentation locally, first install both [mdbook](https://rust-lang.github.io/mdBook/guide/installation.html) and the [Katex preprocessor](https://github.com/lzanini/mdbook-katex#getting-started) to render LaTeX, then run
+
+```
+make docs
+```
+
 ## 📊 Benchmarks
 
 To run the benchmarks you will need `cargo-criterion`, to install do:

docs/.gitignore

@@ -0,0 +1 @@
+book

docs/book.toml

@@ -0,0 +1,8 @@
+[book]
+authors = ["Javier Chatruc"]
+language = "en"
+multilingual = false
+src = "src"
+title = "docs"
+
+[preprocessor.katex]

docs/src/SUMMARY.md

@@ -0,0 +1,8 @@
+# Lambdaworks Documentation
+
+- [Introduction](./introduction.md)
+
+- [Proving Systems]()
+    - [STARKs](./proving_systems/starks/starks.md)
+        - [Recap](./proving_systems/starks/recap.md)
+        - [Implementation](./proving_systems/starks/implementation.md)

docs/src/introduction.md

@@ -0,0 +1,3 @@
+# Introduction
+
+This site hosts the main documentation for Lambdaworks as a whole. It is still a work in progress.

docs/src/proving_systems/starks/starks.md

@@ -0,0 +1,6 @@
+# STARK Prover
+
+The goal of this document is to give a good a understanding of our stark prover code. To this end, in the first section we go through a recap of how the proving system works at a high level mathematically; then we dive into how that's actually implemented in our code.
+
+- [STARKs recap](./recap.md)
+- [Implementation](./implementation.md)