Mirror of https://github.com/roostorg/osprey
github.com/roostorg/osprey
docs: mention documentation guidelines (#133)
authored by
Cassidy James Blaede
and committed by
GitHub
03924484
c639a581
+4
-1
+4
-1
docs/docs.md
+4
-1
docs/docs.md
···
6
6
7
7
To 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
8
9
+
## Documentation guidelines
10
+
11
+
For consistency and ease of contribution across projects, we follow the [ROOST community documentation guidelines](https://roostorg.github.io/community/documentation.html) whenever possible.
12
+
9
13
## Developing locally
10
14
11
15
To build the site locally, clone this repository and install `mdbook` (follow the [official installation instructions](https://rust-lang.github.io/mdBook/guide/installation.html)).
···
17
21
```
18
22
19
23
Then 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.
20
-