Skip to content

Commit

Permalink
Add mdBook stub (risc0#527)
Browse files Browse the repository at this point in the history
  • Loading branch information
tzerrell authored Apr 28, 2023
1 parent 756ae90 commit 48a01ec
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,13 @@ jobs:
- uses: ./.github/actions/rustup
- uses: ./.github/actions/sccache
- run: RISC0_SKIP_BUILD=1 cargo doc --no-deps --exclude=risc0-zkvm-methods --workspace
- name: Install mdbook
uses: risc0/cargo-install@2cfb0024938d23011106cbf127b393bc83fddba1
with:
crate: mdbook
version: "0.4"
- run: mdbook test
working-directory: docs/mdbook

check_template:
runs-on: [self-hosted, prod, cpu, "${{ matrix.os }}"]
Expand Down
1 change: 1 addition & 0 deletions docs/mdbook/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
book
6 changes: 6 additions & 0 deletions docs/mdbook/book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[book]
title = "Building Apps with Bonsai and the RISC Zero zkVM"
authors = []
language = "en"
multilingual = false
src = "src"
3 changes: 3 additions & 0 deletions docs/mdbook/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Summary

- [Introduction](./intro.md)
20 changes: 20 additions & 0 deletions docs/mdbook/src/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Introduction

Welcome to the RISC Zero mdBook! This is very much an early stage work in progress. If you have somehow found your way to this book looking for documentation, we strongly encourage you to check out our other documentation and resources, including:
* our [main GitHub repo], including [links to our crates on docs.rs],
* our [website],
* our [Bonsai developer docs] (also a work in progress),
* our [YouTube channel], and
* our [Discord server].

Here is an example of code that will be tested:
```rust
assert_eq!(2+2, 4);
```

[main GitHub repo]: https://github.com/risc0/risc0
[links to our crates on docs.rs]: https://github.com/risc0/risc0#rust-libraries
[website]: https://www.risczero.com/
[Bonsai developer docs]: https://dev.bonsai.xyz/
[YouTube channel]: https://www.youtube.com/@risczero
[Discord server]: https://discord.gg/risczero

0 comments on commit 48a01ec

Please sign in to comment.