Mirror of https://github.com/roostorg/osprey
github.com/roostorg/osprey
1# Contribute to these docs
2
3This documentation site is built using [mdBook](https://rust-lang.github.io/mdBook/) and deployed to GitHub Pages. Changes merged into the `main` branch will automatically be built and deployed.
4
5Documentation can be edited directly in the GitHub web UI for existing pages, or by selecting the **🖉 Suggest an edit** icon at the top of the docs site. To create a new page, be sure to update `SUMMARY.md` as well. Once you're done with your changes, open a pull request for review.
6
7To understand more about how mdBook works, learn about the [anatomy of a book](https://rust-lang.github.io/mdBook/guide/creating.html#anatomy-of-a-book).
8
9## Documentation guidelines
10
11For consistency and ease of contribution across projects, we follow the [ROOST community documentation guidelines](https://roostorg.github.io/community/documentation.html) whenever possible.
12
13## Developing locally
14
15To build the site locally, clone this repository and install `mdbook` (follow the [official installation instructions](https://rust-lang.github.io/mdBook/guide/installation.html)).
16
17Once installed, use the `mdbook` command-line tool from the root of this repo. For example, to automatically start watching, building, and serving the site:
18
19```shell
20mdbook serve
21```
22
23Then make your changes, preview them in your web browser (at [http://localhost:3000](http://localhost:3000) by default), commit, push, and open a pull request like any other git project.