expand docs (#371)

* expand docs

* Apply suggestions from code review

Co-authored-by: Deirdre Connolly <[email protected]>

* address comments, reflow some paragraphs

* tutorial mostly done

also cleaned up README example for extracting snippets; changed tests for consitency

* docs: add DKG; organize sections; remove stale docs

* run gencode

* Apply suggestions from code review

Co-authored-by: Pili Guerra <[email protected]>

---------

Co-authored-by: Deirdre Connolly <[email protected]>
Co-authored-by: Pili Guerra <[email protected]>

.github/workflows/docs.yml

@@ -10,7 +10,7 @@ concurrency:
 on:
   workflow_dispatch:
   pull_request:
-    branches:    
+    branches:
       - main
     paths:
       # doc source files
@@ -20,9 +20,9 @@ on:
       # workflow definitions
       - '.github/workflows/docs.yml'
   push:
-    branches:    
+    branches:
       - main
-      
+
 env:
   RUST_LOG: info
   RUST_BACKTRACE: full
@@ -62,14 +62,15 @@ jobs:
           mdbook-version: '0.4.18'
 
       # TODO: actions-mdbook does not yet have an option to install mdbook-mermaid https://github.com/peaceiris/actions-mdbook/issues/426
-      - name: Install mdbook
+      - name: Install plugins
         run: |
           cargo install mdbook-mermaid
-          
+          cargo install mdbook-admonish
+
       - name: Build FROST book
         run: |
           mdbook build book/
-          
+
       - name: Deploy FROST book to Firebase preview channel
         uses: FirebaseExtended/action-hosting-deploy@v0
         if: ${{ github.event_name == 'pull_request' && github.actor != 'dependabot[bot]' }}

README.md

@@ -1,4 +1,4 @@
-# FROST (Flexible Round-Optimised Schnorr Threshold signatures)
+# ZF FROST (Flexible Round-Optimised Schnorr Threshold signatures)
 
 Rust implementations of ['Two-Round Threshold Schnorr Signatures with FROST'](https://datatracker.ietf.org/doc/draft-irtf-cfrg-frost/).
 
@@ -17,6 +17,10 @@ to compute a signature, and implements signing efficiency improvements described
 [Schnorr21](https://eprint.iacr.org/2021/1375.pdf). Single-round signing with FROST is not
 implemented here.
 
+## Getting Started
+
+Refer to the [ZF FROST book](https://frost.zfnd.org/).
+
 ## Status ⚠
 
 The FROST specification is not yet finalized, and this codebase has not yet been audited or

book/book.toml

@@ -3,4 +3,15 @@ authors = ["Zcash Foundation <[email protected]>"]
 language = "en"
 multilingual = false
 src = "src"
-title = "The FROST Book"
+title = "The ZF FROST Book"
+
+[preprocessor]
+
+[preprocessor.admonish]
+command = "mdbook-admonish"
+assets_version = "2.0.1" # do not edit: managed by `mdbook-admonish install`
+
+[output]
+
+[output.html]
+additional-css = ["./mdbook-admonish.css"]