Skip to content

docs: add links to examples in the book #338

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.

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

Merged
merged 3 commits into from
Mar 2, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Summary
- enter PR summary here
- what did you change
- why did you do it this way?
- Are there alternative ways we need to keep in mind?

## Testing (Read & Delete Me)
- Did you write tests to cover new or modified behavior?
- These are not necessary, but very welcome
- I am always happy to receive any PR's, but adding tests makes it easier for me to merge them!

## Conventional PR Titles (Read & Delete me)
- This crate uses `release-plz` to manage our deploys
- A CI check will verify your PR title to make sure it uses a valid conventional prefix like:
- `feat: {title}` - corresponds to `Added` heading in changelog, backwards compatibile changes
- `fix: {title}` - corresponds to `Fixed` heading in changelog, fixes bugs or bad behavior
- `chore: {title}` -
- `docs: {title}`
- `tests: {title}`
- Adding a `!` before the `:` will signify this is also a breaking change
- This sort of change will cause a `MAJOR` version bump.
- You can also use scopes to further detail the area your PR is changing i.e.:
- `feat(ladfile): add global types`
- `fix(ladfile_builder): fix globals not getting exported`
- `docs(bms): document weird vector behavior on MacOS`
6 changes: 5 additions & 1 deletion .github/workflows/pr-titles.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,8 @@ jobs:
feat
chore
test
docs
docs
scopes: |
ladfile
ladfile_builder
bms
5 changes: 5 additions & 0 deletions docs/src/Examples/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Examples

In the future we hope to embedd live WASM code examples into the documentation, for now the best source of example scripts will be our regression test suite available in all supported languages in our [github repository](https://github.com/makspll/bevy_mod_scripting/tree/main/assets/tests).

For rust examples see [this folder](https://github.com/makspll/bevy_mod_scripting/tree/main/examples).
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
- [Shared Contexts](./Summary/sharing-contexts-between-scripts.md)
- [Script ID Mapping](./Summary/script-id-mapping.md)
- [Script Systems](./ScriptSystems/introduction.md)
- [Examples](./Examples/introduction.md)

# Scripting Reference

Expand Down
Loading