Skip to content

Commit ddead11

Browse files
VaclavEliasEiderenwiselencave
authored
Deploy latest documentation updates to production (#420)
* feat: Release notes updated with new links * feat: custom-assets, cover cloning behavior and control, document attribute purpose * Update toc.yml - Typo corrected * Update create-a-model-from-code.md Invalid code in the procedural material creation section. Link stride3d/stride#2437 * docs: Update rendering-and-camera.md * chore: doxfx bumped * docs: Documentation updates and improvements (#417) * chore: August release link added * chore: Visual studio instructions separated to a new file * feat: New error message added * fix: Grammar corrected * feat: Docs improvements * docs: Content improvements * ci: stride-docs-release-azure.yml - Update permissions - Added a new `permissions` section with `contents` set to `write`, required for creating releases and tags. * fix: Minor styling corrections (#419) * Update heading level for troubleshooting instructions * Clean up blank lines in building-source-windows-other-ide.md --------- Co-authored-by: Eideren <contact@eideren.com> Co-authored-by: wiselen <123637620+wiselencave@users.noreply.github.com>
1 parent 134919e commit ddead11

19 files changed

Lines changed: 157 additions & 53 deletions

.github/workflows/common-setup.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ jobs:
4646
# This installs the latest version of DocFX and may introduce breaking changes
4747
# run: dotnet tool update -g docfx
4848
# This installs a specific, tested version of DocFX.
49-
run: dotnet tool update -g docfx --version 2.76.0
49+
run: dotnet tool update -g docfx --version 2.78.3

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ jobs:
4747
# This installs the latest version of DocFX and may introduce breaking changes
4848
# run: dotnet tool update -g docfx
4949
# This installs a specific, tested version of DocFX.
50-
run: dotnet tool update -g docfx --version 2.77.0
50+
run: dotnet tool update -g docfx --version 2.78.3
5151

5252
- name: Build documentation
5353
run: ./build-all.bat

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33

44
name: Build Stride Docs for Azure Web App Release 🚀
55

6+
permissions:
7+
contents: write # required to create releases/tags
8+
69
env:
710
COMMON_SETTINGS_PATH: en/docfx.json
811
VERSION: "2.0.0.${{ github.run_number }}"
@@ -60,7 +63,7 @@ jobs:
6063
# This installs the latest version of DocFX and may introduce breaking changes
6164
# run: dotnet tool update -g docfx
6265
# This installs a specific, tested version of DocFX.
63-
run: dotnet tool update -g docfx --version 2.77.0
66+
run: dotnet tool update -g docfx --version 2.78.3
6467

6568
- name: Build documentation
6669
run: ./build-all.bat

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ jobs:
5454
# This installs the latest version of DocFX and may introduce breaking changes
5555
# run: dotnet tool update -g docfx
5656
# This installs a specific, tested version of DocFX.
57-
run: dotnet tool update -g docfx --version 2.77.0
57+
run: dotnet tool update -g docfx --version 2.78.3
5858

5959
- name: Build documentation
6060
run: ./build-all.bat

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ jobs:
6969
# This installs the latest version of DocFX and may introduce breaking changes
7070
# run: dotnet tool update -g docfx
7171
# This installs a specific, tested version of DocFX.
72-
run: dotnet tool update -g docfx --version 2.77.0
72+
run: dotnet tool update -g docfx --version 2.78.3
7373

7474
- name: Build documentation
7575
run: ./build-all.bat

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ jobs:
5454
# This installs the latest version of DocFX and may introduce breaking changes
5555
# run: dotnet tool update -g docfx
5656
# This installs a specific, tested version of DocFX.
57-
run: dotnet tool update -g docfx --version 2.77.0
57+
run: dotnet tool update -g docfx --version 2.78.3
5858

5959
- name: Build documentation
6060
run: ./build-all.bat

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ jobs:
5757
# This installs the latest version of DocFX and may introduce breaking changes
5858
# run: dotnet tool update -g docfx
5959
# This installs a specific, tested version of DocFX.
60-
run: dotnet tool update -g docfx --version 2.77.0
60+
run: dotnet tool update -g docfx --version 2.78.3
6161

6262
- name: Build documentation
6363
run: ./build-all.bat

en/ReleaseNotes/ReleaseNotes.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,11 @@ Read the full blog post here: [Announcing Stride 4.2](https://www.stride3d.net/b
88

99
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.
1010

11-
## Minor releases since the last major release
11+
## Other releases since the last major release
1212

13+
- [4.2.1.2442](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.1.2442): August 2025
14+
- [4.2.0.2381](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.0.2381): March 2025
15+
- [4.2.0.2374](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.0.2374): February 2025
1316
- [4.2.0.2293](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.0.2293): January 2025
1417
- [4.2.0.2282](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.0.2282): December 2024
1518
- [4.2.0.2232](https://github.com/stride3d/stride/releases/tag/releases%2F4.2.0.2232): September 2024

en/community-resources/rendering-and-camera.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@
3131
- [StrideCameraController](https://github.com/herocrab/StrideCameraController) - Swapping Cameras/Resident Evil Style
3232
- [CameraFollow.cs](https://gist.github.com/ykafia/371b310de1ba7bb8ab3d2feffce2a190)
3333
- [SplitScreen](https://github.com/profan/XenkoByteSized#xenkobytesizedsplitscreen)
34-
34+
- [Multiple Cameras in the scene](https://www.youtube.com/watch?v=_qUhcn9i_yw)
Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
11
# Build Stride without Visual Studio
22

3-
1. Install [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe) with the same prerequisites listed [here](building-source-windows.md)
4-
2. Add MSBuild's directory to your system's *PATH* (ex: `C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\MSBuild\Current\Bin`)
5-
3. Open a command prompt, point it to a directory and clone Stride to it: `git lfs clone https://github.com/stride3d/stride.git`
6-
4. Navigate to `/Build` with the command prompt, input `msbuild /t:Restore Stride.sln` then `compile.bat`
3+
1. **Install** [Visual Studio Build Tools](https://aka.ms/vs/17/release/vs_BuildTools.exe) with the same prerequisites listed above.
4+
2. **Add MSBuild to your system's PATH:**
5+
- Add MSBuild's directory to your `PATH` environment variable (e.g., `C:\Program Files (x86)\Microsoft Visual Studio\2022\BuildTools\MSBuild\Current\Bin`).
6+
3. **Clone the repository:**
7+
```bash
8+
git lfs clone https://github.com/stride3d/stride.git
9+
```
10+
4. **Build using the command line:**
11+
- Navigate to the `/build` directory in the command prompt and run:
12+
```bash
13+
msbuild /t:Restore Stride.sln
14+
```
15+
- Then run:
16+
```bash
17+
compile.bat
18+
```
719

820
## Build Stride with Rider
9-
With Rider 2024.1 and after [commit 0e053a3](https://github.com/stride3d/stride/commit/0e053a3b8873f49e9e0e5450a3dfad368a6ed042) Stride can now be built hassle free from Rider, you just have to make sure that `Use ReSharper Build` is enabled in your settings.
21+
22+
With Rider 2025.2 and after [commit 0e053a3](https://github.com/stride3d/stride/commit/0e053a3b8873f49e9e0e5450a3dfad368a6ed042) Stride can now be built hassle free from Rider, you just have to make sure that `Use ReSharper Build` is enabled in your settings.
1023

1124
![image](https://github.com/stride3d/stride-docs/assets/5742236/9ce4e30d-0d6b-4a56-844d-313a826742bf)
1225

1326
### Hot Reload
27+
1428
To hot reload your changes, you can either pause and continue the program or click the hot reload button at the top of the text editor when it appears.
1529

1630
![image](https://user-images.githubusercontent.com/5742236/147461531-05af59f7-fedf-44a2-b4ee-d1aa25502210.png)

0 commit comments

Comments
 (0)