bevyengine / bevyengine/bevy

Consider using doc examples when apropriate

Open
#23,572 1 comment 0 reactions 0 assignees View on GitHub
A-Cross-Cutting C-Docs D-Modest S-Needs-Design
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

## What problem does this solve or what need does it fill?

Bevy provides a ton of examples, which is great. But do all of them really need to be runnable?
For example, running [dynamic_types](https://github.com/bevyengine/bevy/blob/main/examples/reflection/dynamic_types.rs) is not very useful.

## What solution would you like?

I think examples like `dynamic_types` would fit better as doc examples. This would improve the user experience by having this information directly in the documentation. Additionally, binary examples take quite some time to compile.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.