roost.tools / osprey
Mirror of https://github.com/roostorg/osprey github.com/roostorg/osprey
1
fork

Configure Feed

Select the types of activity you want to include in your feed.

osprey / docs / docs.md
at ac59500a041b15baca93caa00a1403b49a95c840 1.5 kB view raw view code
Cassidy James Blaede docs: mention documentation guidelines (#133)
03924484

Contribute to these docs#

This documentation site is built using mdBook and deployed to GitHub Pages. Changes merged into the main branch will automatically be built and deployed.

Documentation 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.

To understand more about how mdBook works, learn about the anatomy of a book.

Documentation guidelines#

For consistency and ease of contribution across projects, we follow the ROOST community documentation guidelines whenever possible.

Developing locally#

To build the site locally, clone this repository and install mdbook (follow the official installation instructions).

Once installed, use the mdbook command-line tool from the root of this repo. For example, to automatically start watching, building, and serving the site:

mdbook serve

Then make your changes, preview them in your web browser (at http://localhost:3000 by default), commit, push, and open a pull request like any other git project.