Skip to content

Add required features flags to the examples page #2146

@Sigma-dev

Description

@Sigma-dev

How can Bevy's documentation be improved?

Bevy examples sometimes require feature flags without mentionning them (ex: fps-overlay with the bevy_dev_tools flag).

This would make for a confusing situation when a developper copies the example code but the import can't get solved.

Solutions

My solution would be to display require feature flags somewhere on the page, be it in the header text and/or comments and/or a special place on the page that clearly marks what feature flags are necessary.

This data could either be added manually, or maybe a better way would be to automatically generate it based on the cargo.toml

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-ExamplesC-FeatureA new feature, making something new possibleS-Ready-For-ImplementationThe core questions are answered: just add codeX-UncontroversialThis work is generally agreed upon

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions