`MeshPickingPlugin` is not mentioned in the module doc

Open Beginner friendly
#19,458 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
68/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
documentation

Research direction

Start with the linked bevy_picking module documentation and the MeshPickingPlugin entry point. Update the module documentation to explain that the plugin is required for mesh picking, including Mesh2d use, then verify the rendered documentation mentions both 2D and 3D mesh picking.

Written by the indexing model from the issue text.

Description

A-Picking C-Docs D-Straightforward S-Ready-For-Implementation

How can Bevy's documentation be improved?

The bevy_picking module doc doesn't mention anywhere the MeshPickingPlugin, which is critical not only for 3D meshes but also for 2D ones, because:

  • that plugin is not added by default
  • 2D meshes are different from sprites, so require the MeshPickingPlugin

The result is that spawning a Mesh2d + PickingInteraction does nothing, and the user can't understand why from docs.

In fact, even for 3D meshes, that top-level module documentation never mentions this plugin, despite the fact the doc does refer to mesh picking.

Dominant language
Rust
Stars
48.3k
Forks
4.9k
Avg merge
3d 17h
Merged PRs (30d)
172

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from bevyengine/bevy

All issues in bevyengine/bevy

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.