zecfoundation
/
frost
mirror of https://github.com/ZcashFoundation/frost.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Start FROST book (#250) 

* Starting a list of dependencies for audit

* Start FROST book and add skeleton

* Change authors

* Fix structure

* Link to README.md

* Add in all existing documentation from FROST repo

* Remove unused chapter_1 file
This commit is contained in:
Pili Guerra 2023-03-08 05:17:53 +01:00 committed by GitHub
parent c80e812fb9
commit 3265a3b848
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
20 changed files with 44 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
book/.gitignore vendored Normal file
View File

@ -0,0 +1 @@
book

6
book/book.toml Normal file
View File

@ -0,0 +1,6 @@
[book]
authors = ["Zcash Foundation <frost@zfnd.org>"]
language = "en"
multilingual = false
src = "src"
title = "The FROST Book"

1
book/src/README.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../README.md}}

20
book/src/SUMMARY.md Normal file
View File

@ -0,0 +1,20 @@
# Summary
[FROST](README.md)
- [User Documentation](user.md)
- [frost-core](user/frost-core.md)
- [frost-rerandomized](user/frost-rerandomized.md)
- [frost-ed25519](user/frost-ed25519.md)
- [DKG](user/frost-ed25519/dkg.md)
- [frost-ed448](user/frost-ed448.md)
- [DKG](user/frost-ed448/dkg.md)
- [frost-p256](user/frost-p256.md)
- [DKG](user/frost-p256/dkg.md)
- [frost-ristretto255](user/frost-ristretto255.md)
- [DKG](user/frost-ristretto255/dkg.md)
- [frost-secp256k1](user/frost-secp256k1.md)
- [DKG](user/frost-secp256k1/dkg.md)
- [Developer Documentation](dev.md)
- [FROST RFCs](dev/rfcs.md)
- [FROST messages](dev/rfcs/0001-messages.md )
- [List of Dependencies for Audit](dev/frost-dependencies-for-audit.md)

1
book/src/dev.md Normal file
View File

@ -0,0 +1 @@
# Developer Documentation

1
book/src/dev/rfcs.md Normal file
View File

@ -0,0 +1 @@
# FROST RFCs

1
book/src/dev/rfcs/0001-messages.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../../rfcs/0001-messages.md}}

1
book/src/user.md Normal file
View File

@ -0,0 +1 @@
# User Documentation

1
book/src/user/frost-core.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../frost-core/README.md}}

1
book/src/user/frost-ed25519.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../frost-ed25519/README.md}}

1
book/src/user/frost-ed25519/dkg.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../../frost-ed25519/dkg.md}}

1
book/src/user/frost-ed448.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../frost-ed448/README.md}}

1
book/src/user/frost-ed448/dkg.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../../frost-ed448/dkg.md}}

1
book/src/user/frost-p256.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../frost-p256/README.md}}

1
book/src/user/frost-p256/dkg.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../../frost-p256/dkg.md}}

1
book/src/user/frost-rerandomized.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../frost-rerandomized/README.md}}

1
book/src/user/frost-ristretto255.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../frost-ristretto255/README.md}}

1
book/src/user/frost-ristretto255/dkg.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../../frost-ristretto255/dkg.md}}

1
book/src/user/frost-secp256k1.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../frost-secp256k1/README.md}}

1
book/src/user/frost-secp256k1/dkg.md Normal file
View File

@ -0,0 +1 @@
{{#include ../../../../frost-secp256k1/dkg.md}}