yume/juniper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
juniper/docs/book
History
Jonas Meurer 845331033e
Documented Alternative Error Handling (#634) 
* Added alternative error handling

* Fixed book tests and some sentences

* Apply suggestions from code review

Co-Authored-By: Christian Legnitto <LegNeato@users.noreply.github.com>

* Fixed book examples

Co-authored-by: Christian Legnitto <LegNeato@users.noreply.github.com>
2020-04-28 06:41:19 -10:00
..
content Documented Alternative Error Handling (#634) 2020-04-28 06:41:19 -10:00
tests Initial implementation of Subscription Docs (#609) 2020-04-16 20:16:00 -10:00
.gitignore (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
book.toml (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
ci-build.sh Fix failure when no book content has changed 2019-05-03 00:39:33 -07:00
README.md (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00

README.md

Juniper Book

Book containing the Juniper documentation.

Contributing

Requirements

The book is built with mdBook.

You can install it with:

cargo install mdbook

Starting a local test server

To launch a local test server that continually re-builds the book and autoreloads the page, run:

mdbook serve

Building the book

You can build the book to rendered HTML with this command:

mdbook build

The output will be in the ./_rendered directory.

Running the tests

To run the tests validating all code examples in the book, run:

cd ./tests
cargo test

Test setup

All Rust code examples in the book are compiled on the CI.

This is done using the skeptic library.