docs: add book skeleton (#44)

* docs: add book skeleton

* ci: add book test workflow
This commit is contained in:
Bjerg
2022-10-11 18:52:28 +02:00
committed by GitHub
parent a8c1eaf140
commit edc75881c1
4 changed files with 46 additions and 0 deletions

29
.github/workflows/book.yml vendored Normal file
View File

@ -0,0 +1,29 @@
name: book
on:
push:
branches: [main]
paths:
- 'book/**'
- 'book.toml'
pull_request:
branches: [main]
paths:
- 'book/**'
- 'book.toml'
jobs:
test:
runs-on: ubuntu-latest
name: test
steps:
- uses: actions/checkout@v3
- name: Install mdbook
run: |
mkdir mdbook
curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.14/mdbook-v0.4.14-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=./mdbook
echo `pwd`/mdbook >> $GITHUB_PATH
- name: Run tests
run: mdbook test

9
book.toml Normal file
View File

@ -0,0 +1,9 @@
[book]
authors = ["reth Core Contributors"]
language = "en"
multilingual = false
src = "book"
title = "reth Book"
[build]
build-dir = "target/book"

5
book/README.md Normal file
View File

@ -0,0 +1,5 @@
# reth Book
*Documentation for reth users.*
reth is an Ethereum execution client.

3
book/SUMMARY.md Normal file
View File

@ -0,0 +1,3 @@
# Summary
- [Introduction](./README.md)