From 9c08a5df7675e54ed672dc99a991fa337b54be77 Mon Sep 17 00:00:00 2001 From: James Liu Date: Mon, 12 Sep 2022 22:59:14 +0000 Subject: [PATCH] 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. --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index efe4b499e4bef..7ce0459b13f56 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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