Browse Source

docs: Content updates (#446)

* chore: Additional pages added

* fix: Content updates to .NET 10 and VS 2026

* chore: Latest docs updated

* fix: Typo fixed
Vaclav Elias 1 month ago
parent
commit
856572a650

+ 11 - 2
en/contributors/documentation/major-release-workflow.md

@@ -30,9 +30,18 @@ The `BuildDocs.ps1` script will manage the deployment to the `4.2` folder while
 
 
 1. Modify `contributors\engine\building-source-windows.md`
 1. Modify `contributors\engine\building-source-windows.md`
    - Update SDK version references
    - Update SDK version references
+   - Update Visual Studio version
+1. Modify `contributors\engine\building-source-windows-other-ide.md`
+   - Update Build Tools path
+1. Modify `contributors\engine\building-source-windows-visual-studio.md`
+   - Update Visual Studio version
 1. Modify `manual\troubleshooting\stride-doesnt-run.md`
 1. Modify `manual\troubleshooting\stride-doesnt-run.md`
-   - Update SDK version references
+   - Update SDK and .NET version references
+   - Update Visual Studio version 
 1. Modify `manual\files-and-folders\distribute-a-game.md`
 1. Modify `manual\files-and-folders\distribute-a-game.md`
    - Update SDK version references
    - Update SDK version references
 1. Modify `manual\get-started\update-stride.md` 
 1. Modify `manual\get-started\update-stride.md` 
-   - Update Visual Studio version
+   - Update Visual Studio version
+1. Modify `includes\docs-prerequisites.md` 
+   - Update SDK and .NET version references
+   - Update Visual Studio version 

+ 2 - 2
en/contributors/engine/building-source-windows-other-ide.md

@@ -1,8 +1,8 @@
 # Build Stride without Visual Studio
 # Build Stride without Visual Studio
 
 
-1. **Install** [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe) with the same prerequisites listed above.
+1. **Install** [Visual Studio Build Tools](https://aka.ms/vs/stable/vs_BuildTools.exe) with the same prerequisites listed above.
 2. **Add MSBuild to your system's PATH:**
 2. **Add MSBuild to your system's PATH:**
-   - Add MSBuild's directory to your `PATH` environment variable (e.g., `C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\MSBuild\Current\Bin`).
+   - Add MSBuild's directory to your `PATH` environment variable (e.g., `C:\Program Files (x86)\Microsoft Visual Studio\2026\BuildTools\MSBuild\Current\Bin`).
 3. **Clone the repository:**
 3. **Clone the repository:**
    ```bash
    ```bash
    git lfs clone https://github.com/stride3d/stride.git
    git lfs clone https://github.com/stride3d/stride.git

+ 4 - 4
en/contributors/engine/building-source-windows-visual-studio.md

@@ -1,4 +1,4 @@
-# Build Stride with Visual Studio 2022
+# Build Stride with Visual Studio 2026
 
 
 Here are the steps to build Stride with Visual Studio. If you do not have or want to use Visual Studio, see [building with other IDEs](building-source-windows-other-ide.md).
 Here are the steps to build Stride with Visual Studio. If you do not have or want to use Visual Studio, see [building with other IDEs](building-source-windows-other-ide.md).
 
 
@@ -7,7 +7,7 @@ Here are the steps to build Stride with Visual Studio. If you do not have or wan
    git lfs clone https://github.com/stride3d/stride.git
    git lfs clone https://github.com/stride3d/stride.git
    ```
    ```
 2. **Open the solution:**
 2. **Open the solution:**
-   - Open `<StrideDir>\build\Stride.sln` with Visual Studio 2022. 
+   - Open `<StrideDir>\build\Stride.sln` with Visual Studio. 
    - Build the `Stride.GameStudio` project in the `60-Editor` solution folder (it should be the default startup project) or run it directly from Visual Studio's toolbar.
    - Build the `Stride.GameStudio` project in the `60-Editor` solution folder (it should be the default startup project) or run it directly from Visual Studio's toolbar.
    - _Optionally_, open and build `Stride.Android.sln`, `Stride.iOS.sln`, etc.
    - _Optionally_, open and build `Stride.Android.sln`, `Stride.iOS.sln`, etc.
 
 
@@ -17,9 +17,9 @@ Here are the steps to build Stride with Visual Studio. If you do not have or wan
 ## If building failed
 ## If building failed
 
 
 * Some errors for test projects are normal, GameStudio will start anyway.
 * Some errors for test projects are normal, GameStudio will start anyway.
-* The Visual Studio extension might fail to build if you are missing the [Visual Studio SDK](https://learn.microsoft.com/en-us/visualstudio/extensibility/installing-the-visual-studio-sdk?view=vs-2022), but Game Studio will start anyway.
+* The Visual Studio extension might fail to build if you are missing the [Visual Studio SDK](https://learn.microsoft.com/en-us/visualstudio/extensibility/installing-the-visual-studio-sdk?view=visualstudio), but Game Studio will start anyway.
 * If you skipped any of the **Prerequisites** thinking you already have the latest version, please update to the latest to be sure.
 * If you skipped any of the **Prerequisites** thinking you already have the latest version, please update to the latest to be sure.
-* Visual Studio might have issues building properly if an older version is present alongside 2022. If you want to keep those versions, ensure they are up to date and that you are building Stride using Visual Studio 2022.
+* Visual Studio might have issues building properly if an older version is present alongside 2026. If you want to keep those versions, ensure they are up to date and that you are building Stride using Visual Studio 2026.
 * Your system's `PATH` should not contain older versions of MSBuild (e.g., `...\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin` should be removed).
 * Your system's `PATH` should not contain older versions of MSBuild (e.g., `...\Microsoft Visual Studio\2019\BuildTools\MSBuild\Current\Bin` should be removed).
 * Some changes might require a system reboot. Try that if you haven't yet, for example, if you see these errors:
 * Some changes might require a system reboot. Try that if you haven't yet, for example, if you see these errors:
   * `Could not find a compatible version of MSBuild.`
   * `Could not find a compatible version of MSBuild.`

+ 3 - 3
en/contributors/engine/building-source-windows.md

@@ -5,7 +5,7 @@
 1. **Latest [Git](https://git-scm.com/downloads)** with **Large File Support** selected during setup. For convenience, you might also use a Git UI client like [GitExtensions](https://gitextensions.github.io/).
 1. **Latest [Git](https://git-scm.com/downloads)** with **Large File Support** selected during setup. For convenience, you might also use a Git UI client like [GitExtensions](https://gitextensions.github.io/).
 2. **[.NET 10.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/10.0)**
 2. **[.NET 10.0 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/10.0)**
    - Run `dotnet --info` in a console or PowerShell window to see which versions you have installed.
    - Run `dotnet --info` in a console or PowerShell window to see which versions you have installed.
-3. **[Visual Studio 2026](https://visualstudio.microsoft.com/insiders/)** (the Community edition is free), with the following workloads. Follow this link if you would rather use [a different IDE or the command line](#build-stride-without-visual-studio).
+3. **[Visual Studio 2026](https://visualstudio.microsoft.com/downloads/)** (the Community edition is free), with the following workloads. Follow this link if you would rather use [a different IDE or the command line](#build-stride-without-visual-studio).
    - **.NET desktop development** with **.NET Framework 4.7.2 targeting pack** *(should be enabled by default)*
    - **.NET desktop development** with **.NET Framework 4.7.2 targeting pack** *(should be enabled by default)*
    - **Desktop development with C++** with:
    - **Desktop development with C++** with:
      - **Windows 11 SDK (10.0.22621.0)** or a later version *(should be enabled by default)*
      - **Windows 11 SDK (10.0.22621.0)** or a later version *(should be enabled by default)*
@@ -16,12 +16,12 @@
    - *Optional* (to build the VSIX package): **Visual Studio extension development**
    - *Optional* (to build the VSIX package): **Visual Studio extension development**
 
 
 > [!NOTE]
 > [!NOTE]
-> The installation of Visual Studio with the required components may require up to **14 GB of disk space**, depending on your system and selected components.
+> The installation of Visual Studio with the required components may require up to **19 GB of disk space**, depending on your system and selected components.
 
 
 > [!WARNING]
 > [!WARNING]
 > If this is your first time installing the .NET SDK, you might need to restart your system after the installation so that the system can recognize the new environment variables.
 > If this is your first time installing the .NET SDK, you might need to restart your system after the installation so that the system can recognize the new environment variables.
 
 
 ## Build Stride
 ## Build Stride
 
 
-- [Visual Studio 2022 instructions](building-source-windows-visual-studio.md)
+- [Visual Studio 2026 instructions](building-source-windows-visual-studio.md)
 - [Rider or Visual Studio Code instructions](building-source-windows-other-ide.md)
 - [Rider or Visual Studio Code instructions](building-source-windows-other-ide.md)

+ 3 - 3
en/includes/docs-prerequisites.md

@@ -1,5 +1,5 @@
 1. Familiarity with the command line
 1. Familiarity with the command line
-1. **.NET SDK 8.0 or higher:** You can download the installer from the [.NET SDK website](https://dotnet.microsoft.com/en-us/download)
-   - If .NET SDK is already installed, ensure you have version 8.0 or higher. You can check your version by running `dotnet --info` in a terminal.
+1. **.NET SDK 10.0 or higher:** You can download the installer from the [.NET SDK website](https://dotnet.microsoft.com/en-us/download)
+   - If .NET SDK is already installed, ensure you have version 10.0 or higher. You can check your version by running `dotnet --info` in a terminal.
 1. **Git installed:** You will need Git for version control. If you don't have Git installed, you can download it from the [Git website](https://git-scm.com/downloads)
 1. **Git installed:** You will need Git for version control. If you don't have Git installed, you can download it from the [Git website](https://git-scm.com/downloads)
-1. **Development IDE of choice:** Choose an Integrated Development Environment (IDE) that you're comfortable with for development. Although there are various popular choices, such as Visual Studio, Visual Studio Code, and others, this guide will focus on using **Visual Studio**, as it is the primary IDE for the Stride project, and as of writing, we use **Visual Studio 2022**. You can download the free Community edition from the [Visual Studio website](https://visualstudio.microsoft.com/downloads/)
+1. **Development IDE of choice:** Choose an Integrated Development Environment (IDE) that you're comfortable with for development. Although there are various popular choices, such as Visual Studio, Visual Studio Code, and others, this guide will focus on using **Visual Studio**, as it is the primary IDE for the Stride project, and as of writing, we use **Visual Studio 2026**. You can download the free Community edition from the [Visual Studio website](https://visualstudio.microsoft.com/downloads/)

+ 1 - 1
en/manual/files-and-folders/cached-files.md

@@ -14,7 +14,7 @@ You might want to clean the cache if:
 
 
     ![Clean solution](media/clean-solution.png)
     ![Clean solution](media/clean-solution.png)
 
 
-2. If you have the [Stride Visual Studio extension](../get-started/visual-studio-extension.md) installed, you can also clean the asset cache. **Using VS 2022**: To do this, under Extensions > **Stride**, select **Clean intermediate assets for Solution**.
+2. If you have the [Stride Visual Studio extension](../get-started/visual-studio-extension.md) installed, you can also clean the asset cache. **Using Visual Studio**: To do this, under Extensions > **Stride**, select **Clean intermediate assets for Solution**.
 
 
     ![Clean solution](media/clean-assets.png)
     ![Clean solution](media/clean-assets.png)
 
 

+ 5 - 1
en/manual/index.md

@@ -19,6 +19,10 @@ To edit any page of this manual, click the **Edit this page** link at the bottom
 **Recent updates**
 **Recent updates**
 
 
 - Manual
 - Manual
+  - <span class="badge text-bg-info">Updated</span> [Scripts - Best Practices](scripts/best-practice.md) - More content added
+  - <span class="badge text-bg-warning">Important</span> [Physics - Script a trigger](physics/script-a-trigger.md) - Example updated
+  - <span class="badge text-bg-warning">Important</span> [Physics - Triggers](physics/triggers.md) - Example updated 
+  - <span class="badge text-bg-info">Updated</span> [Graphics - Custom shaders](graphics/effects-and-shaders/custom-shaders.md) - Troubleshooting section added
   - <span class="badge text-bg-success">New</span> [Glossary](glossary/index.md) - New glossary section added 
   - <span class="badge text-bg-success">New</span> [Glossary](glossary/index.md) - New glossary section added 
 
 
 **Previous updates**
 **Previous updates**
@@ -43,5 +47,5 @@ To edit any page of this manual, click the **Edit this page** link at the bottom
   - <span class="badge text-bg-info">Updated</span> [Tutorials](../tutorials/index.md) - Added lesson counts and total length
   - <span class="badge text-bg-info">Updated</span> [Tutorials](../tutorials/index.md) - Added lesson counts and total length
 - Contributing
 - Contributing
   - <span class="badge text-bg-info">Updated</span> [Contributing - Roadmap](../contributors/roadmap.md) - GitHub Project - Roadmap link added
   - <span class="badge text-bg-info">Updated</span> [Contributing - Roadmap](../contributors/roadmap.md) - GitHub Project - Roadmap link added
-  - <span class="badge text-bg-success">New</span> [Contributing - Core Team](../contributors/core-team.md) - The Stride core team
+  - <span class="badge text-bg-success">New</span> [Contributing - Core team](../contributors/core-team.md) - The Stride core team
   - <span class="badge text-bg-info">Updated</span> [Contributing - Roadmap](../contributors/roadmap.md) - Status added
   - <span class="badge text-bg-info">Updated</span> [Contributing - Roadmap](../contributors/roadmap.md) - Status added

+ 1 - 1
en/manual/physics/index.md

@@ -3,7 +3,7 @@
 ![Physics in Stride](media/physics-index-physics-in-stride.png)
 ![Physics in Stride](media/physics-index-physics-in-stride.png)
 
 
 > [!WARNING]
 > [!WARNING]
-> These pages are being updated. [Bullet Physics](../physics-bullet/index.md) is being phased out. We no longer plan to support or expand its features as our focus shifts to Bepu Physics. We recommend transitioning to Bepu Physics for access to the latest updates and ongoing improvements.
+> [Bullet Physics](../physics-bullet/index.md) is being phased out. We no longer plan to support or expand its features as our focus shifts to Bepu Physics. We recommend transitioning to Bepu Physics for access to the latest updates and ongoing improvements.
 
 
 Stride simulates real-world physics such as gravity and collisions using "Bepu physics".
 Stride simulates real-world physics such as gravity and collisions using "Bepu physics".
 This section explains how physics components work, how to add them to your project, and how to use them with scripts.
 This section explains how physics components work, how to add them to your project, and how to use them with scripts.

+ 1 - 1
en/manual/toc.yml

@@ -419,7 +419,7 @@ items:
           - name: Custom particles
           - name: Custom particles
             href: particles/tutorials/custom-particles.md
             href: particles/tutorials/custom-particles.md
 
 
-  - name: Physics [WIP]
+  - name: Physics
     href: physics/index.md
     href: physics/index.md
     items:
     items:
       - name: Configuration
       - name: Configuration

+ 14 - 14
en/manual/troubleshooting/stride-doesnt-run.md

@@ -5,7 +5,7 @@
 If you're having trouble running Stride, make sure you've installed all the prerequisites:
 If you're having trouble running Stride, make sure you've installed all the prerequisites:
 
 
 * .NET SDK 10.0
 * .NET SDK 10.0
-* Visual C++ Redistributable 2019 (or later)
+* Visual C++ Redistributable 2022 (or later)
 * .NET Framework 4.7.2 (required for the Visual Studio plugin)
 * .NET Framework 4.7.2 (required for the Visual Studio plugin)
 * Visual Studio or Build Tools (optional but recommended)
 * Visual Studio or Build Tools (optional but recommended)
 
 
@@ -13,9 +13,9 @@ Alternatively, uninstall Stride, restart the Stride installer, and install the p
 
 
 ### .NET SDK 10.0
 ### .NET SDK 10.0
 
 
-.NET SDK 10.0 should have been installed by Stride prerequisite installer, if Visual Studio 2022 didn't do it previously.
+.NET SDK 10.0 should have been installed by Stride prerequisite installer, if Visual Studio 2026 didn't do it previously.
 
 
-If for some reason you need to install it manually, you can use [this link](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) and select the latest .NET SDK 10.0 for Windows.
+If for some reason you need to install it manually, you can use [this link](https://dotnet.microsoft.com/en-us/download/dotnet/10.0) and select the latest .NET SDK 10.0 for Windows.
 
 
 ### Visual C++ Redistributable 2019 (or later)
 ### Visual C++ Redistributable 2019 (or later)
 
 
@@ -23,9 +23,9 @@ To check if this is installed, see **Control Panel > Programs > Programs and Fea
 
 
 ![Programs and features](media/programs-and-features-redistributable.webp)
 ![Programs and features](media/programs-and-features-redistributable.webp)
 
 
-If it's not installed, you can download the Redistributable from [Visual Studio Downloads](https://www.visualstudio.com/downloads/) (under **Other Tools and Frameworks**). Make sure to install both **x86** and **x64** versions.
+If it's not installed, you can download the Redistributable from [Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/) (under **Other Tools, Frameworks, and Redistributables**). Make sure to install both **x86** and **x64** versions.
 
 
-> [!Note]
+> [!NOTE]
 > If you see **2015-2022 Redistributable** instead, it's ok. Since 2015, they are cumulative. Just make sure the last year is at least 2019.
 > If you see **2015-2022 Redistributable** instead, it's ok. Since 2015, they are cumulative. Just make sure the last year is at least 2019.
 
 
 ### .NET Framework 4.7.2 (or later)
 ### .NET Framework 4.7.2 (or later)
@@ -34,27 +34,27 @@ To check if this is installed, follow the instructions on [this page](https://le
 
 
 If it's not installed, you can download it from the [Microsoft Download Center](https://dotnet.microsoft.com/en-us/download/dotnet-framework).
 If it's not installed, you can download it from the [Microsoft Download Center](https://dotnet.microsoft.com/en-us/download/dotnet-framework).
 
 
-> [!Note]
+> [!NOTE]
 > If you have .NET 4.8 installed, you don't need to install .NET 4.7.2. Each 4.x version is cumulative.
 > If you have .NET 4.8 installed, you don't need to install .NET 4.7.2. Each 4.x version is cumulative.
 
 
-### Visual Studio 2022 (optional)
+### Visual Studio 2026 (optional)
 
 
-If you have Visual Studio 2022 (or later) installed, you need to have the following workloads and/or components installed:
+If you have Visual Studio 2026 (or later) installed, you need to have the following workloads and/or components installed:
 * **.NET desktop development** with **Development tools for .NET** optional component enabled.
 * **.NET desktop development** with **Development tools for .NET** optional component enabled.
 
 
-> [!Note]
-> Earlier versions might work with older version of Stride. However, for Stride 4.2 and later you only need to have .NET SDK 10.0 installed.
+> [!NOTE]
+> Earlier versions might work with older version of Stride. However, for Stride 4.3 and later you only need to have .NET SDK 10.0 installed.
 
 
-### Build Tools for Visual Studio 2022 (optional)
+### Build Tools for Visual Studio 2026 (optional)
 
 
-If you **don't** have Visual Studio installed and don't want to install it, you can install **Build Tools for Visual Studio** instead. You can download this from [Visual Studio Downloads](https://www.visualstudio.com/downloads/) (under **Tools for Visual Studio**).
+If you **don't** have Visual Studio installed and don't want to install it, you can install **Build Tools for Visual Studio** instead. You can download this from [Visual Studio Downloads](https://visualstudio.microsoft.com/downloads/) (under **Tools for Visual Studio**).
 
 
 You need to have the following workloads and/or components installed:
 You need to have the following workloads and/or components installed:
 * **.NET desktop build tools** with **.NET SDK** optional component enabled.
 * **.NET desktop build tools** with **.NET SDK** optional component enabled.
 
 
-> [!Note]
+> [!NOTE]
 > If you don't need Visual Studio, don't worry – it doesn't install it.
 > If you don't need Visual Studio, don't worry – it doesn't install it.
->![Installing VS build tools](../get-started/media/installing-vs-build-tools.webp)
+> ![Installing VS build tools](../get-started/media/installing-vs-build-tools.webp)
 
 
 ## See also
 ## See also