Skip to content

Commit

Permalink
Mention dev docs in CONTRIBUTING.md (bevyengine#5969)
Browse files Browse the repository at this point in the history
# Objective
Fixes bevyengine#5390. Makes https://dev-docs.bevyengine.org/ a bit more discoverable.

## Solution
Mention the option as an alternative option to building the docs yourself in CONTRIBUTING.md.
  • Loading branch information
james7132 committed Sep 12, 2022
1 parent 1b97205 commit 9c08a5d
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,8 @@ This is incredibly valuable, easily distributed work, but requires a bit of guid
* Accepted RFCs are not documentation: they serve only as a record of accepted decisions.

[docs.rs](https://docs.rs/bevy) is built from out of the last release's documentation, which is written right in-line directly above the code it documents.
To view the current docs on `main` before you contribute, clone the `bevy` repo, and run `cargo doc --open`.
To view the current docs on `main` before you contribute, clone the `bevy` repo, and run `cargo doc --open` or go to [dev-docs.bevengine.org](https://dev-docs.bevyengine.org/),
which has the latest API reference built from the repo on every commit made to the `main` branch.

### Writing examples

Expand Down

0 comments on commit 9c08a5d

Please sign in to comment.