Skip to content

Commit 07ea377

Browse files
committed
lots of broken links restored
1 parent 79e79eb commit 07ea377

21 files changed

+51
-72
lines changed

en/contributors/documentation/content.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
If you want to contribute and update the website, please follow the instructions below.
2121

22-
Small updates can be done directly in the GitHub web interface, for bigger updates the local development environment is required, which is described in the [Installation](Installation) section.
22+
Small updates can be done directly in the GitHub web interface, for bigger updates the local development environment is required, which is described in the [Installation](installation.md) section.
2323

2424
You can use any text editor to make changes. If you are using **Visual Studio**, you can open `Stride.Docs.sln` solution file in the root of the repository and start making your updates directly from this IDE.
2525

@@ -60,7 +60,7 @@ We can define bigger updates as changes to the design of the website, where you
6060
- Update docfx version
6161
- Update layouts
6262

63-
You would start with the local development environment, which is described in the [Installation](Installation) section.
63+
You would start with the local development environment, which is described in the [Installation](installation.md) section.
6464

6565
Then you would make your changes and test them locally. Once you are happy with the result, you can create a pull request to merge your changes into the `master` branch.
6666

en/contributors/documentation/deployment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The `web.config` file is used to configure IIS, including:
4646

4747
The GitHub action `stride-website-staging-azure` builds the website and deploys it to Azure Web Apps.
4848

49-
[Step-by-Step Deployment Guide for Azure Web Apps (Windows) with IIS and Stride Website](Deployment-Azure).
49+
[Step-by-Step Deployment Guide for Azure Web Apps (Windows) with IIS and Stride Website](deployment-azure.md).
5050

5151
**Recommendation**
5252

