Add skeleton of eventual zebra book (#653)
* Add skeleton of eventual zebra book * reorg sections * restore file and reorg book a little * try setting up a firebase deployment * allow firebase ci to work on test * download mdbook * fix book path * use newer version of mdbook * remove event hook for book branch pre merge * Apply suggestions from code review Co-authored-by: Henry de Valence <hdevalence@hdevalence.ca> Co-authored-by: Henry de Valence <hdevalence@hdevalence.ca>
This commit is contained in:
parent
fe2a468417
commit
e06357f795
|
@ -11,16 +11,39 @@ jobs:
|
|||
name: Build and Deploy Docs
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout the source code
|
||||
uses: actions/checkout@master
|
||||
|
||||
- uses: actions/checkout@master
|
||||
- name: Install latest nightly
|
||||
uses: actions-rs/toolchain@v1
|
||||
with:
|
||||
toolchain: nightly
|
||||
override: true
|
||||
|
||||
- name: Install mdbook
|
||||
run: |
|
||||
cd book
|
||||
curl -L https://github.com/rust-lang/mdBook/releases/download/v0.4.1/mdbook-v0.4.1-x86_64-unknown-linux-gnu.tar.gz | tar xz
|
||||
# Add the book directory to the $PATH
|
||||
echo "::add-path::$GITHUB_WORKSPACE/book"
|
||||
|
||||
- name: Build Zebra book
|
||||
run: |
|
||||
mdbook build book/
|
||||
|
||||
- name: Deploy Zebra book to firebase
|
||||
uses: w9jds/firebase-action@v1.5.0
|
||||
with:
|
||||
args: deploy
|
||||
env:
|
||||
FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}
|
||||
PROJECT_PATH: book/
|
||||
PROJECT_ID: zebra-book
|
||||
|
||||
- name: Build external docs
|
||||
run: |
|
||||
cargo doc --no-deps
|
||||
|
||||
- name: Deploy external docs to firebase
|
||||
uses: w9jds/firebase-action@v1.5.0
|
||||
with:
|
||||
|
@ -28,9 +51,11 @@ jobs:
|
|||
env:
|
||||
FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}
|
||||
PROJECT_ID: zealous-zebra
|
||||
|
||||
- name: Build internal docs
|
||||
run: |
|
||||
cargo doc --no-deps --document-private-items
|
||||
|
||||
- name: Deploy external docs to firebase
|
||||
uses: w9jds/firebase-action@v1.5.0
|
||||
with:
|
||||
|
|
|
@ -0,0 +1 @@
|
|||
book
|
|
@ -0,0 +1,6 @@
|
|||
[book]
|
||||
authors = ["Zcash Foundation <zebra@zfnd.org>"]
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "src"
|
||||
title = "The Zebra Book"
|
|
@ -0,0 +1,16 @@
|
|||
{
|
||||
"hosting": {
|
||||
"public": "book",
|
||||
"ignore": [
|
||||
"firebase.json",
|
||||
"**/.*",
|
||||
"**/node_modules/**"
|
||||
],
|
||||
"rewrites": [
|
||||
{
|
||||
"source": "**",
|
||||
"destination": "/index.html"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
|
@ -0,0 +1,18 @@
|
|||
# Contributing
|
||||
|
||||
* [Bug Reports](#bug-reports)
|
||||
* [Running and Debugging](#running-and-debugging)
|
||||
* [Pull Requests](#pull-requests)
|
||||
* [Writing Documentation](#writing-documentation)
|
||||
|
||||
## Bug Reports
|
||||
[bug-reports]: #bug-reports
|
||||
|
||||
## Running and Debugging
|
||||
[running-and-debugging]: #running-and-debugging
|
||||
|
||||
## Pull Requests
|
||||
[pull-requests]: #pull-requests
|
||||
|
||||
## Writing Documentation
|
||||
[writing-documentation]: #writing-documentation
|
|
@ -0,0 +1,15 @@
|
|||
# Summary
|
||||
|
||||
[Introduction](./introduction.md)
|
||||
[Contribution Guide](./CONTRIBUTING.md)
|
||||
[Design Overview](./overview.md)
|
||||
|
||||
# Diagrams
|
||||
|
||||
- [Diagrams](./diagrams.md)
|
||||
- [Zebra Network](./diagrams/zebra-network.md)
|
||||
|
||||
# Designs
|
||||
|
||||
- [Design Documents](design_docs.md)
|
||||
- [Pipelinable Block Lookup](./designs/0001-pipelinable-block-lookup.md)
|
|
@ -0,0 +1 @@
|
|||
# Design Documents
|
|
@ -0,0 +1 @@
|
|||
# Diagrams
|
|
@ -1,3 +1,4 @@
|
|||
```
|
||||
┌───────────┐ ┌───────────┐ ┌───────────┐ ┌───────────┐
|
||||
│PeerServer │ │PeerServer │ │PeerServer │ │PeerServer │
|
||||
│ ┌───────┐ │ │ ┌───────┐ │ │ ┌───────┐ │ │ ┌───────┐ │
|
||||
|
@ -74,4 +75,5 @@
|
|||
│ when internal │
|
||||
│ services are │
|
||||
│ overloaded │
|
||||
└───────────────┘
|
||||
└───────────────┘
|
||||
```
|
|
@ -0,0 +1,11 @@
|
|||
# The Zebra Book
|
||||
|
||||
Introduce the zebra project, explain what its for, high level concepts, how it differs from zcash, why it's being written.
|
||||
|
||||
# Dev Guide
|
||||
|
||||
Link to various chapters about how to contribute or work with the project, how to manipulate the log levels, how to set up the project, and the various dev practices we follow.
|
||||
|
||||
# Design
|
||||
|
||||
Introduce the overview and design documents. document how to propose a new design.
|
|
@ -1,5 +1,5 @@
|
|||
Zebra Design Document
|
||||
=====================
|
||||
---------------------
|
||||
|
||||
This document sketches the future design for Zebra.
|
||||
|
Loading…
Reference in New Issue