bevyengine / bevyengine/bevy-website

Move newtype pattern section for `Component` to the Book

Open
#375 3 comments 0 reactions 0 assignees View on GitHub
A-Book C-Content
Dominant language
JavaScript
Stars
249
Forks
450
Avg merge
16h 20m
Merged PRs (30d)
6

Description

## Issue

The following PR:

- bevyengine/bevy#4767,

introduces a paragraph in the API docs for `Component` about using the newtype pattern to implement the trait for foreign types. However, both @alice-i-cecile and myself, believe that this type of information is more suitable to the Bevy book.

## Solution

The following steps should be completed in order.

- [ ] Add paragraph and example to the Bevy book.
- [ ] Publish the version of the Bevy book containing the aforementioned change.
- [ ] Replace the paragraph and example in the API docs with a short sentence with a link to the right section of the Bevy book.

Contributor guide

Open the contributing guide

Research direction

Start by locating the Component API documentation and the relevant Bevy book section, then review the existing newtype-pattern paragraph and example introduced by bevyengine/bevy#4767. Add equivalent book content, publish that book version, and replace the API-doc paragraph with a short link to the book section.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.