Merge pull request #377 from stride3d/master

Deploy latest documentation updates to staging

Author: VaclavElias

.github/workflows/stride-docs-test-build.yml

@@ -0,0 +1,73 @@
+# Docs for the Azure Web Apps Deploy action: https://github.com/Azure/webapps-deploy
+# More GitHub Actions for Azure: https://github.com/Azure/actions
+
+name: Build Stride Docs - Test Build
+
+env:
+  COMMON_SETTINGS_PATH: en/docfx.json
+  VERSION: "2.0.0.${{ github.run_number }}"
+  DOCS_PATH: stride-docs
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: windows-2022
+
+    steps:
+    - name: .NET SDK Setup
+      uses: actions/setup-dotnet@v4
+      with:
+        dotnet-version: 8.x
+
+    # Checkout the Stride Docs repository from the branch that triggered the workflow
+    - name: Checkout Stride Docs
+      uses: actions/checkout@v4
+      with:
+        path: ${{ env.DOCS_PATH }}
+        lfs: true
+
+    - name: Set Version in docfx.json
+      run: |
+        $settingsContent = Get-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Raw
+        $updatedDocFxJsonContent = $settingsContent -replace '2.0.0.x', "${{ env.VERSION }}"
+        Set-Content -Path "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}" -Value $updatedDocFxJsonContent
+      shell: pwsh
+
+    # - name: Display Updated docfx.json
+    #   run: cat "${{ env.DOCS_PATH }}/${{ env.COMMON_SETTINGS_PATH }}"
+    #   shell: pwsh
+
+    # - name: Fail the Workflow
+    #   run: exit 1
+    #   shell: pwsh
+
+    # Checkout the Stride repository from the default branch
+    - name: Checkout Stride (note the LFS)
+      uses: actions/checkout@v4
+      with:
+        repository: stride3d/stride
+        token: ${{ secrets.GITHUB_TOKEN }}
+        path: stride
+        lfs: true
+        ref: master
+
+    - name: Install DocFX
+      # This installs the latest version of DocFX and may introduce breaking changes
+      # run: dotnet tool update -g docfx
+      # This installs a specific, tested version of DocFX.
+      run: dotnet tool update -g docfx --version 2.77.0
+
+    - name: Build documentation
+      run: ./build-all.bat
+      working-directory: ${{ env.DOCS_PATH }}
+
+    - name: Compress artifact
+      run: 7z a -r DocFX-app.zip ./${{ env.DOCS_PATH }}/_site/*
+
+    - name: Upload artifact for deployment job
+      uses: actions/upload-artifact@v4
+      with:
+        name: DocFX-app
+        path: DocFX-app.zip

en/ReleaseNotes/ReleaseNotes.md

@@ -8,6 +8,13 @@ Read the full blog post here: [Announcing Stride 4.2](https://www.stride3d.net/b
 
 A massive thank you to the open-source Stride community for your dedicated contributions. This release saw over 75 contributions from more than 22 amazing contributors, each playing a crucial role in making Stride 4.2 a reality.
 
+## Minor releases since the last major release
+
+- [4.2.0.2293](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.0.2293): January 2025
+- [4.2.0.2282](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.0.2282): December 2024
+- [4.2.0.2232](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.0.2232): September 2024
+- [4.2.0.2188](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.0.2188): June 2024
+
 ## What's new in Stride 4.2
 Stride 4.2 includes numerous enhancements and improvements. Here’s what to expect:
 

en/contributors/donate.md

@@ -1,10 +1,16 @@
-# Donating to Stride
+# Donating to Stride
+
 In order to support our contributors or if we want to finance a specific feature, we collect donations from individuals as well as organisations. 
 
 ## Open Collective
+
 We gather funding through a website called [OpenCollective](https://opencollective.com/stride3d). This website displays where all the money is coming from and where it is going to: 100% transparency guaranteed.
 
 ## Projects
-Stride's Open Collective hosts different '[Projects](https://opencollective.com/stride3d/projects)' — think of them as funding goals for specific features or contributions. Each project typically has a related GitHub ticket for more details on what's required for its development. If you're interested in working on or contributing to a particular feature, you can let us know by either replying:
+
+Stride's Open Collective hosts different [Projects](https://opencollective.com/stride3d/projects), think of them as funding goals for specific features or contributions. Each project typically has a related GitHub ticket for more details on what's required for its development.
+
+If you're interested in working on or contributing to a particular feature, you can let us know by either replying:
+
  - In each projects related GitHub thread and mention @stride3d/stride-contributors 
  - In the Stride [Contributors channel on Discord](https://discord.gg/bDhMhGVHvD)

en/contributors/roadmap.md

@@ -1,38 +1,25 @@
 # Roadmap
-The Stride game engine (MIT) is a collaborative endeavor managed by a small group of core volunteer developers, each with expertise in different areas of development. There are no full-time developers dedicated solely to Stride's advancement; instead, the engine progresses through the voluntary contributions of both the [core team](core-team.md) and the broader community. These individuals dedicate their spare time to enhance and expand the engine, motivated by personal interest, passion for the project, or their areas of expertise.
+
+The Stride game engine (MIT) is a collaborative endeavor managed by a small group of core volunteer developers, each with expertise in different areas of development. There are no full-time developers solely focused on Stride's advancement; instead, the engine progresses through the voluntary contributions of both the [core team](core-team.md) and the wider community. These individuals dedicate their spare time to enhance and expand the engine, driven by personal interest, passion for the project, or their areas of expertise.
 
 ## Contributors
-Contributions to Stride come in various forms. Some contributors focus on resolving existing issues, fostering the engine's stability and usability. Others venture into new territories, introducing improvements and features they deem beneficial, are personally intrigued by, or hold expertise in.
-
-## Community Roadmap and Open Collective
-The community has highlighted a range of feature requests, some of which are quite extensive of an Epic nature, requiring a long-term commitment from developers to complete. These larger goals form a "Community Roadmap" of sorts, reflecting the volunteer-driven nature of Stride's development process.
-
-Given the voluntary nature of contributions, the pace of progress hinges largely on the personal commitments and availability of our contributors. However, to catalyze action around certain desired features, Stride has established bounties through the [Open Collective](https://opencollective.com/stride3d). These bounties serve as a rallying call, incentivizing efforts towards tackling specific requests.
-
-- Bepu Physics integration <span class="badge text-bg-warning">In Progress</span>
-  - GitHub: https://github.com/stride3d/stride/pull/2131
-- Migrate Game Studio to Avalonia <span class="badge text-bg-warning">In Progress</span>
-  - GitHub: https://github.com/stride3d/stride/issues/1629
-  - Open collective project: https://opencollective.com/stride3d/projects/editor-rewrite-avalonia
-- Linux/MacOS https://github.com/stride3d/stride/issues/70
-- Improving asset pipeline <span class="badge text-bg-success">Done</span>
-  - Open collective project: https://opencollective.com/stride3d/projects/fbx-import-cpp-to-c-sharp
-  - Open collective project: https://opencollective.com/stride3d/projects/multiple-animations-per-model
-- Morph targets <span class="badge text-bg-info">On Hold</span>
-  - GitHub: https://github.com/stride3d/stride/issues/339
-  - Open collective project: https://opencollective.com/stride3d/projects/morph-targets
-- Decals https://opencollective.com/stride3d/projects/decals
-- Open XR support <span class="badge text-bg-info">On Hold</span>
-  - GitHub: https://github.com/stride3d/stride/discussions/1848
-  - Open collective project: https://opencollective.com/stride3d/projects/openxr-support
-- Embed into UI frameworks
-  - GitHub: https://github.com/stride3d/stride/pull/1315
-  - Open collective project: https://opencollective.com/stride3d/projects/embed-stride-ui-frameworks
-- Silk.NET integration
-  - GitHub: https://github.com/stride3d/stride/pull/
-  - Open collective project: https://opencollective.com/stride3d/projects/stride3d-silknet
-
-Other areas where contributors have been active 
-- Plugins: https://github.com/stride3d/stride/issues/1120
-- Improving Docs
-- Improving Website
+
+Contributions to Stride come in various forms. Some contributors focus on addressing [existing issues](https://github.com/stride3d/stride/issues) to improve stability and usability. Others explore new features or improvements they find valuable, intriguing, or hold expertise in.
+
+## Community Roadmap
+
+The community has highlighted a range of feature requests, some of which are quite extensive and of an epic nature, requiring a long-term commitment from developers to complete. These larger goals form a "Community Roadmap" of sorts, reflecting the volunteer-driven nature of Stride's development process.
+
+You can view the current list of feature requests, to-dos, and in-progress tasks on the [Community Roadmap](https://github.com/orgs/stride3d/projects/13).
+
+## Open Collective
+
+Because all contributions to Stride are voluntary, the pace of development largely depends on each contributor’s personal bandwidth and interests. To help prioritize or incentivize certain features, Stride maintains bounties through the [Open Collective](https://opencollective.com/stride3d/projects). These bounties encourage and reward contributors for tackling specific community requests.
+
+## Other Areas
+
+Contributors have also been active in the following areas:
+
+- [Plugins](https://github.com/stride3d/stride/issues/1120)
+- Improving Documentation
+- Enhancing the Website

en/docfx.json

@@ -21,7 +21,8 @@
             "sources/engine/Stride.Shaders/Stride.Shaders.csproj",
             "sources/engine/Stride.UI/Stride.UI.csproj",
             "sources/engine/Stride.VirtualReality/Stride.VirtualReality.csproj",
-            "sources/engine/Stride.Navigation/Stride.Navigation.csproj"
+            "sources/engine/Stride.Navigation/Stride.Navigation.csproj",
+            "sources/engine/Stride.BepuPhysics/Stride.BepuPhysics/Stride.BepuPhysics.csproj"
           ],
           "src": "../../stride",
           "properties": {

en/includes/bullet-physics-deprecation.md

@@ -0,0 +1,2 @@
+> [!WARNING]
+> Bullet Physics is being phased out. We no longer plan to support or expand its features as our focus shifts to [Bepu Physics](../manual/physics/index.md). We recommend transitioning to Bepu Physics for access to the latest updates and ongoing improvements.

en/manual/engine/entity-component-system/managing-entities.md

@@ -21,11 +21,10 @@ This approach also solves many update order dependencies issues (just need to or
 
 Here is some examples of entity processors:
 
-- @'Stride.Engine.TransformationProcessor': Compute transformation matrices from hierarchy and local transformation stored in @'Stride.Engine.TransformationComponent'.
-  
-  As a result, @'Stride.Engine.EntityManager' can be used as a hierarchical scenegraph instead of a simple entity list.
-- @'Stride.Engine.MeshProcessor': Add @'Stride.Engine.ModelComponent.Model' to rendering.
-- @'Stride.Engine.LightProcessor': Collects and update lights, and transfer it to rendering system. It can hides implementation details (deferred or forward rendering, etc...)
+- @'Stride.Engine.Processors.TransformProcessor': Compute transformation matrices from hierarchy and local transformation stored in @'Stride.Engine.TransformComponent'.
+  - As a result, @'Stride.Engine.EntityManager' can be used as a hierarchical scenegraph instead of a simple entity list.
+- @'Stride.Engine.Processors.ModelTransformProcessor': Add @'Stride.Engine.ModelComponent.Model' to rendering.
+- @'Stride.Rendering.Lights.LightProcessor': Collects and update lights, and transfer it to rendering system. It can hides implementation details (deferred or forward rendering, etc...)
 
 ## Entity System
 
@@ -45,5 +44,5 @@ foreach (var entity in engine.EntityManager.Entities)
 
 @'Stride.Engine.EntityManager' can be used to enumerate its `Entities (ref:{Stride.Engine.Entity})`. Note that children of a given entities will also be in this list.
 
-To manipulate entities as a scenegraph, refer to @'Stride.Engine.TransformationComponent' class.
+To manipulate entities as a scenegraph, refer to @'Stride.Engine.TransformComponent' class.
 

en/manual/get-started/install-stride.md

@@ -81,6 +81,9 @@ The **Stride Launcher** will download and install the latest version of Stride.
 
     While the installation is in progress, the release notes are displayed.
 
+    > [!Warning]
+    > If the .NET SDK has never been installed on your machine, the .NET SDK installation window might appear below the Stride installation window. Please check step 12 for details and be prepared to manually continue the .NET SDK installation.
+
 12. During the installation, you might be asked to install the .NET SDK if it's not already on your machine.
 
     ![Installation of .NET SDK](media/install-dotnet-SDK.webp)
@@ -99,6 +102,8 @@ The **Stride Launcher** will download and install the latest version of Stride.
 
 > [!Note]
 >  **Stride Launcher:** If you click **Start** and see an error message such as `Could not find a compatible version of MSBuild.` or `Path to dotnet executable is not set.`, close the Stride Launcher and restart it. This issue is caused by the Stride Launcher not detecting the .NET SDK installation. Restarting the Stride Launcher should resolve the issue. Alternatively, restart your computer.
+>
+> Example error: ![First launch error](media/stride-launcher-first-time-after-installation-error.webp)
  
 > [!Note]
 > If you don't install the prerequisites, Stride won't run. In this case, you can download and install the prerequisites separately. For instructions, see [Troubleshooting — Stride doesn't run](../troubleshooting/stride-doesnt-run.md).

en/manual/get-started/media/stride-launcher-first-time-after-installation-error.webp

@@ -11,10 +11,20 @@ These pages contain information about how to use Stride, an open-source C# game
 
 ### Recent updates
 
+#### Manual
+
+- <span class="badge text-bg-success">New</span> [Physics](physics/index.md) - Bepu Physics docs added
+- <span class="badge text-bg-info">Updated</span> [Bullet Physics](physics-bullet/index.md) - Bullet Physics docs moved
+
+#### Tutorials
+
+- <span class="badge text-bg-info">Updated</span> [Tutorials](../tutorials/index.md) - Added lesson counts and total length
+
 #### Contributors
 
-- <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) - GitHup Project - Roadmap link added
+
+### Previous updates
 
 #### Manual
 - <span class="badge text-bg-info">Updated</span> [Scripts - Types of script](scripts/types-of-script.md) - Asynchronous script example improved
@@ -27,16 +37,10 @@ These pages contain information about how to use Stride, an open-source C# game
 - <span class="badge text-bg-info">Updated</span> [Engine - Entity Component model](engine/entity-component-system/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
+#### Contributors
 
-- <span class="badge text-bg-success">New</span> [NuGet](nuget/index.md)
-- <span class="badge text-bg-success">New</span> [Video](video/index.md)
-- <span class="badge text-bg-success">New</span> [Cached files](files-and-folders/cached-files.md)
-- <span class="badge text-bg-success">New</span> [iOS](platforms/ios.md)
-- <span class="badge text-bg-success">New</span> [Compile shaders](graphics/effects-and-shaders/compile-shaders.md)
-- <span class="badge text-bg-info">Updated</span> [Skyboxes and backgrounds](graphics/textures/skyboxes-and-backgrounds.md)
-- <span class="badge text-bg-info">Updated</span> [Animate a camera with a model file](graphics/cameras/animate-a-camera-with-a-model-file.md)
-- <span class="badge text-bg-info">Updated</span> [Material slots](graphics/materials/material-slots.md)
+- <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 
 
 ## Improve this documentation