Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update the learning material code snippet portion of contributing docs #15

Merged
merged 2 commits into from
Aug 13, 2024
Merged

Update the learning material code snippet portion of contributing docs #15

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3ad517
Update the learning material code snippet portion of contributing docs
TrialDragon Aug 13, 2024
a6126e8
Merge branch 'how-can-you-help' into learning-code-validation-addendum
alice-i-cecile Aug 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions content/contributing/helping-out/writing-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,15 @@ To check out any local changes you've made:

A local server should start and you should be able to access a local version of the website from there.

:::warning
The code in the book is compiled and tested to make sure that the examples work for readers.
:::
{% callout(type="warning") %}
The code in the learning materials (e.g., Bevy Book, Quick Start Guide, Advanced Examples, etc.) is compiled, formatted, and tested to make sure that the examples work for readers.
{% end %}

To validate your code snippets either run `validate_examples.sh` which resides in the `learning-code-examples` directory (and is the recommended way to use `learning-code-examples`), or from the root of the project run `cd learning-code-examples && cargo check --examples && cargo clippy --examples && cargo fmt --check`.

To check your local changes, move into the `code-validation` folder of this project using `cd code-validation`, and then run `cargo test`. If you write a new section of the book, you have to add it in `code-validation/src/lib.rs` to enable code validation for it.
{% callout() %}
[See the `learning-code-examples` README.md for more info.](https://github.com/bevyengine/bevy-website/blob/main/learning-code-examples/README.md)
{% end %}

## Learning material structure

Expand Down
Loading