Merge pull request #188 from VaclavElias/update-9-manual-improvements

Update 9 manual improvements - Content and readability improvements

en/diagnostics/index.md

@@ -1,13 +1,13 @@
 # Stride diagnostics
 
-Stride.Core.CompilerServices contains Roslyn code analyzers.
+`Stride.Core.CompilerServices` contains Roslyn code analyzers.
 
 > [!IMPORTANT]
 > Analyzers are offline tools used by the compiler to assist programmers. They are not used to collect telemetry on how Stride is being used. These same analyzers are also utilized by your IDE to generate CSXXXX diagnostics.
 
-They analyze the code for possible issues in your project with the Stride.Core design.
+They analyze the code for possible issues in your project with the `Stride.Core` design.
 To avoid unexpected runtime/compile time/editor time behaviour these analyzers try to warn as soon as possible for issues that may occur.
-Each of the following pages contain information about diagnostic codes that can be reported by the Roslyn analyzers, which are built into Stride.Core.CompilerServices.
+Each of the following pages contain information about diagnostic codes that can be reported by the Roslyn analyzers, which are built into `Stride.Core.CompilerServices`.
 
 The information covers:
 
@@ -16,10 +16,9 @@ The information covers:
 - Examples when such a diagnostics occurs
 - Information about how to resolve the diagnostic
 
-If an error is reported it is possible to click in the IDE on the `diagnostic code` in the information box about the diagnostic.
-This will open the corresponding information page about the diagnostic.
+If an error is reported it is possible to click in the IDE on the `diagnostic code` in the information box about the diagnostic. This will open the corresponding information page about the diagnostic.
 
-The Stride.Core.CompilerServices is linked to Stride.Core, the diagnostic Analysis will only occur if your project references Stride.Core in the PackageReferences, this will automatically add the Stride.Core.CompilerServices to your project.
+The `Stride.Core.CompilerServices` is linked to `Stride.Core`, the diagnostic Analysis will only occur if your project references `Stride.Core` in the PackageReferences, this will automatically add the `Stride.Core.CompilerServices` to your project.
 
 > [!WARNING]
 > Note that diagnostic feature is experimental and may not work as expected. Warnings may contain solutions that don't work yet.

en/manual/engine/entity-component-model/index.md

@@ -1,6 +1,7 @@
 # ECS (Entity Component System) Introduction
 
 # Problem
+
 > `Dog` is a subclasses of `Animal`.
 
 This example is often used as an example of inheritance
@@ -10,13 +11,10 @@ we get problems:
 - `Bee` and `Bird` can fly, so we create `FlyingAnimal`
 - What do we now do with the `Duck`, who can do both?
 
-We have the exact same problem in video games.  
-Enemies can walk, shoot, fly - but not all of them can do everything.  
-Even something basic like hitpoints is not universal, as some enemies are indestructible.
+We have the exact same problem in video games. Enemies can walk, shoot, fly - but not all of them can do everything. Even something basic like hitpoints is not universal, as some enemies are indestructible.
 
 # Solution
 
-
 > Entity component system (ECS) is a software architectural pattern mostly used in video game development for the representation of game world objects. An ECS comprises entities composed from components of data, with systems which operate on entities' components.  
 > _-[Wikipedia](https://en.wikipedia.org/wiki/Entity_component_system)_
 
@@ -29,18 +27,13 @@ An entity with a collider component can collide, an entity with a sound componen
 
 ## Differing opinions
 
-For the "System" part of the term, there are two interpretations:
-
-A) "Entity-and-Component System"  
-...in which the components contain the data they need, and also the functionality that works with that data.
+For the **"System"** part of the term, there are two interpretations:
 
-B) "Entity, Component, System"  
-...in which a component only contains data, while a third part - the system -
-contains the functionality.
+1. **Entity-and-Component System:** In this setup, the components contain both the data they need and the functionality that works with that data.
+1. **Entity, Component, System:** In this arrangement, a component only contains data, while a third part - the system - contains the functionality.
 
-Stride allows working in both ways. A) can be achieved by using
-[scripts](https://doc.stride3d.net/latest/en/manual/scripts/index.html)
-while the usage of B) is described in this section of the manual.
+Stride allows for working in both ways. **1)** can be achieved by using
+[scripts](../../scripts/index.md) while the usage of **2)** is described in this section of the manual.
 
 ### Which one to choose?
 

en/manual/engine/entity-component-model/usage.md

@@ -2,12 +2,11 @@
 
 ## Classes
 
-The three parts of "Entity Component System" map to the following classes:
-
-- Entity - [`Stride.Engine.Entity`](https://doc.stride3d.net/latest/en/api/Stride.Engine.Entity.html)
-- Component - [`Stride.Engine.EntityComponent`](https://doc.stride3d.net/latest/en/api/Stride.Engine.EntityComponent.html)
-- System - [`Stride.Engine.EntityProcessor`](https://doc.stride3d.net/latest/en/api/Stride.Engine.EntityProcessor.html)
+The three parts of **Entity Component System** map to the following classes:
 
+- Entity - [`Stride.Engine.Entity`](xref:Stride.Engine.Entity)
+- Component - [`Stride.Engine.EntityComponent`](xref:Stride.Engine.EntityComponent)
+- System - [`Stride.Engine.EntityProcessor`](xref:Stride.Engine.EntityProcessor)
 
 ## Minimal Setup
 

en/manual/index.md

@@ -13,6 +13,8 @@ These pages contain information about how to use Stride, an open-source C# game
 - <span class="badge text-bg-info">Updated</span> [Linux - Setup and requirements](platforms/linux/setup-and-requirements.md) - Fedora OS option added
 - <span class="badge text-bg-success">New</span> [Scripts - Serialization](scripts/serialization.md) - Serialization explained
 - <span class="badge text-bg-info">Updated</span> [Scripts - Public properties and fields](scripts/public-properties-and-fields.md) - Content improvements and additions
+- <span class="badge text-bg-success">New</span> [Engine - Entity Component model - Usage](engine/entity-component-model/usage.md) - ECS usage explained
+- <span class="badge text-bg-info">Updated</span> [Engine - Entity Component model](engine/entity-component-model/index.md) - Content improvements
 - <span class="badge text-bg-info">Updated</span> [Stride for Unity® developers](stride-for-unity-developers/index.md) - Content improvements
 
 ### Previous updates