Merge pull request #113 from VaclavElias/update-1

Update 1 - Improvements

.github/workflows/github-pages.yml

@@ -1,52 +0,0 @@
-name: Build Stride Docs - Staging - GitHub
-on:
-  # push:
-  #   branches:
-  #     - main
-  #   paths-ignore:
-  #     - 'README.md'
-  #     - 'BuildDocs.ps1'
-  #     - 'wiki/**'
-  #     - '.github/**'
-  workflow_dispatch:
-
-jobs:
-  publish-docs:
-    runs-on: windows-2022
-    steps:
-    #- name: Display .NET Core information
-    #  run: dotnet --info
-
-    - 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
-
-    - name: Checkout Stride (note the LFS)
-      uses: actions/checkout@v3
-      with:
-        repository: stride3d/stride
-        token: ${{ secrets.GITHUB_TOKEN }}
-        path: stride
-        lfs: true
-
-    # - name: Copy global.json file
-    #   run: xcopy stride-docs\global.json . /Y
-
-    - run: dotnet tool update -g docfx
-#    - run: dotnet tool install -g docfx --version 2.65.1
-
-    - name: Build documentation
-      run: ./build-all.bat
-      working-directory: stride-docs
-
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3
-      with:
-        github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: stride-docs/_site

.github/workflows/main-folder-check.yml

@@ -1,11 +0,0 @@
-name: Paths check
-on:
-  workflow_dispatch:
-
-jobs:
-  publish-docs:
-    runs-on: windows-2022
-    steps:
-      - name: Check .NET Framework version
-        run: |
-          reg query "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\NET Framework Setup\NDP" /s | findstr /i version

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

@@ -9,6 +9,7 @@ on:
       - staging
     paths-ignore:
       - 'README.md'
+      - 'Stride.Docs.sln'
       - 'BuildDocs.ps1'
       - 'wiki/**'
       - .gitignore
@@ -40,8 +41,10 @@ jobs:
         lfs: true
 
     - name: Install DocFX
-      run: dotnet tool update -g docfx
-#      - run: dotnet tool install -g docfx --version 2.65.1
+      # 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.1
 
     - name: Build documentation
       run: ./build-all.bat

.github/workflows/stride-docs-staging-fast-track-azure.yml

@@ -9,6 +9,7 @@ on:
   #     - main
   #   paths-ignore:
   #     - 'README.md'
+  #     - 'Stride.Docs.sln'
   #     - 'BuildDocs.ps1'
   #     - 'wiki/**'
   #     - .gitignore
@@ -42,8 +43,10 @@ jobs:
         lfs: true
 
     - name: Install DocFX
-      run: dotnet tool update -g docfx
-#      - run: dotnet tool install -g docfx --version 2.65.1
+      # 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.1
 
     - name: Build documentation
       run: ./build-all.bat

.github/workflows/stride-docs-wiki.yml

@@ -2,14 +2,14 @@ name: Publish to GitHub Wiki
 on:
   push:
     branches:
-      - main
+      - staging
     paths:
       - wiki/**
   workflow_dispatch:
 
 jobs:
   build:
-    # if: github.repository == 'stride3d/stride-docs'
+    if: github.repository == 'stride3d/stride-docs'
     runs-on: ubuntu-latest
 
     steps:
@@ -20,6 +20,6 @@ jobs:
          GH_PAT: ${{ secrets.GH_PAT }}
          ACTION_MAIL: [email protected]
          ACTION_NAME: VaclavElias
-         OWNER: VaclavElias
-         REPO_NAME: stride-docs-next
-         MD_FOLDER: wiki
+         OWNER: stride3d
+         REPO_NAME: stride-docs
+         MD_FOLDER: wiki

Stride.Docs.sln

@@ -7,8 +7,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Stride.Docs", "Stride.Docs.
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{85103FBF-C9A6-4722-B36B-89A58F55C1DF}"
 	ProjectSection(SolutionItems) = preProject
-		.github\workflows\github-pages.yml = .github\workflows\github-pages.yml
-		.github\workflows\main-folder-check.yml = .github\workflows\main-folder-check.yml
 		.github\workflows\stride-docs-staging-azure.yml = .github\workflows\stride-docs-staging-azure.yml
 		.github\workflows\stride-docs-staging-fast-track-azure.yml = .github\workflows\stride-docs-staging-fast-track-azure.yml
 		.github\workflows\stride-docs-wiki.yml = .github\workflows\stride-docs-wiki.yml

en/docfx.json

@@ -57,7 +57,7 @@
       "_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 class=\"\">Supported by the <a class=\"link-danger\" href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a class=\"link-danger\" href=\"https://dotnet.github.io/docfx\">docfx</a></p><p class=\"\">Stride Docs Website v.2.0.0.1</p><p class=\"\">© .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 class=\"link-danger\" href=\"https://dotnetfoundation.org/\" target=\"_blank\" rel=\"noopener\">.NET Foundation</a></p><p>Made with <a class=\"link-danger\" href=\"https://dotnet.github.io/docfx\">docfx</a></p><p >Stride Docs Website v.2.0.0.2</p><p>&copy; .NET Foundation and Contributors</p></div>"
     },
     "fileMetadata": {
       "_appTitle": {

wiki/Installation.md

@@ -57,6 +57,13 @@ Install a specific version of docfx
 dotnet tool update -g docfx --version 2.67.0
 ```
 
+Uninstall docfx if you need to downgrade
+
+
+```
+dotnet tool uninstall -g docfx
+```
+
 # Running the Development Server
 
 We've created a PowerShell script [BuildDocs.ps1](https://github.com/VaclavElias/stride-docs-next/blob/main/BuildDocs.ps1) with a context menu where you can select the language, include the API build, and run the development server.