mirror of
https://github.com/bevyengine/bevy
synced 2024-11-22 04:33:37 +00:00
Mention dev docs in CONTRIBUTING.md (#5969)
# 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:
parent
1b9720526e
commit
9c08a5df76
1 changed files with 2 additions and 1 deletions
|
@ -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
|
||||
|
||||
|
|
Loading…
Reference in a new issue