f5e4b6b9b6
* Remove duplicate link to Hyper integration The `Adding a Server` page contains a duplicate link to `Hyper`. The first of them can cause the reader to accidentally skip the `Rocket` and `Iron` integration pages because their pages are before the one for `Hyper` in the reading order. Remove the first link so that the list of official server integrations matches the page order. * Match the list of integrations to the page order In the book, the pages for the official integrations appear in the order: `Warp`, `Rocket`, `Iron`, `Hyper`, but on the `Official Server Integrations` page they are listed with `Hyper` first. This can cause readers to accidentally skip the other three integrations if they click on the link for `Hyper` first. Move `Hyper` to the bottom of the list to match the reading order of the book. * Remove unnecessary blank line |
||
|---|---|---|
| .. | ||
| content | ||
| tests | ||
| .gitignore | ||
| book.toml | ||
| ci-build.sh | ||
| 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.