Browse Source

feat: DoxFX renamed to official Docfx

Vaclav Elias 2 years ago
parent
commit
cceaaab9d2

+ 4 - 4
en/contributors/documentation/content.md

@@ -37,7 +37,7 @@ For the following instructions, use the [Stride Docs GitHub repository](https://
 
 
 Major updates can be defined as significant changes to the website's design, where it's beneficial to preview the impact of your changes to ensure they achieve the desired result. This may include:
 Major updates can be defined as significant changes to the website's design, where it's beneficial to preview the impact of your changes to ensure they achieve the desired result. This may include:
 
 
-- Update docfx version
+- Update Docfx version
 - Modifying layouts
 - Modifying layouts
 - Revamping design elements
 - Revamping design elements
 
 
@@ -92,9 +92,9 @@ In addition to the Manual and Tutorial sections mentioned above, the same princi
 
 
 ## Shortcodes and Includes
 ## Shortcodes and Includes
 
 
-Docfx supports additional markdown syntax to enrich content. These syntaxes are specific to docfx and **may not render** correctly on other platforms, like GitHub.
+Docfx supports additional markdown syntax to enrich content. These syntaxes are specific to Docfx and **may not render** correctly on other platforms, like GitHub.
 
 
-For more information, read the docfx documentation on [shortcodes and includes](https://dotnet.github.io/docfx/docs/markdown.html?tabs=linux%2Cdotnet). Some commonly used features include:
+For more information, read the Docfx documentation on [shortcodes and includes](https://dotnet.github.io/docfx/docs/markdown.html?tabs=linux%2Cdotnet). Some commonly used features include:
 
 
 - **Alert**: These are block quotes that render with distinct colors and icons, highlighting the importance or nature of the content
 - **Alert**: These are block quotes that render with distinct colors and icons, highlighting the importance or nature of the content
 - **Video**: Embed video content directly into your documentation
 - **Video**: Embed video content directly into your documentation
@@ -122,7 +122,7 @@ Our main web assets include:
 
 
 ### Bootstrap Customization
 ### Bootstrap Customization
 
 
-We utilize the `modern` template provided by docfx, which employs the [Bootstrap](https://getbootstrap.com/) framework, version **5.3**. This includes the dark theme, enabled by docfx.
+We utilize the `modern` template provided by Docfx, which employs the [Bootstrap](https://getbootstrap.com/) framework, version **5.3**. This includes the dark theme, enabled by Docfx.
 
 
 > [!IMPORTANT]
 > [!IMPORTANT]
 > Prioritize the use of Bootstrap's inherent styling before integrating any custom styles. You should be familiar with [Bootstrap Utilities](https://getbootstrap.com/docs/5.3/utilities/api/) which help you to achieve most of the styling requirements.
 > Prioritize the use of Bootstrap's inherent styling before integrating any custom styles. You should be familiar with [Bootstrap Utilities](https://getbootstrap.com/docs/5.3/utilities/api/) which help you to achieve most of the styling requirements.

+ 4 - 4
en/contributors/documentation/documentation-generation-pipeline.md

@@ -2,7 +2,7 @@
 
 
 ## Introduction
 ## Introduction
 
 
-As of now, **DocFX** does not natively support the generation of multi-language and multi-version documentation. To address this limitation, the Stride team has developed a PowerShell script. Initially, separate scripts were created for each language; however, these have since been consolidated into a single script named [`BuildDocs.ps1`](https://github.com/stride3d/stride-docs/blob/staging/BuildDocs.ps1). This unified script is capable of generating documentation in all supported languages.
+As of now, **Docfx** does not natively support the generation of multi-language and multi-version documentation. To address this limitation, the Stride team has developed a PowerShell script. Initially, separate scripts were created for each language; however, these have since been consolidated into a single script named [`BuildDocs.ps1`](https://github.com/stride3d/stride-docs/blob/staging/BuildDocs.ps1). This unified script is capable of generating documentation in all supported languages.
 
 
 The script serves two main purposes:
 The script serves two main purposes:
 
 
@@ -15,16 +15,16 @@ Here's a straightforward explanation of how the documentation generation process
 
 
 The `/en` folder serves as the repository for the primary documentation files. When documentation for another language (e.g., Japanese) is built, the files from `/en` are copied over to a temporary folder, for example, `/jp-tmp`. This ensures that the non-English versions will contain all the files present in the `/en` folder. Files that have been translated (found in folders like `/jp`) will overwrite their English counterparts in the temp folder `/jp-tmp`.
 The `/en` folder serves as the repository for the primary documentation files. When documentation for another language (e.g., Japanese) is built, the files from `/en` are copied over to a temporary folder, for example, `/jp-tmp`. This ensures that the non-English versions will contain all the files present in the `/en` folder. Files that have been translated (found in folders like `/jp`) will overwrite their English counterparts in the temp folder `/jp-tmp`.
 
 
-DocFX is invoked multiple times, once for each language, to create the documentation. The generated documents are stored in the `_site` folder, organized according to the latest version information obtained from `version.json`. For example:
+Docfx is invoked multiple times, once for each language, to create the documentation. The generated documents are stored in the `_site` folder, organized according to the latest version information obtained from `version.json`. For example:
 
 
 ```
 ```
 /_site/4.1/en
 /_site/4.1/en
 /_site/4.1/jp
 /_site/4.1/jp
 ```
 ```
 
 
-### DocFX Files Processed
+### Docfx Files Processed
 
 
-This section outlines the file processing carried out by DocFX during the documentation generation:
+This section outlines the file processing carried out by Docfx during the documentation generation:
 
 
 - **Table of Contents (TOC) Files:** 7 files processed
 - **Table of Contents (TOC) Files:** 7 files processed
 - **Assets:** 1620 items (images, videos, etc.) included
 - **Assets:** 1620 items (images, videos, etc.) included

+ 3 - 3
en/contributors/documentation/index.md

@@ -8,10 +8,10 @@ For more extensive updates 🤯🤦‍♂️ or for a deeper understanding of th
 
 
 Here are the technologies we use to build our website:
 Here are the technologies we use to build our website:
 
 
-- [docfx](https://dotnet.github.io/docfx/index.html) (static site generator)
-  - A specific version of docfx is utilized in GitHub Actions, one that has been thoroughly tested. Should you wish to upgrade this version, please ensure it is properly tested before implementation.
+- [Docfx](https://dotnet.github.io/docfx/index.html) (static site generator)
+  - A specific version of Docfx is utilized in GitHub Actions, one that has been thoroughly tested. Should you wish to upgrade this version, please ensure it is properly tested before implementation.
 - Markdown
 - Markdown
-- [Mustache](https://mustache.github.io/) template engine (docfx dropped Liquid template engine support)
+- [Mustache](https://mustache.github.io/) template engine (Docfx dropped Liquid template engine support)
 - Bootstrap
 - Bootstrap
 - Emojis (because why not? 😎)
 - Emojis (because why not? 😎)
 - HTML, JavaScript, CSS, JSON
 - HTML, JavaScript, CSS, JSON

+ 5 - 5
en/contributors/documentation/installation.md

@@ -1,7 +1,7 @@
 # Local installation
 # Local installation
 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.
 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.
 
 
-[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](https://dotnet.github.io/docfx/index.html) 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.
+[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](https://dotnet.github.io/docfx/index.html) 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.
 
 
 This guide assumes you have a basic understanding of the technologies used in the Stride docs website.
 This guide assumes you have a basic understanding of the technologies used in the Stride docs website.
 
 
@@ -20,7 +20,7 @@ Before updating the Stride Docs, ensure you are familiar with the following prer
 1. Make sure you have also Stride repo cloned on **the same level** as stride-docs, read more about it [here](https://github.com/stride3d/stride)
 1. Make sure you have also Stride repo cloned on **the same level** as stride-docs, read more about it [here](https://github.com/stride3d/stride)
    - This repo is needed for API documentation generation
    - This repo is needed for API documentation generation
 1. 📁 Go to the project folder `cd stride-docs`
 1. 📁 Go to the project folder `cd stride-docs`
-1. 🚀 Let's start with the **docfx**
+1. 🚀 Let's start with the **Docfx**
 
 
 Enter the following command to install the latest docfx
 Enter the following command to install the latest docfx
 
 
@@ -36,19 +36,19 @@ docfx --version
 
 
 **Other options**
 **Other options**
 
 
-Update to the latest docfx
+Update to the latest Docfx
 
 
 ```
 ```
 dotnet tool update -g docfx
 dotnet tool update -g docfx
 ```
 ```
 
 
-Install a specific version of docfx
+Install a specific version of Docfx
 
 
 ```
 ```
 dotnet tool update -g docfx --version 2.67.0
 dotnet tool update -g docfx --version 2.67.0
 ```
 ```
 
 
-Uninstall docfx if you need to downgrade
+Uninstall Docfx if you need to downgrade
 
 
 
 
 ```
 ```

+ 1 - 1
en/contributors/toc.yml

@@ -52,7 +52,7 @@ items:
 #    href: documentation/new-language.md
 #    href: documentation/new-language.md
   - name: Roadmap
   - name: Roadmap
     href: documentation/roadmap.md
     href: documentation/roadmap.md
-  - name: DocFX
+  - name: Docfx
     href: documentation/docfx.md
     href: documentation/docfx.md
   - name: Deployment
   - name: Deployment
     href: documentation/deployment-azure.md
     href: documentation/deployment-azure.md