Add banner to warn user of required feature flags for examples #2313
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-merge-queue bot
pushed a commit
to bevyengine/bevy
that referenced
this pull request
Dec 4, 2025
# Objective This PR is a sister PR necessary for the website to have `required_features` data. You will find more information on the motivations there: bevyengine/bevy-website#2313 ## Solution - Add the required_features data to the examples docs export ## Testing I tested both together and it worked fine
Rodhlann
reviewed
Dec 4, 2025
templates/layouts/example.html
Outdated
| </aside> | ||
| {% if page.extra.required_features %} | ||
| <aside class="callout callout--warning"> | ||
| <h3 class="warning">Optional feature flag</h3> |
Contributor
There was a problem hiding this comment.
I think having this header text as "Optional feature flag" is confusing. If I am understanding this issue correctly the feature flag is not optional for this example, which is described with added clarity below.
Maybe "Feature flag required for example" or "Feature flag details" provide more clarity?
Author
There was a problem hiding this comment.
I agree, I think "Feature flag required" is a better name, I will make the change
Member
|
blocked until the 0.18 is released |
Contributor
|
I wanted to get an example of multiple feature flags being enabled before approving, just to double check the behavior. I ended up spoofing the behavior, but it works as advertised. Looks good! 
|
Rodhlann
approved these changes
Dec 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As a user, it kinda sucks copying a website example only to see it not working and with unhelpful rust errors.
Some examples do mention it in their description, but it's not universal and can be forgotten. It's also easy to miss.
My solution is to add a warning banner that lists out the optional feature flags that are required for the example to work (no banner if no required features).
The information is collected from the required_features specified in the root
Cargo.tomlof the bevy engine.This data is not yet available to the website so I made another PR in bevy to make it available: bevyengine/bevy#21975.
EDIT: The required change has now been merged, this is ready to go
Feel free to give feedback on the wording or anything else.
This is how it would look:
