This repository is an mdbook
instance for a Trailing Finality Layer
design for Zcash.
The mdbook
tool renders the contents into a pretty format from markdown
based source code
There are two github CI workflows:
merge-acceptance.yaml
: triggers onpull_request
to check thatmdbook build
succeeds and there aren't danglingmd
files (e.g. you remove an entry inSUMMARY.md
but forget to rm the file.)render-site.yaml
: triggers onpush
tomain
to render the site to https://electric-coin-company.github.io/tfl-book/- Warning: this workflow relies on full read/write access to the
gh-pages
branch. Don't mess with that branch unless you're very confident in the impacts.
- Warning: this workflow relies on full read/write access to the
cargo install mdbook
cargo install mdbook-graphviz
cargo install mdbook-linkcheck
graphviz
- on debian-like:sudo apt install graphviz
mdbook build