bevyengine / bevyengine/bevy

Document Text Node Styling Incompatibility

Open
#20,247 0 comments 0 reactions 0 assignees View on GitHub
A-UI C-Docs
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 16h
Merged PRs (30d)
171

Description

It is not intuitive that `Text` nodes - which require the `Node` component - will silently break the styling options on `Node`. This should be documented on the [`Text`](https://docs.rs/bevy/latest/bevy/prelude/struct.Text.html) component along with the recommendation of placing those options on a parent entity instead.

Contributor guide

Open the contributing guide

Research direction

Start with the Text component documentation at the linked docs.rs page and review how Node styling options are described. Document that Text nodes require Node and can silently break Node styling options, then recommend placing those options on a parent entity instead; done means this guidance appears on the Text documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.