Merge pull request #383 from stride3d/master

Deploy latest documentation updates to staging
stride3d · Jan 30, 2025 · e1b278e · e1b278e
2 parents 36a1a10 + 8eeaccb
commit e1b278e
Show file tree

Hide file tree

Showing 10 changed files with 277 additions and 6 deletions.
diff --git a/en/manual/nuget/create-packages.md b/en/manual/nuget/create-packages.md
@@ -10,8 +10,8 @@ First of all, after saving all your changes, open your project with Visual Studi
 ![Open project in Visual Studio](../game-studio/media/open-project-in-visual-studio.png)
 
 A few things to look out for:
-* Delete unecessary assets (i.e. GameSettings, etc...)
-* Delete unecessary `PackageReference`
+* Delete unnecessary assets (i.e. GameSettings, etc...)
+* Delete unnecessary `PackageReference`
 
 ## Optional: Setup Package properties
 

diff --git a/en/manual/scripts/best-practice.md b/en/manual/scripts/best-practice.md
diff --git a/en/manual/scripts/create-a-script.md b/en/manual/scripts/create-a-script.md
@@ -127,6 +127,7 @@ You can see the script in the **Asset View**.
 
 ## See also
 
+* [Best Practice](best-practice.md)
 * [Types of script](types-of-script.md)
 * [Use a script](use-a-script.md)
 * [Public properties and fields](public-properties-and-fields.md)

diff --git a/en/manual/scripts/custom-assets.md b/en/manual/scripts/custom-assets.md
@@ -176,4 +176,9 @@ RootAssets: []
 
 And you're finally done, have fun !
 
-![Result](media/template-result.png)
+![Result](media/template-result.png)
+
+
+## See also
+
+* [Best Practice](best-practice.md)
diff --git a/en/manual/scripts/events.md b/en/manual/scripts/events.md
@@ -1,5 +1,8 @@
 # Events
 
+>[!Note]
+>Events are not recommended anymore, see [Best Practice](best-practice.md)
+
 <span class="badge text-bg-primary">Intermediate</span>
 <span class="badge text-bg-success">Programmer</span>
 
@@ -54,6 +57,7 @@ string asyncData = await gameOverListenerWithData.ReceiveAsync();
 
 ## See also
 
+* [Best Practice](best-practice.md)
 * [Types of script](types-of-script.md)
 * [Create a script](create-a-script.md)
 * [Use a script](use-a-script.md)

diff --git a/en/manual/scripts/index.md b/en/manual/scripts/index.md
@@ -41,4 +41,5 @@ You can still use standard C# classes in Stride, but these aren't called scripts
 * [Preprocessor variables](preprocessor-variables.md)
 * [Create a model from code](create-a-model-from-code.md)
 * [Create Gizmos for your components](gizmos.md)
-* [Create Custom Assets](custom-assets.md)
+* [Create Custom Assets](custom-assets.md)
+* [Best Practice](best-practice.md)
diff --git a/en/manual/stride-for-godot-developers/index.md b/en/manual/stride-for-godot-developers/index.md
@@ -507,4 +507,9 @@ System.Diagnostics.Debug.WriteLine("hello");
 ```
 
 >[!Note]
-> To print debug messages, you have to run the game from Visual Studio, not Game Studio. There's no way to print to the Game Studio output window.
+> To print debug messages, you have to run the game from Visual Studio, not Game Studio. There's no way to print to the Game Studio output window.
+
+
+## See also
+
+* [Best Practice](../scripts/best-practice.md)
diff --git a/en/manual/stride-for-unity-developers/index.md b/en/manual/stride-for-unity-developers/index.md
@@ -817,3 +817,7 @@ public float MyProperty { get; init; }
 ---
 
 Unity® is a trademark of Unity Technologies.
+
+## See also
+
+* [Best Practice](../scripts/best-practice.md)
diff --git a/en/manual/toc.yml b/en/manual/toc.yml
@@ -540,6 +540,8 @@ items:
         href: scripts/gizmos.md
       - name: Create Custom Assets
         href: scripts/custom-assets.md
+      - name: Best Practice
+        href: scripts/best-practice.md
 
   - name: Sprites
     href: sprites/index.md

diff --git a/en/manual/troubleshooting/logging.md b/en/manual/troubleshooting/logging.md
@@ -91,7 +91,7 @@ This creates a file in the Debug folder of your project (eg *MyGame\MyGame\Bin\W
 
 ## Example script
 
-The following script checks that the texture `MyTexture` is loaded. When the texture loads, the log displays a debug message (`Log.Error`). If it doesn't load, the log records an error message (`Log.Debug`).
+The following script checks that the texture `MyTexture` is loaded. When the texture loads, the log displays a debug message (`Log.Debug`). If it doesn't load, the log records an error message (`Log.Error`).
 
 ```cs
 using System.Linq;