From 8e6d2a70238c4078f0e801540f084346dfaf4a66 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Tue, 27 Oct 2020 21:23:20 +0000 Subject: [PATCH 1/2] Add initial book skeleton --- book/src/README.md | 1 + book/src/SUMMARY.md | 12 ++++++++++-- book/src/chapter_1.md | 1 - book/src/concepts.md | 1 + book/src/concepts/preliminaries.md | 1 + book/src/design.md | 1 + book/src/user.md | 1 + book/src/user/creating-notes.md | 1 + book/src/user/integration.md | 1 + book/src/user/keys.md | 1 + book/src/user/spending-notes.md | 1 + 11 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 book/src/README.md delete mode 100644 book/src/chapter_1.md create mode 100644 book/src/concepts.md create mode 100644 book/src/concepts/preliminaries.md create mode 100644 book/src/design.md create mode 100644 book/src/user.md create mode 100644 book/src/user/creating-notes.md create mode 100644 book/src/user/integration.md create mode 100644 book/src/user/keys.md create mode 100644 book/src/user/spending-notes.md diff --git a/book/src/README.md b/book/src/README.md new file mode 100644 index 00000000..676d71c1 --- /dev/null +++ b/book/src/README.md @@ -0,0 +1 @@ +{{#include ../../README.md}} diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 7390c828..59ff60a9 100644 --- a/book/src/SUMMARY.md +++ b/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) diff --git a/book/src/chapter_1.md b/book/src/chapter_1.md deleted file mode 100644 index b743fda3..00000000 --- a/book/src/chapter_1.md +++ /dev/null @@ -1 +0,0 @@ -# Chapter 1 diff --git a/book/src/concepts.md b/book/src/concepts.md new file mode 100644 index 00000000..74d42e13 --- /dev/null +++ b/book/src/concepts.md @@ -0,0 +1 @@ +# Concepts diff --git a/book/src/concepts/preliminaries.md b/book/src/concepts/preliminaries.md new file mode 100644 index 00000000..2274ec5d --- /dev/null +++ b/book/src/concepts/preliminaries.md @@ -0,0 +1 @@ +# Preliminaries diff --git a/book/src/design.md b/book/src/design.md new file mode 100644 index 00000000..3d14cb7c --- /dev/null +++ b/book/src/design.md @@ -0,0 +1 @@ +# Design diff --git a/book/src/user.md b/book/src/user.md new file mode 100644 index 00000000..3a51d9a2 --- /dev/null +++ b/book/src/user.md @@ -0,0 +1 @@ +# User Documentation diff --git a/book/src/user/creating-notes.md b/book/src/user/creating-notes.md new file mode 100644 index 00000000..c366e3c8 --- /dev/null +++ b/book/src/user/creating-notes.md @@ -0,0 +1 @@ +# Creating notes diff --git a/book/src/user/integration.md b/book/src/user/integration.md new file mode 100644 index 00000000..f071ff15 --- /dev/null +++ b/book/src/user/integration.md @@ -0,0 +1 @@ +# Integration into an existing chain diff --git a/book/src/user/keys.md b/book/src/user/keys.md new file mode 100644 index 00000000..9c71fbbf --- /dev/null +++ b/book/src/user/keys.md @@ -0,0 +1 @@ +# Creating keys and addresses diff --git a/book/src/user/spending-notes.md b/book/src/user/spending-notes.md new file mode 100644 index 00000000..b24ee7b7 --- /dev/null +++ b/book/src/user/spending-notes.md @@ -0,0 +1 @@ +# Spending notes From 0bf9703452de97770cc82e55e9d327b52a4fa23c Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Tue, 27 Oct 2020 21:23:35 +0000 Subject: [PATCH 2/2] CI: Run book tests --- .github/workflows/ci.yml | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 395f7f6c..69156309 100644 --- a/.github/workflows/ci.yml +++ b/.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