Improved Reflection Education
- Dominant language
- Rust
- Stars
- 48.2k
- Forks
- 4.8k
- Avg merge
- 3d 16h
- Merged PRs (30d)
- 171
Description
## Goal Description
The `bevy_reflect` crate is notoriously complex and difficult to understand—both for users and contributors. The existing documentation lacks the finer details and intuitive organization that would improve reflection education. This problem is exacerbated by technical debt and previous decisions that have contributed to the poor naming of some types/traits and an inconsistent vocabulary.
This Goal seeks to improve the learning experience for users of `bevy_reflect`.
## Goal Status
This is a potential [Bevy Project Goal](https://bevy.org/learn/contribute/project-information/project-goals/). Its state on the [Project Goals Board](https://github.com/orgs/bevyengine/projects/23/views/1) determines if it is Proposed, Postponed, Blocked (Approved), Unstaffed (Approved), Staffed (Approved), Completed, or Declined.
- **Staffing SMEs**: Not yet staffed
- **Working Group Link**: Working Group not yet formed
- **Design Documents**: Design documents not yet written
Contributor guide
Research direction
Start by reviewing the existing documentation for the `bevy_reflect` crate and the project goal status on the Project Goals Board. Clarify the vocabulary, naming concerns, and learning objectives before proposing design documents. Done means an approved, organized education plan and corresponding documentation improvements, but the goal is not yet staffed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100