en/contributors/documentation/docfx.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# DocFX
2-
[docfx](https://www.11ty.dev/) is a static site generator that uses JavaScript as its templating language. It is a very powerful tool that allows us to create a website with a lot of flexibility and customization. It is also very easy to use and learn. This section will cover the basics of Eleventy configuration on the Stride website. Creating and updating the content is described in our [Content](Content) section.
2+
[docfx](https://www.11ty.dev/) is a static site generator that uses JavaScript as its templating language. It is a very powerful tool that allows us to create a website with a lot of flexibility and customization. It is also very easy to use and learn. This section will cover the basics of Eleventy configuration on the Stride website. Creating and updating the content is described in our [Content](content.md) section.
33

44
We used to use **Jekyll** as our static site generator, but we decided to switch to Eleventy because of its flexibility and ease of use. We also wanted to use a tool that is more widely used and supported, which is why we decided to switch to Eleventy.
55

@@ -14,7 +14,7 @@ We used to use **Jekyll** as our static site generator, but we decided to switch
1414
- [Creating Custom Shortcodes and Includes](#creating-custom-shortcodes-and-includes)
1515

1616
# Packages and Dependencies
17-
Eleventy is a **Node.js** application. Please follow our [Installation](Installation) guide to install Node.js and all the required dependencies.
17+
Eleventy is a **Node.js** application. Please follow our [installation](installation.md) guide to install Node.js and all the required dependencies.
1818

1919
Packages we currently use:
2020

@@ -40,7 +40,7 @@ The Eleventy configuration is located in the `.eleventy.js` file at the root of
4040
- pass through files - Files that are copied to the output folder without any processing
4141
- custom collections - Custom collections used in the templates like `tagList` and `yearList`
4242
- filters - Custom filters used in the templates
43-
- custom shortcodes - Custom [shortcodes](Content#shortcodes-and-includes) used in the templates, pages or blog posts.
43+
- custom shortcodes - Custom [shortcodes](content.md#shortcodes-and-includes) used in the templates, pages or blog posts.
4444

4545
The file is well-commented and should be self-explanatory. If you need to add a new configuration, please follow the existing structure and include a comment to explain the new configuration.
4646

@@ -107,7 +107,7 @@ The folder structure is crucial for Eleventy, as it determines the output of the
107107
- `web.Release.config` - Configuration file for Windows ASP.NET Core deployment
108108

109109

110-
**Note:** This project includes ASP.NET Core solution and files, as they can be used seamlessly with Eleventy. Read more about this in our [Installation](Installation#asp-net-core) section.
110+
**Note:** This project includes ASP.NET Core solution and files, as they can be used seamlessly with Eleventy. Read more about this in our [Installation](installation.md#asp-net-core.md) section.
111111

112112

113113
# Layouts
@@ -129,7 +129,7 @@ Some includes are used solely by the layouts, while others are used by the conte
129129

130130
## Creating Custom Shortcodes and Includes
131131

132-
If you need to create a custom shortcode or include, please follow the existing structure and [include a comment](Content#shortcodes-and-includes) to explain the new shortcode or include.
132+
If you need to create a custom shortcode or include, please follow the existing structure and [include a comment](content.md#shortcodes-and-includes) to explain the new shortcode or include.
133133

134134
The shortcodes are defined in the `.eleventy.js` file, while the includes are located in the `/_includes` folder.
135135

en/contributors/documentation/index.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Contributing to documentation
22
This documentation serves as a comprehensive guide to help you navigate and contribute to the **Stride Docs** website.
33

4-
If you're looking to make minor changes, such as adding or updating a manual, tutorial or page, or fixing a typo, feel free to jump straight to the [Content Updates](content#content-updates) section.
4+
If you're looking to make minor changes, such as adding or updating a manual, tutorial or page, or fixing a typo, feel free to jump straight to the [Content Updates](content.md#content-updates) section.
55

66
For more extensive updates 🤯🤦‍♂️ or for a deeper understanding of the docs website project, we recommend exploring all the sections provided. Happy browsing and contributing!
77

@@ -46,14 +46,14 @@ Here are the technologies we use to build our website:
4646
- [Adding a New Language](new-language.md#adding-a-new-language)
4747
- [Roadmap](roadmap.md)
4848
- [DocFX](docfx.md)
49-
- [Packages and Dependencies](eleventy.md#packages-and-dependencies)
50-
- [Configuration](eleventy.md#configuration)
51-
- [Global Data](eleventy.md#global-data)
52-
- [Folder Structure](eleventy.md#folder-structure)
53-
- [Layouts](eleventy.md#layouts)
54-
- [Includes](eleventy.md#includes)
55-
- [Advanced Topics](eleventy.md#advanced-topics)
56-
- [Creating Custom Shortcodes and Includes](eleventy.md#creating-custom-shortcodes-and-includes)
49+
- [Packages and Dependencies](docfx.md#packages-and-dependencies)
50+
- [Configuration](docfx.md#configuration)
51+
- [Global Data](docfx.md#global-data)
52+
- [Folder Structure](docfx.md#folder-structure)
53+
- [Layouts](docfx.md#layouts)
54+
- [Includes](docfx.md#includes)
55+
- [Advanced Topics](docfx.md#advanced-topics)
56+
- [Creating Custom Shortcodes and Includes](docfx.md#creating-custom-shortcodes-and-includes)
5757
- [Deployment](deployment.md)
5858
- [GitHub Pages](deployment.md#github-pages)
5959
- [Azure Web Apps](deployment.md#azure-web-apps)

en/contributors/documentation/installation.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Local installation
22
This guide will walk you through the steps to install the Stride Docs website on your local machine for development purposes. Although we use the Windows operating system for development, the steps should be similar for other operating systems.
33

4-
[Minor updates](Content#small-updates) can be made directly on GitHub. However, for [more significant updates](Content#major-updates) that affect multiple pages, we recommend using a local development environment so you can see the impact of your changes beforehand. This is because we use the **docfx** static site generator, and in some cases, all pages need to be regenerated. This approach helps you assess your changes before submitting a pull request.
4+
[Minor updates](content.md#small-updates) can be made directly on GitHub. However, for [more significant updates](content.md#major-updates) that affect multiple pages, we recommend using a local development environment so you can see the impact of your changes beforehand. This is because we use the **docfx** static site generator, and in some cases, all pages need to be regenerated. This approach helps you assess your changes before submitting a pull request.
55

66
This guide assumes you have a basic understanding of the technologies used in the Stride docs website.
77

@@ -90,4 +90,4 @@ We've created a PowerShell script [BuildDocs.ps1](https://github.com/stride3d/st
9090
1. 🔄 After saving the updated file, you will need to rebuild the documentation by running the script again
9191
1. 😃 Happy coding!
9292
93-
Let's [update the content](Content) now!
93+
Let's [update the content](content.md) now!

en/contributors/documentation/troubleshooting-and-faq.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ Any issue should be added to Stride Website [GitHub issues](https://github.com/s
1616

1717
**Q:** I just want to fix a typo in a post. Do I need to follow your installation steps?
1818

19-
**A:** *No, you can fix the typo directly on the GitHub website. However, you will still need to fork the repo, make your update on the main branch or a new branch, and then create a pull request. You can follow this guide for [minor updates](Content#small-updates).*
19+
**A:** *No, you can fix the typo directly on the GitHub website. However, you will still need to fork the repo, make your update on the main branch or a new branch, and then create a pull request. You can follow this guide for [minor updates](content.md#small-updates).*
2020

2121

en/contributors/donate.md

-21
Original file line numberDiff line numberDiff line change
@@ -8,24 +8,3 @@ We gather funding through a website called [OpenCollective](https://opencollecti
88
Stride's Open Collective hosts different '[Projects](https://opencollective.com/stride3d/projects)' — think of them as funding goals for specific features or contributions. Each project typically has a related Github ticket for more details on what's required for its development. If you're interested in working on or contributing to a particular feature, please reply in the thread and mention @stride3d/stride-contributors.
99

1010

11-
## Bug bounties
12-
If you are a developer with experience in C#, rendering techniques, or game development, we want to hire you! We have allocated funds from supporters on [OpenCollective](https://opencollective.com/stride3d) and will pay you for your work on certain issues.
13-
14-
You can find [issues with bounties here](https://github.com/stride3d/stride/labels/bounty)
15-
16-
If you are interested in tackling one of those issues:
17-
- Reply in the thread and tag @stride3d/stride-contributors
18-
- We'll get back to you and reserve that issue to your name.
19-
- You can then create a new pull request and we'll review it.
20-
- Once merged in you will receive 60% of the bounty and the other 40% on the next official release of the engine.
21-
22-
23-
### Payment info
24-
Stride uses the [Open source collective](https://opencollective.com/opensource) as our Fiscal host which approves the payments. They process payouts twice weekly, once they have been approved by the admins of the Collective. They make payments via PayPal and Wise, and can only make payouts to countries served by these payment processors.
25-
26-
You can go to the specific bug bounty on Stride's [Open Collective](https://opencollective.com/stride3d) for payment:
27-
28-
![getting-paid-bounty](https://user-images.githubusercontent.com/3499539/158011382-732c2448-8368-418f-9eae-7713ea7b349d.gif)
29-
30-
31-

en/contributors/engine/architecture/build-details.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Also, we use `RuntimeIdentifiers` to select graphics platform. [MSBuild.Sdk.Extr
1919

2020
Since we want to package tools (i.e. GameStudio, ConnectionRouter, CompilerApp) with a package that contains only the executable with proper dependencies to other NuGet runtime packages, we use NuGet API to resolve assemblies at runtime.
2121

22-
The code responsible for this is located in [Stride.NuGetResolver](../sources/shared/Stride.NuGetResolver).
22+
The code responsible for this is located in [Stride.NuGetResolver](../../../sources/shared/Stride.NuGetResolver).
2323

2424
Later, we might want to take advantage of .NET Core dependency resolving to do that natively. Also, we might want to use actual project information/dependencies to resolve to different runtime assemblies and better support plugins.
2525

@@ -38,12 +38,12 @@ For example, assuming version `4.1.3.135+gfa0f5cc4`:
3838
Assembly processor is run by both Game and Stride targets.
3939

4040
It performs various transforms to the compiled assemblies:
41-
* Generate [DataSerializer](../sources/common/core/Stride.Core/Serialization/DataSerializer.cs) serialization code (and merge it back in assembly using IL-Repack)
42-
* Generate [UpdateEngine](../sources/engine/Stride.Engine/Updater/UpdateEngine.cs) code
41+
* Generate [DataSerializer](../../../../../stride/sources/core/Stride.Core/Serialization/DataSerializer.cs) serialization code (and merge it back in assembly using IL-Repack)
42+
* Generate [UpdateEngine](../../../../../stride/sources/engine/Stride.Engine/Updater/UpdateEngine.cs) code
4343
* Scan for types or attributes with `[ScanAssembly]` to quickly enumerate them without needing `Assembly.GetTypes()`
44-
* Optimize calls to [Stride.Core.Utilities](../sources/common/core/Stride.Core/Utilities.cs)
45-
* Automatically call methods tagged with [ModuleInitializer](../sources/common/core/Stride.Core/ModuleInitializerAttribute.cs)
46-
* Cache lambdas and various other code generation related to [Dispatcher](../sources/common/core/Stride.Core/Threading/Dispatcher.cs)
44+
* Optimize calls to [Stride.Core.Utilities](../../../../../stride/sources/core/Stride.Core/Utilities.cs)
45+
* Automatically call methods tagged with [ModuleInitializer](../../../../../stride/sources/core/Stride.Core/ModuleInitializerAttribute.cs)
46+
* Cache lambdas and various other code generation related to [Dispatcher](../../../../../stride/sources/core/Stride.Core/Threading/Dispatcher.cs)
4747
* A few other internal tasks
4848

4949
For performance reasons, it is run as a MSBuild Task (avoid reload/JIT-ing). If you wish to make it run the executable directly, set `StrideAssemblyProcessorDev` to `true`.
@@ -66,7 +66,7 @@ By adding a reference to `Stride.Native.targets`, it is easy to build some C/C++
6666

6767
### Limitations
6868

69-
It seems that using those optimization don't work well with shadow copying and [probing privatePath](https://msdn.microsoft.com/en-us/library/823z9h8w(v=vs.110).aspx). This forces us to copy the `Direct3D11` specific assemblies to the top level `Windows` folder at startup of some tools. This is little bit unfortunate as it seems to disturb the MSBuild assembly searching (happens before `$(AssemblySearchPaths)`). As a result, inside Stride solution it is necessary to explicitely add `<ProjectReference>` to the graphics specific assemblies otherwise wrong ones might be picked up.
69+
It seems that using those optimization don't work well with shadow copying and [probing privatePath](https://msdn.microsoft.com/en-us/library/823z9h8w(v=vs.110).aspx). This forces us to copy the `Direct3D11` specific assemblies to the top level `Windows` folder at startup of some tools. This is little bit unfortunate as it seems to disturb the MSBuild assembly searching (happens before `$(AssemblySearchPaths)`). As a result, inside Stride solution it is necessary to explicitly add `<ProjectReference>` to the graphics specific assemblies otherwise wrong ones might be picked up.
7070

7171
This will require further investigation to avoid this copying at all.
7272

en/contributors/engine/bug-bounties.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Bug bounties
22
If you are a developer with solid experience in C#, rendering techniques, or game development, we want to hire you! We have allocated funds from supporters on [OpenCollective](https://opencollective.com/stride3d) and will pay you for your work on certain issues.
33

4-
You can find [issues with bounties here](https://github.com/stride3d/stride/labels/bounty). If you see a different bug that you would like to tackle and you want to know if it is eligible for a bug bounty, you are also more than welcome to reach out to the core contributors on [Discord](https://discord.gg/f6aerfE) and [Github Discussion](https://github.com/stride3d/stride/discussions).
4+
You can find [issues with bounties here](https://github.com/stride3d/stride/labels/bounty).
5+
6+
If the issue you want to work on doesn't have a bounty associated to it, feel free to get in touch with us by creating a new issue or adding your message to an existing one, tagging us with `@stride3d`/`@stride-contributors` and sharing your email address or Discord handle. You can also do it directly through Discord by sending a message in `#github-pr-and-issues` with the `@Developer` tag.
57

68
If you are interested in tackling one of those issues:
7-
- Reply in the thread and tag @stride3d/stride-contributors
9+
- Reply in the thread and tag `@stride3d`/`@stride-contributors`
810
- We'll get back to you and reserve that issue to your name.
911
- You can then create a new pull request and we'll review it.
1012
- Once merged in you will receive 60% of the bounty and the other 40% on the next official release of the engine.

en/contributors/engine/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Contribute to Stride engine
22
Here you can find various pages describing building the source locally for different systems. You can also find information about stride's architecture.
33

4-
### [Contribute code](contribute-engine.md)
4+
### [Contribute code](contribute-code.md)
55
Want to help out fixing bugs or making new features? Check out how you can do so.
66

7-
### [Bug bounties](contribute-engine.md)
7+
### [Bug bounties](bug-bounties.md)
88
Here you can learn about the process on our bug bounty process.
99

1010
### [Building on Windows](building-source-windows.md)

en/contributors/toc.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313
href: engine/bug-bounties.md
1414
- name: Building source on Windows
1515
href: engine/building-source-windows.md
16-
# - name: Building source on Linux
17-
# href: engine/building-source-linux.md
1816
- name: Localization
1917
href: engine/localization.md
2018
- name: Hot reloading editor shaders
@@ -60,6 +58,7 @@
6058
- name: 🌐️ Contribute to the website
6159
expanded: false
6260
href: website/index.md
61+
items:
6362
- name: Installation
6463
href: website/installation.md
6564
- name: Website Content

en/contributors/website/content.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@
2424

2525
If you want to contribute and update the website, please follow the instructions below.
2626

27-
Small updates can be done directly in the GitHub web interface, for bigger updates the local development environment is required, which is described in the [Installation](Installation) section.
27+
Small updates can be done directly in the GitHub web interface, for bigger updates the local development environment is required, which is described in the [Installation](installation.md) section.
2828

2929
You can use any text editor to make changes. If you are using **Visual Studio**, you can open `Stride.Web.sln` solution file in the root of the repository and start making your updates directly from this IDE.
3030

@@ -69,7 +69,7 @@ We can define bigger updates as changes to the design of the website, where you
6969
- Update Bootstrap library or other libraries
7070
- Update layouts
7171

72-
You would start with the local development environment, which is described in the [Installation](Installation) section.
72+
You would start with the local development environment, which is described in the [Installation](installation.md) section.
7373

7474
Then you would make your changes and test them locally. Once you are happy with the result, you can create a pull request to merge your changes into the `master` branch.
7575

en/contributors/website/deployment.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The [web.config](https://github.com/stride3d/stride-website/blob/master/web.conf
2424

2525
The GitHub action [stride-website-release-azure.yml](https://github.com/stride3d/stride-website/blob/master/.github/workflows/stride-website-release-azure.yml) builds the website and deploys it to Azure Web Apps.
2626

27-
[Step-by-Step Deployment Guide for Azure Web Apps (Windows) with IIS and Stride Website](Deployment-Azure).
27+
[Step-by-Step Deployment Guide for Azure Web Apps (Windows) with IIS and Stride Website](deployment-azure.md).
2828

2929
# Deployment To Wiki
3030

0 commit comments

Comments
 (0)