Merge pull request #140 from stride3d/master

Testing recent updates in staging

.github/workflows/stride-docs-release-azure.yml

@@ -0,0 +1,90 @@
+# 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 for Azure Web App Release 🚀
+
+on:
+  push:
+    branches:
+      - release
+    paths-ignore:
+      - 'README.md'
+      - 'Stride.Docs.sln'
+      - 'BuildDocs.ps1'
+      - 'wiki/**'
+      - .gitignore
+      - '.github/**'
+  workflow_dispatch:
+
+jobs:
+  build:
+    if: github.repository == 'stride3d/stride-docs'
+    runs-on: windows-2022
+
+    steps:
+    - name: Dotnet Setup
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: 6.x
+
+    - name: Checkout Stride Docs
+      uses: actions/checkout@v3
+      with:
+        path: stride-docs
+        lfs: true
+
+    - name: Checkout Stride (note the LFS)
+      uses: actions/checkout@v3
+      with:
+        repository: stride3d/stride
+        token: ${{ secrets.GITHUB_TOKEN }}
+        path: stride
+        lfs: true
+
+    - 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.70.3
+
+    - name: Build documentation
+      run: ./build-all.bat
+      working-directory: stride-docs
+
+    - name: Compress artifact
+      run: 7z a -r DocFX-app.zip ./stride-docs/_site/*
+
+    - name: Upload artifact for deployment job
+      uses: actions/upload-artifact@v3
+      with:
+        name: DocFX-app
+        path: DocFX-app.zip
+
+  deploy:
+    if: github.repository == 'stride3d/stride-docs'
+    runs-on: windows-2022
+    needs: build
+    environment:
+      name: 'Production'
+      url: ${{ steps.deploy-to-webapp.outputs.webapp-url }}
+
+    steps:
+      - name: Download artifact from build job
+        uses: actions/download-artifact@v3
+        with:
+          name: DocFX-app
+
+      # - name: List current directory
+      #   run: ls
+
+      - name: Decompress artifact
+        run: 7z x DocFX-app.zip "-o./stride-docs/_site"
+
+      - name: Deploy to Azure Web App
+        id: deploy-to-webapp
+        uses: azure/webapps-deploy@v2
+        with:
+          app-name: 'stride-doc'
+          slot-name: 'Production'
+          publish-profile: ${{ secrets.AZUREAPPSERVICE_PUBLISHPROFILE_4803638D673FA67D0C8650F34C4FA9D1 }}
+          package: ./stride-docs/_site

BuildDocs.ps1

@@ -6,9 +6,9 @@
 .NOTES
     The documentation files are expected to be in Markdown format (.md). The script uses the DocFX tool to build the documentation and optionally includes API documentation. The script generates the API documentation from C# source files using DocFX metadata and can run a local website using the DocFX serve command. This script can also be run from GitHub Actions.
 .LINK
-    https://github.com/VaclavElias/stride-website-next
+    https://github.com/stride3d/stride-docs
 .LINK
-    https://github.com/VaclavElias/stride-docs-next/blob/main/en/languages.json
+    https://github.com/stride3d/stride-docs/blob/master/en/languages.json
 .LINK
     https://dotnet.github.io/docfx/index.html
 .PARAMETER BuildAll

README.md

@@ -10,7 +10,7 @@ Welcome to the Stride Docs repository. This repository contains all the source f
 
 ## 🚀 Getting Started
 
-All the information you need to get started with Stride Docs development can be found in the 📚 [Stride Docs Wiki](https://github.com/VaclavElias/stride-docs-next/wiki).
+All the information you need to get started with Stride Docs development can be found in the 📚 [Stride Docs Wiki](https://github.com/stride3d/stride-docs/wiki).
 
 ## 🤝 Contributing
 
@@ -35,7 +35,7 @@ The staging website is available at https://stride-docs-staging.azurewebsites.ne
 
 ## 🗺️ Roadmap
 
-Our Wiki [Roadmap](https://github.com/VaclavElias/stride-docs-next/wiki/Roadmap) communicates upcoming changes to the Stride Docs.
+Our Wiki [Roadmap](https://github.com/stride3d/stride-docs/wiki/Roadmap) communicates upcoming changes to the Stride Docs.
 
 ## 🌐 .NET Foundation
 

en/diagnostics/strd001.md

@@ -1,6 +1,6 @@
 # Diagnostics Warning STRD001
 
-The Property `Array` has an invalid Access Type for an Array, expected for Arrays is public/internal get, Accessor, Stride will..
+An Array must have a public/internal getter for Serialization.
 
 ## Example
 
@@ -50,5 +50,5 @@ The `break` statement cannot be reached because it occurs after the `return` sta
 
 ## See also
 
-[C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
-[C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/strd002.md

@@ -0,0 +1,54 @@
+# Diagnostics Warning STRD002
+
+A collection must have a public/internal getter for Serialization.
+
+## Example
+
+The following example generates STRD001:
+
+```csharp
+// STRD001.cs
+// compile with: /W:2
+public class Program
+{
+    public static void Main()
+    {
+        goto lab1;
+        {
+            // The following statements cannot be reached:
+            int i = 9;   // STRD001
+            i++;
+        }
+    lab1:
+        {
+        }
+    }
+}
+
+```
+
+Another common example where this error is generated is as follows:
+
+```csharp
+public static class Class1
+{
+    public static string Method1()
+    {
+        string x = "a";
+        switch (x)
+        {
+            case "a":
+                return "a";
+                break;          // CS0162
+        }
+        return "";
+    }
+}
+```
+
+The `break` statement cannot be reached because it occurs after the `return` statement. The `return` statement ends the enclosing `case` branch.
+
+## See also
+
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/strd003.md

@@ -0,0 +1,56 @@
+# Diagnostics Warning STRD003
+
+- A property must have a public/internal getter.
+- A property must be set during instantiation, then no public setter would be valid.
+- Or it must have a public setter else.
+
+## Example
+
+The following example generates STRD001:
+
+```csharp
+// STRD001.cs
+// compile with: /W:2
+public class Program
+{
+    public static void Main()
+    {
+        goto lab1;
+        {
+            // The following statements cannot be reached:
+            int i = 9;   // STRD001
+            i++;
+        }
+    lab1:
+        {
+        }
+    }
+}
+
+```
+
+Another common example where this error is generated is as follows:
+
+```csharp
+public static class Class1
+{
+    public static string Method1()
+    {
+        string x = "a";
+        switch (x)
+        {
+            case "a":
+                return "a";
+                break;          // CS0162
+        }
+        return "";
+    }
+}
+```
+
+The `break` statement cannot be reached because it occurs after the `return` statement. The `return` statement ends the enclosing `case` branch.
+
+## See also
+
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/strd004.md

@@ -0,0 +1,54 @@
+# Diagnostics Warning STRD004
+
+For <see cref="System.Collections.Generic.Dictionary{TKey, TValue}"/> the only valid Keys are primitive Types. All complex types like custom structs, objects are not allowed.
+
+## Example
+
+The following example generates STRD001:
+
+```csharp
+// STRD001.cs
+// compile with: /W:2
+public class Program
+{
+    public static void Main()
+    {
+        goto lab1;
+        {
+            // The following statements cannot be reached:
+            int i = 9;   // STRD001
+            i++;
+        }
+    lab1:
+        {
+        }
+    }
+}
+
+```
+
+Another common example where this error is generated is as follows:
+
+```csharp
+public static class Class1
+{
+    public static string Method1()
+    {
+        string x = "a";
+        switch (x)
+        {
+            case "a":
+                return "a";
+                break;          // CS0162
+        }
+        return "";
+    }
+}
+```
+
+The `break` statement cannot be reached because it occurs after the `return` statement. The `return` statement ends the enclosing `case` branch.
+
+## See also
+
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/strd007.md

@@ -0,0 +1,54 @@
+# Diagnostics Warning STRD007
+
+It's invalid to DataMember a private property. Also its invalid to DataMember a property which has DataMemberIgnore.
+
+## Example
+
+The following example generates STRD001:
+
+```csharp
+// STRD001.cs
+// compile with: /W:2
+public class Program
+{
+    public static void Main()
+    {
+        goto lab1;
+        {
+            // The following statements cannot be reached:
+            int i = 9;   // STRD001
+            i++;
+        }
+    lab1:
+        {
+        }
+    }
+}
+
+```
+
+Another common example where this error is generated is as follows:
+
+```csharp
+public static class Class1
+{
+    public static string Method1()
+    {
+        string x = "a";
+        switch (x)
+        {
+            case "a":
+                return "a";
+                break;          // CS0162
+        }
+        return "";
+    }
+}
+```
+
+The `break` statement cannot be reached because it occurs after the `return` statement. The `return` statement ends the enclosing `case` branch.
+
+## See also
+
+- [C# Compiler Options](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-options/)
+- [C# Compiler Errors](https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/compiler-messages/)

en/diagnostics/toc.md

@@ -1,3 +1,7 @@
 # [Diagnostics](index.md)
 
-# [STRD001](strd001.md)
+# [STRD001](strd001.md)
+# [STRD002](strd002.md)
+# [STRD003](strd003.md)
+# [STRD004](strd004.md)
+# [STRD007](strd007.md)

en/docfx.json

@@ -57,7 +57,11 @@
       "_appTitle": "Stride Docs",
       "_enableSearch": true,
       "_appLogoPath": "media/stride-logo-red.svg",
-      "_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1 text-center small\"><p >Supported by the <a href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></p><p >Stride Docs Website v.2.0.0.5</p><p>&copy; .NET Foundation and Contributors</p></div>"
+      "_appFooter": "<div class=\"d-flex flex-column flex-sm-row justify-content-between pt-1 text-center small\"><p >Supported by the <a href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a href=\"https://dotnet.github.io/docfx\">docfx</a></p><p >Stride Docs Website v.2.0.0.5</p><p>&copy; .NET Foundation and Contributors</p></div>",
+      "_gitContribute": {
+        "repo": "https://github.com/stride3d/stride-docs",
+        "branch": "master"
+      }
     },
     "fileMetadata": {
       "_appTitle": {