bevyengine / bevyengine/bevy

Include shared docs in both trait and derive documentation

Open
#19,537 1 comment 0 reactions 0 assignees View on GitHub
A-ECS C-Docs D-Straightforward S-Ready-For-Implementation X-Uncontroversial
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 16h
Merged PRs (30d)
171

Description

I think it would make sense to split out the derive syntax section of the `Component` and `Event` docs into a separate markdown file, then `#[doc = include_str!("…")]` it in both the trait doc and the derive macro doc.

_Originally posted by @SpecificProtagonist in https://github.com/bevyengine/bevy/issues/19523#issuecomment-2953728453_

Contributor guide

Open the contributing guide

Research direction

Locate the `Component` and `Event` trait documentation and their derive macro documentation, then identify the derive syntax section shared between them. Extract that section into a markdown file and include it in both documentation locations; done means both docs contain the same shared derive syntax content.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.