Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-25 14:10:19 +00:00
Code Issues Projects Releases Packages Wiki Activity

Mention dev docs in CONTRIBUTING.md (#5969)

Browse source 
# Objective
Fixes #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.
This commit is contained in:
James Liu 2022-09-12 22:59:14 +00:00
parent 1b9720526e
commit 9c08a5df76
1 changed files with 2 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CONTRIBUTING.md
View file

@ -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. * 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. [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 ### Writing examples