Auto merge of #4968 - str4d:design-book, r=str4d

Set up an mdbook in which we can document zcashd's architecture design

I've explained various parts of zcashd's node architecture enough times
now that it really should be written down!

.github/workflows/book.yml

@@ -0,0 +1,32 @@
+name: zcashd book
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.4.5'
+
+      - name: Install mdbook-katex
+        uses: actions-rs/cargo@v1
+        with:
+          command: install
+          args: mdbook-katex
+
+      - name: Build zcashd book
+        run: mdbook build book/
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./book/book

README.md

@@ -9,7 +9,7 @@ What is Zcash?
 Based on Bitcoin's code, Zcash intends to offer a far higher standard of privacy
 through a sophisticated zero-knowledge proving scheme that preserves
 confidentiality of transaction metadata. More technical details are available
-in our [Protocol Specification](https://github.com/zcash/zips/raw/master/protocol/protocol.pdf).
+in our [Protocol Specification](https://zips.z.cash/protocol/protocol.pdf).
 
 This software is the Zcash client. It downloads and stores the entire history
 of Zcash transactions; depending on the speed of your computer and network

doc/book/.gitignore

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

doc/book/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["Jack Grigg"]
+language = "en"
+multilingual = false
+src = "src"
+title = "The zcashd Book"

doc/book/src/README.md

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

doc/book/src/SUMMARY.md

@@ -0,0 +1,6 @@
+# The zcashd Book
+
+[zcashd](README.md)
+- [Design](design.md)
+  - [Chain state](design/chain-state.md)
+  - ["Coins" view](design/coins-view.md)

doc/book/src/design.md

@@ -0,0 +1,9 @@
+# Design
+
+Zcash was originally a fork of Bitcoin 0.11.2, and as such the `zcashd` node architecture
+is very similar to `bitcoind`. There are however several differences, most notably the
+addition of shielded pools to the consensus logic and full node state.
+
+In this section of the book, we describe the overall architecture that we inherit from
+`bitcoind`, the changes we have made to the inherited components, and the new components
+we have introduced.

doc/book/src/design/chain-state.md

@@ -0,0 +1,3 @@
+# Chain state
+
+TBD

doc/book/src/design/coins-view.md

@@ -0,0 +1,3 @@
+# "Coins" view
+
+TBD

doc/book/src/doc/imgs/logo.png

@@ -0,0 +1 @@
+../../../../imgs/logo.png

doc/book/src/doc/imgs/zcashd_screen.gif

@@ -0,0 +1 @@
+../../../../imgs/zcashd_screen.gif