Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initiating deployment of latest docs updates to staging #268

Merged
merged 12 commits into from
Apr 10, 2024
2 changes: 1 addition & 1 deletion .github/workflows/stride-docs-github.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
lfs: true

- name: Install DocFX
run: dotnet tool update -g docfx --version 2.75.2
run: dotnet tool update -g docfx --version 2.76.0

- name: Build documentation
run: ./build-all.bat
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stride-docs-release-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.75.2
run: dotnet tool update -g docfx --version 2.76.0

- name: Build documentation
run: ./build-all.bat
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stride-docs-release-fast-track-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.75.2
run: dotnet tool update -g docfx --version 2.76.0

- name: Build documentation
run: ./build-all.bat
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stride-docs-staging-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.75.2
run: dotnet tool update -g docfx --version 2.76.0

- name: Build documentation
run: ./build-all.bat
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/stride-docs-staging-fast-track-azure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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.75.2
run: dotnet tool update -g docfx --version 2.76.0

- name: Build documentation
run: ./build-all.bat
Expand Down
2 changes: 1 addition & 1 deletion en/ReleaseNotes/ReleaseNotes-4.0.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Stride 4.0 Release Notes
# Stride 4.0 Release notes

February 1st, 2021

Expand Down
2 changes: 1 addition & 1 deletion en/ReleaseNotes/ReleaseNotes-4.1.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Stride 4.1 Release Notes
# Stride 4.1 Release notes

July 16th, 2022

Expand Down
2 changes: 1 addition & 1 deletion en/ReleaseNotes/ReleaseNotes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Stride 4.2 Release Notes
# Stride 4.2 Release notes

February 6th, 2024

Expand Down
2 changes: 1 addition & 1 deletion en/ReleaseNotes/ReleaseNotesNext.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Stride Release Notes
# Stride Release notes

February 6th, 2024

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,6 @@ Example of a generated PR titles. Note the different prefixes for generic and St
- fix: Fixes inconsistent box2D collision, see #1707 and #2019
- feat: Add ray test flags

### Squashing
## Squashing

