Skip to content

Commit 962a981

Browse files
alice-i-cecileAlice CecileBD103
authored
Editing pass for the migration guide (#1499)
Co-authored-by: Alice Cecile <[email protected]> Co-authored-by: BD103 <[email protected]>
1 parent 1fc8745 commit 962a981

File tree

6 files changed

+24
-35
lines changed

6 files changed

+24
-35
lines changed

content/learn/migration-guides/0.13-to-0.14.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ insert_anchor_links = "right"
44
[extra]
55
weight = 9
66
long_title = "Migration Guide: 0.13 to 0.14"
7-
public_draft = 1188
87
+++
98

109
{{ migration_guides(version="0.14") }}

release-content/0.14/migration-guides/12314_Clean_up_type_registrations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
External types are no longer registered into the type registry automatically unless they are used by other Bevy types (due to the new recursive registration). If you were depending on types from `std`, `glam`, or similar types being in the type registry you may need to manually register them.
1+
Many external types are no longer registered into the type registry by Bevy's default plugin. Generally, only types used by other Bevy types (due to the new recursive registration) will be registered by default. If you were using reflection features with types from `std` or `glam` you may need to manually register them.
22

33
```rust
44
App::new().register_type::<DMat3>();
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
The asset loader's `Reader` type alias now requires the new `AsyncSeek` trait. Please implement `AsyncSeek` for any structures that must be a `Reader`, or use an alternative if seeking is not supported.
2+
3+
If this is a problem for you, please chime in at [bevy#12880](https://github.com/bevyengine/bevy/issues/12880) and help us improve the design for 0.15!
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
`WorldCell` has been removed due to its incomplete, less performant, and potentially confusing nature. If you were using it to fetch multiple distinct values, consider using a `SystemState` instead with the `SystemState::get()` method.
1+
`WorldCell` has been removed due to its incomplete nature, tendency to generate runtime panics, and the presence of multiple good alternatives. If you were using it to fetch multiple distinct resource values, consider using a `SystemState` instead with the `SystemState::get()` method.
22

33
If `SystemState` does not fit your use-case and `unsafe` is tolerable, you can use `UnsafeWorldCell`. It is more performant and featureful, but lacks the runtime checks.

release-content/0.14/migration-guides/12666_FIX12527_Changes_to_make_serde_optional_for_bevy_color.md

Lines changed: 0 additions & 6 deletions
This file was deleted.

release-content/0.14/migration-guides/_guides.toml

Lines changed: 20 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
[[guides]]
2+
title = "Overhaul `Color`"
3+
url = "https://github.com/bevyengine/bevy/pull/12163"
4+
areas = ["Color", "Gizmos", "Rendering", "Text", "UI"]
5+
file_name = "12163_Migrate_from_LegacyColor_to_bevy_colorColor.md"
6+
7+
[[guides]]
8+
title = "Make default behavior for `BackgroundColor` and `BorderColor` more intuitive"
9+
url = "https://github.com/bevyengine/bevy/pull/14017"
10+
areas = ["Rendering", "UI"]
11+
file_name = "14017_Make_default_behavior_for_BackgroundColor_and_BorderColor_.md"
12+
13+
[[guides]]
14+
title = "Register missing types manually"
15+
url = "https://github.com/bevyengine/bevy/pull/12314"
16+
areas = ["Reflection"]
17+
file_name = "12314_Clean_up_type_registrations.md"
18+
119
[[guides]]
220
title = "Fix `Node2d` typo"
321
url = "https://github.com/bevyengine/bevy/pull/12038"
@@ -29,7 +47,7 @@ areas = ["Animation"]
2947
file_name = "11989_Implement_the_AnimationGraph_allowing_for_multiple_animati.md"
3048

3149
[[guides]]
32-
title = "Multiplying `LinearRgba` by `f32` no longer ignores alpha channel"
50+
title = "Multiplying colors by `f32` no longer ignores alpha channel"
3351
url = "https://github.com/bevyengine/bevy/pull/12575"
3452
areas = ["Animation", "Color", "Math", "Rendering"]
3553
file_name = "12575_Color_maths_4.md"
@@ -77,7 +95,7 @@ areas = ["Assets"]
7795
file_name = "12605_Make_AssetActionIgnore_not_copy_assets_to_imported_assets.md"
7896

7997
[[guides]]
80-
title = "Removed `Into<AssedId<T>>` for `Handle<T>`"
98+
title = "Removed `Into<AssetId<T>>` for `Handle<T>`"
8199
url = "https://github.com/bevyengine/bevy/pull/12655"
82100
areas = ["Assets"]
83101
file_name = "12655_Removed_IntoAssedIdT_for_HandleT_as_mentioned_in_12600.md"
@@ -130,12 +148,6 @@ url = "https://github.com/bevyengine/bevy/pull/13209"
130148
areas = ["Color"]
131149
file_name = "13209_move_wgsl_color_operations_from_bevy_pbr_to_bevy_render.md"
132150

133-
[[guides]]
134-
title = "Overhaul `Color`"
135-
url = "https://github.com/bevyengine/bevy/pull/12163"
136-
areas = ["Color", "Gizmos", "Rendering", "Text", "UI"]
137-
file_name = "12163_Migrate_from_LegacyColor_to_bevy_colorColor.md"
138-
139151
[[guides]]
140152
title = "Remove old color space utilities"
141153
url = "https://github.com/bevyengine/bevy/pull/12105"
@@ -430,12 +442,6 @@ url = "https://github.com/bevyengine/bevy/pull/5781"
430442
areas = ["Reflection"]
431443
file_name = "5781_bevy_reflect_Recursive_registration.md"
432444

433-
[[guides]]
434-
title = "Clean up type registrations"
435-
url = "https://github.com/bevyengine/bevy/pull/12314"
436-
areas = ["Reflection"]
437-
file_name = "12314_Clean_up_type_registrations.md"
438-
439445
[[guides]]
440446
title = "Rename `UntypedReflectDeserializer` to `ReflectDeserializer`"
441447
url = "https://github.com/bevyengine/bevy/pull/12721"
@@ -682,18 +688,6 @@ url = "https://github.com/bevyengine/bevy/pull/13462"
682688
areas = ["Rendering", "UI"]
683689
file_name = "13462_Fix_UI_elements_randomly_not_appearing_after_13277.md"
684690

685-
[[guides]]
686-
title = "Make default behavior for `BackgroundColor` and `BorderColor` more intuitive"
687-
url = "https://github.com/bevyengine/bevy/pull/14017"
688-
areas = ["Rendering", "UI"]
689-
file_name = "14017_Make_default_behavior_for_BackgroundColor_and_BorderColor_.md"
690-
691-
[[guides]]
692-
title = "Make `serde` optional for `bevy_color`"
693-
url = "https://github.com/bevyengine/bevy/pull/12666"
694-
areas = ["Rendering", "Utils"]
695-
file_name = "12666_FIX12527_Changes_to_make_serde_optional_for_bevy_color.md"
696-
697691
[[guides]]
698692
title = "Rename `need_new_surfaces()` system to `need_surface_configuration()`"
699693
url = "https://github.com/bevyengine/bevy/pull/12055"

0 commit comments

Comments
 (0)