Skip to content

Document bevy::gizmos #8179

Description

@jakobhellermann

How can Bevy's documentation be improved?

The gizmo module was added in #6529 but it is not documented right now: https://dev-docs.bevyengine.org/bevy/gizmos/gizmos/index.html
image

We should document

  1. which type is the system param you want to use?
  2. have a module-level example for usage
  3. have per-method usage examples that are easy to copy paste. Especially for the methods returning a SphereBuilder or CircleBuilder it's not clear to be how they are intended to be used, just from the docs.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-GizmosVisual editor and debug gizmosA-RenderingDrawing game state to the screenC-DocsAn addition or correction to our documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions