From db930f706a8ff6896f3058e371a7052b6e395b7c Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Fri, 29 Jan 2021 20:57:50 +0000 Subject: [PATCH 1/2] Add an issue template for improving the Halo 2 book --- .github/ISSUE_TEMPLATE/eli15.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/eli15.md diff --git a/.github/ISSUE_TEMPLATE/eli15.md b/.github/ISSUE_TEMPLATE/eli15.md new file mode 100644 index 0000000..d9fb8fe --- /dev/null +++ b/.github/ISSUE_TEMPLATE/eli15.md @@ -0,0 +1,15 @@ +--- +name: ELI15 improvement request +about: Let us know how the Halo 2 book could be improved! +title: 'ELI15: ' +labels: 'ELI15' +assignees: '' + +--- + +## Which section of the Halo 2 book were you reading? + +## What was unclear? + +## What would help to make it clearer to you? + From d84a4cbbfc4789c4c6ec3707f4708cf1412f1352 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Fri, 29 Jan 2021 20:59:39 +0000 Subject: [PATCH 2/2] book: Add a link from "Background Material" to the issue tracker This will hopefully encourage readers to submit feedback as they read the book, enabling us to catch things that could be explained better. --- book/src/background.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/book/src/background.md b/book/src/background.md index 72339d0..abc65a5 100644 --- a/book/src/background.md +++ b/book/src/background.md @@ -2,4 +2,6 @@ This section covers the background material required to understand the Halo 2 proving system. It is targeted at an ELI15 (Explain It Like I'm 15) level; if you think anything -could do with additional explanation, let us know! +could do with additional explanation, [let us know]! + +[let us know]: https://github.com/zcash/halo2/issues/new/choose