When merging a pull request, the Stride team might squash the commits into a single commit. This is to keep the git history clean and to make it easier to understand the changes that were made in the future.
9 changes: 7 additions & 2 deletions en/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -68,9 +68,14 @@
"_appTitle": {
"tutorials/**/*.md": "Stride Tutorials",
"manual/**/*.md": "Stride Manual",
"ReleaseNotes/**/*.md": "Stride Release Notes",
"ReleaseNotes/**/*.md": "Stride Release notes",
"api/**/*.md": "Stride API",
"diagnostics/**/*.md": "Stride Diagnostics"
"diagnostics/**/*.md": "Stride Diagnostics",
"contributors/**/*.md": "Stride Contributors",
"community-resources/**/*.md": "Stride Community resources"
},
"_disableToc": {
"index.md": false
}
},
"sitemap": {
Expand Down
10 changes: 5 additions & 5 deletions en/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Welcome to the Stride documentation, specifically designed for game developers,
<h2 class="card-title h5">📚 Manual</h2>
<p class="card-text">Discover how to build projects and complete tasks in Stride with our manual-related step-by-step tutorials.</p>
</div>
<p class="px-3 mb-4"><a class="stretched-link" href="manual/index.md">Access our Stride Manual</a></p>
<p class="px-3 mb-4"><a class="stretched-link" href="manual/index.md">Access our Stride manual</a></p>
</div>
</div>
<div class="col-md-6">
Expand All @@ -18,16 +18,16 @@ Welcome to the Stride documentation, specifically designed for game developers,
<h2 class="card-title h5">🎓 Tutorials</h2>
<p class="card-text">Explore a range of tutorials for the Stride game engine. Our current tutorials include: <a href="tutorials/gamestudio/index.md">Game Studio</a>, <a href="tutorials/csharpbeginner/index.md">C# Beginner</a> and <a href="tutorials/csharpintermediate/index.md">C# Intermediate</a>.</p>
</div>
<p class="px-3 mb-4"><a class="" href="tutorials/index.md">Browse Stride Tutorials</a></p>
<p class="px-3 mb-4"><a class="" href="tutorials/index.md">Browse Stride tutorials</a></p>
</div>
</div>
<div class="col-md-6">
<div class="card h-100">
<div class="card-body">
<h2 class="card-title h5">📝 Release Notes</h2>
<h2 class="card-title h5">📝 Release notes</h2>
<p class="card-text">Learn about the latest features and improvements in Stride, as well as previous versions.</p>
</div>
<p class="px-3 mb-4"><a class="stretched-link" href="ReleaseNotes/index.md">Find Stride Release Notes</a></p>
<p class="px-3 mb-4"><a class="stretched-link" href="ReleaseNotes/index.md">Find Stride Release notes</a></p>
</div>
</div>
<div class="col-md-6">
Expand All @@ -54,7 +54,7 @@ Welcome to the Stride documentation, specifically designed for game developers,
<h2 class="card-title h5">🔍 Diagnostics</h2>
<p class="card-text">In the world of game development, unexpected behavior is a common challenge. Stride's diagnostic tools are designed to help you quickly and effectively diagnose and resolve these issues.</p>
</div>
<p class="px-3 mb-4"><a class="stretched-link" href="diagnostics/index.md">Explore Diagnostics</a></p>
<p class="px-3 mb-4"><a class="stretched-link" href="diagnostics/index.md">Explore diagnostics</a></p>
</div>
</div>
<div class="col-md-6">
Expand Down
5 changes: 4 additions & 1 deletion en/manual/graphics/effects-and-shaders/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ Stride shaders are converted automatically to the target graphics platform — e

For mobile platforms, shaders are optimized by a GLSL optimizer to improve performance.

> [!NOTE]
> Converting to OpenGL Compute shaders are not supported in SDSL yet.

## In this section

* [Effect language](effect-language.md)
Expand All @@ -39,4 +42,4 @@ For mobile platforms, shaders are optimized by a GLSL optimizer to improve perfo
- [Compile shaders](compile-shaders.md)
- [Templates](shading-language/templates.md)
- [Shader stage input/output automatic management](shading-language/automatic-shader-stage-input-output.md)
* [Custom shaders](custom-shaders.md)
* [Custom shaders](custom-shaders.md)
18 changes: 18 additions & 0 deletions en/manual/platforms/linux/setup-and-requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,12 @@ sudo apt-get install libfreetype6-dev
sudo dnf install freetype-devel
```

### [Arch](#tab/freetype-arch)

```bash
sudo pacman -S freetype2
```

---

## OpenAL
Expand All @@ -49,6 +55,12 @@ sudo apt-get install libopenal-dev
sudo dnf install openal-soft-devel
```

### [Arch](#tab/openal-arch)

```bash
sudo pacman -S openal
```

---

## SDL2
Expand All @@ -67,6 +79,12 @@ sudo apt-get install libsdl2-dev
sudo dnf install SDL2-devel
```

### [Arch](#tab/sdl2-arch)

```bash
sudo pacman -S sdl2
```

---

## .NET Core
Expand Down
4 changes: 2 additions & 2 deletions en/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
# href: tutorials/csharpbeginner/index.md
# - name: 📈 C# Intermediate
# href: tutorials/csharpintermediate/index.md
- name: 📝 Release Notes
- name: 📝 Release notes
href: ReleaseNotes/ReleaseNotes.md
- name: 🌟 Contributing
href: contributors/
Expand All @@ -23,6 +23,6 @@
# - name: 🔍 Diagnostics
# href: diagnostics/
# homepage: diagnostics/index.md
- name: 🏋🏽 Community Resources
- name: 🏋🏽 Community resources
href: community-resources/
homepage: community-resources/index.md