bevy/crates/bevy_ecs/src/entity
Federico Rinaldi 615d43b998 Improve bevy_ecs and bevy_app API docs where referenced by the new Bevy Book (#2365)
## Objective

The upcoming Bevy Book makes many references to the API documentation of bevy.

Most references belong to the first two chapters of the Bevy Book:

- bevyengine/bevy-website#176
- bevyengine/bevy-website#182

This PR attempts to improve the documentation of `bevy_ecs` and `bevy_app` in order to help readers of the Book who want to delve deeper into technical details.

## Solution

- Add crate and level module documentation
- Document the most important items (basically those included in the preludes), with the following style, where applicable:
    - **Summary.** Short description of the item.
    - **Second paragraph.** Detailed description of the item, without going too much in the implementation.
    - **Code example(s).**
    - **Safety or panic notes.**

## Collaboration

Any kind of collaboration is welcome, especially corrections, wording, new ideas and guidelines on where the focus should be put in.

---

### Related issues

- Fixes #2246
2021-09-17 18:00:29 +00:00
..
map_entities.rs Bevy ECS V2 (#1525) 2021-03-05 07:54:35 +00:00
mod.rs Improve bevy_ecs and bevy_app API docs where referenced by the new Bevy Book (#2365) 2021-09-17 18:00:29 +00:00
serde.rs Bevy ECS V2 (#1525) 2021-03-05 07:54:35 +00:00