Merge pull request #205 from stride3d/master

Initiating deployment of latest docs updates to staging
stride3d · Nov 25, 2023 · 4b02e98 · 4b02e98
2 parents b0a48c6 + a6809f8
commit 4b02e98
Show file tree

Hide file tree

Showing 14 changed files with 602 additions and 283 deletions.
diff --git a/.github/workflows/stride-docs-release-azure.yml b/.github/workflows/stride-docs-release-azure.yml
@@ -49,7 +49,7 @@ jobs:
       # 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.71.0
+      run: dotnet tool update -g docfx --version 2.74.0
 
     - name: Build documentation
       run: ./build-all.bat

diff --git a/.github/workflows/stride-docs-release-fast-track-azure.yml b/.github/workflows/stride-docs-release-fast-track-azure.yml
@@ -42,7 +42,7 @@ jobs:
       # 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.71.0
+      run: dotnet tool update -g docfx --version 2.74.0
 
     - name: Build documentation
       run: ./build-all.bat

diff --git a/.github/workflows/stride-docs-staging-azure.yml b/.github/workflows/stride-docs-staging-azure.yml
@@ -49,7 +49,7 @@ jobs:
       # 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.71.0
+      run: dotnet tool update -g docfx --version 2.74.0
 
     - name: Build documentation
       run: ./build-all.bat

diff --git a/.github/workflows/stride-docs-staging-fast-track-azure.yml b/.github/workflows/stride-docs-staging-fast-track-azure.yml
@@ -42,7 +42,7 @@ jobs:
       # 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.71.0
+      run: dotnet tool update -g docfx --version 2.74.0
 
     - name: Build documentation
       run: ./build-all.bat

diff --git a/BuildDocs.ps1 b/BuildDocs.ps1
@@ -189,6 +189,9 @@ function Build-EnglishDoc {
     # Output to both build.log and console
     docfx build en/docfx.json -o $outputDirectory | Write-Host
 
+    # Build pdf files
+    docfx pdf en/docfx.json -o $outputDirectory | Write-Host
+
     return $LastExitCode
 }
 

diff --git a/en/contributors/documentation/index.md b/en/contributors/documentation/index.md
@@ -36,7 +36,11 @@ Assuming the transition is from version `4.1` to `4.2`, and that the Stride sour
 1. For GitHub Actions deployment update `*.yml` files in the `.github\workflows\` folder
    - `dotnet-version:` Update to the related .NET version
 
-The `BuildDocs.ps1` script will manage the deployment to the `4.2` folder while maintaining accessibility to previous versions.
+The `BuildDocs.ps1` script will manage the deployment to the `4.2` folder while maintaining accessibility to previous versions. Note, that the deployment profile must be set to not delete existing items.
+
+### Other locations to update
+
+1. Update [README.md](https://github.com/stride3d/stride/blob/master/README.md) in the Stride repo, Building from source - Prerequisites section, bump .NET version
 
 ## Table of Contents
 
@@ -82,4 +86,4 @@ The `BuildDocs.ps1` script will manage the deployment to the `4.2` folder while
 - [Troubleshooting and FAQ](troubleshooting-and-faq.md)
     - [Known Issues](troubleshooting-and-faq.md#known-issues)
     - [Common Issues and Solutions](troubleshooting-and-faq.md#common-issues-and-solutions)
-    - [Frequently Asked Questions](troubleshooting-and-faq.md#frequently-asked-questions)
+    - [Frequently Asked Questions](troubleshooting-and-faq.md#frequently-asked-questions)
diff --git a/en/contributors/toc.yml b/en/contributors/toc.yml
@@ -1,3 +1,6 @@
+pdf: true
+pdfFileName: contributing-in-stride.pdf
+items:
 - name: 🌟 Ways to Contribute
   href: ways-to-contribute.md
   expanded: true

diff --git a/en/docfx.json b/en/docfx.json
@@ -97,8 +97,6 @@
       },
       {
         "files": [
-          "articles/**.md",
-          "articles/**/toc.yml",
           "toc.yml",
           "*.md"
         ]

diff --git a/en/index.md b/en/index.md
@@ -50,5 +50,13 @@ Welcome to the Stride documentation, specifically designed for game developers,
     </div>
 </div>
 
+## 📥 Download PDF Versions
+
+You can download PDF versions of various Stride documentation sections:
+
+- [Stride Manual](manual/stride-manual.pdf): (File size: 82MB)
+- [Stride Tutorials](tutorials/stride-tutorials.pdf): (File size: 13MB)
+- [Contributing to Stride](contributors/contributing-in-stride.pdf): (File size: 8MB)
+
 > [!NOTE]
 > Please note that while our English documentation is actively updated, translations may not always be current. We recommend English-literate users to refer to the original for the latest information. To help with translations or report discrepancies, please see our GitHub or community forums. Your input is invaluable!
diff --git a/en/manual/toc.md b/en/manual/toc.md