Merge pull request #1 from zcash/book-skeleton

Book skeleton

.github/workflows/ci.yml

@@ -39,6 +39,18 @@ jobs:
           command: build
           args: --all --benches
 
+  book:
+    name: Book tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup mdBook
+        uses: peaceiris/actions-mdbook@v1
+        with:
+          mdbook-version: '0.4.4'
+      - name: Test Pollard book
+        run: mdbook test book/
+
   clippy:
     name: Clippy (stable)
     timeout-minutes: 30

book/src/README.md

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

book/src/SUMMARY.md

@@ -1,3 +1,11 @@
-# Summary
+# The Pollard Book
 
-- [Chapter 1](./chapter_1.md)
+[Pollard](README.md)
+- [Concepts](concepts.md)
+  - [Preliminaries](concepts/preliminaries.md)
+- [User Documentation](user.md)
+  - [Creating keys and addresses](user/keys.md)
+  - [Creating notes](user/creating-notes.md)
+  - [Spending notes](user/spending-notes.md)
+  - [Integration into an existing chain](user/integration.md)
+- [Design](design.md)

book/src/chapter_1.md

@@ -1 +0,0 @@
-# Chapter 1

book/src/concepts.md

@@ -0,0 +1 @@
+# Concepts

book/src/concepts/preliminaries.md

@@ -0,0 +1 @@
+# Preliminaries

book/src/design.md

@@ -0,0 +1 @@
+# Design

book/src/user.md

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

book/src/user/creating-notes.md

@@ -0,0 +1 @@
+# Creating notes

book/src/user/integration.md

@@ -0,0 +1 @@
+# Integration into an existing chain

book/src/user/keys.md

@@ -0,0 +1 @@
+# Creating keys and addresses

book/src/user/spending-notes.md

@@ -0,0 +1 @@
+# Spending notes