Merge pull request #212 from VaclavElias/update-14-contributors-section-improvement

Update 14 - Contributors section improvements

en/contributors/documentation/content.md

@@ -94,7 +94,7 @@ In addition to the Manual and Tutorial sections mentioned above, the same princi
 
 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 [markdown, 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
 - **Video**: Embed video content directly into your documentation

en/contributors/documentation/docfx.md

@@ -10,82 +10,71 @@ Currently, we are not utilizing any additional packages.
 
 ## Configuration
 
-The configuration for Docfx is located in the `en\docfx.json` file. This file contains all the settings necessary for the Docfx build process.
+The configuration for Docfx is located in the `en\docfx.json` file. This file contains all the necessary settings for the Docfx build process.
 
-**What do you find in this file?**
+Contents of the Configuration File:
 
-- plugins configuration - All the plugins we use
-- pass through files - Files that are copied to the output folder without any processing
-- custom collections - Custom collections used in the templates like `tagList` and `yearList`
-- filters - Custom filters used in the templates
-- custom shortcodes - Custom [shortcodes](content.md#shortcodes-and-includes) used in the templates, pages or blog posts.
+- **API Sources**: Specifies the Stride path and selected projects for API documentation generation
+- **Global Metadata**: Contains global configuration settings for the documentation build
+- **File Metadata**: Defines folder sections to be processed for documentation generation, such as Manuals, Tutorials, etc.
+- **Resource - Pass Through Files**: Lists files that are copied directly to the output folder without processing
+- **Other Configuration**: Explore the file for additional configuration options
 
-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.
+For more details on configuration options, visit the [Docfx Configuration Documentation](https://dotnet.github.io/docfx/docs/config.html).
 
 ## Global Data
 
-Global data is located in the `/_data` folder. It contains all the global data that is accessible in all the templates. Currently, we have these JSON files:
-
-- `site.json` - Contains all the global data for the website, used in the templates and shortcodes.
-- `features.json` - Contains all the data for the features page and its features sections.
-- `sponsors.json` - Contains sponsor information used in multiple places on the website.
-
-Our `site.json` file contains these main properties, with only some listed below:
-
-- `dark-mode` - Dark mode toggle `true|false`
-- `alert-banner` - Global banner below navigation `true|false`
-- `docs-search` - Includes docs website content in the search `true|false`
-- `links` - Contains all the main links used across the website (social media, docs, GitHub, etc.)
-- `authors` - Contains all the authors used in the blog posts
-- repeated data - like `csharp-version`, `dotnet-version`, `download-version` which are used in multiple places on the website and are updated with every release
+Docfx currently does not support global data like 11ty. At present, *Mustache* can only be used in templates.
 
 ## Folder Structure
 
-The folder structure is crucial for Eleventy, as it determines the output of the build process. The folder structure is organized as follows:
-
-**Folders**
-
-- `/_data` - Global data
-- `/_drafts` - Draft blog posts (excluded from the build process)
-- `/_includes` - Reusable code snippets that can be included in multiple pages
-- `/_layouts` -  Main layout pages (`container`, `page`, `post`) using the primary layout page `default`
-- `/_site` - Output build folder (excluded in `.gitignore` and used for deployment) 
-- `/assets` - Additional assets, such as scripts
-- `/blog` - Blog content page
-- `/css` - Website stylesheets
-- `/files` - Stride installer files
-- `/images` - Images and MP4 files used on the website
-- `/legal` - Content page
-- `/posts` - Blog posts
-- `/posts/2014-2021` - Old blog posts which are merged to the same output folder as `/posts`
-  - this folder is only for convenience to easily access new posts
+The folder structure plays a vital role in the documentation generation process, as it determines the output of the build. The structure is organized as follows:
+
+### Folders
+
+- `.github`: Contains GitHub Action workflows
+- `_site`: The output build folder (excluded in `.gitignore` and used for deployment)
+- `en`: Contains the English language documentation
+- `en\api`: Automatically generated folder from the Stride API
+- `en\contributors`: Documentation for contributors
+- `en\diagnostics`: Diagnostic pages referenced by Stride solution warnings in the IDE
+- `en\examples`: Additional content for C# XML comments, which are merged into API documentation and linked by **uids**
+- `en\includes`: Markdown files whose content can be included in multiple `.md` files across the documentation.
+- `en\manual`: Documentation for the manual
+- `en\media`: Main media assets
+- `en\ReleaseNotes`: Documentation for release notes
+- `en\template`: Docfx assets for minor template customization, including CSS and JS files
+- `en\tutorials`: Documentation for tutorials
+- `jp`: Japanese language documentation, translated from the English version (currently not updated)
+- `wiki`: GitHub wiki content - Excluded from the build process and used only for wiki deployment. This section will be decommissioned as the content has been moved to Stride Docs.
 
 ### Files
 
-- `/posts/posts.json` - Blog post defaults so they don't have to be repeated in the front matter
-- `*.html` - HTML content pages
-- `*.liquid` - Liquid content pages
-- `*.md` - Markdown content pages
-- `*.njk` - Nunjucks content pages
-- `.eleventy.js` - Eleventy configuration file
-- `.eleventyignore` - Lists files and folders not to be processed by Eleventy
-- `package.json` - Eleventy project metadata used by `npm`
+- `en\*.md` - Markdown content pages
+- `en\*.yml` - Table of content files
+- `en\.nojekyll` - GitHub Action flag
+- `en\docfx.json` - Docfx configuration file
+- `en\filterConfig.yml` - API exclusion rules
+- `en\languages.json` - Languages configuration
 
-### Non Eleventy files
+### Non Docfx files
 
-- `.nojekyll` - Special file for GitHub Pages
-- `CNAME` - Custom domain for GitHub Pages
 - `appsettings.json` - ASP.NET Core configuration file
 - `appsettings.Development.json` - ASP.NET Core configuration file
+- `build-all.bat` - 
+- `BuildDocs.ps1` - 
+- `OldDocsFix.ps1` - 
 - `Program.cs` - ASP.NET Core startup file
-- `Stride.Web.csproj` - ASP.NET Core project file
-- `Stride.Web.sln` - ASP.NET Core solution file
-- `Stride.Web.csproj.user` - ASP.NET Core project file
+- `run.bat` - 
+- `run-fix.bat` - 
+- `Stride.Docs.csproj` - ASP.NET Core project file
+- `Stride.Docs.sln` - ASP.NET Core solution file
+- `Stride.Docs.csproj.user` - ASP.NET Core project file
+- `versions.json` - 
 - `web.config` - Configuration file for IIS deployment
-- `web.Release.config` - Configuration file for Windows ASP.NET Core deployment
 
 > [!NOTE]
-> This project includes Visual Studio solution and files so you can edit the files from the Visual Studio project.
+> This project includes Visual Studio solution so you can edit the files from the Visual Studio IDE.
 
 ## Layouts
 

en/contributors/documentation/index.md

@@ -27,4 +27,8 @@ Various Stride systems rely on content fetched and processed from either the Str
 1. https://doc.stride3d.net/latest/en/index.json
    - This JSON file is crucial for integrating the Stride Docs search functionality with the Stride Website. It ensures that search results are comprehensive, including relevant information from both the Stride website and Stride Docs.
 1. https://doc.stride3d.net/latest/en/ReleaseNotes/ReleaseNotes.md
-   - The **Stride Launcher** utilizes this file when you click a release notes button.
+   - The **Stride Launcher** utilizes this file when you click a release notes button.
+1. https://doc.stride3d.net/latest/en/diagnostics/index.html
+   - Diagnostic warnings in the Stride IDE reference pages in the Stride Docs - Diagnostics section. This ensures that users can quickly find detailed explanations and potential solutions for any issues encountered.
+1. https://doc.stride3d.net/latest/en/studio_getting_started_links.txt
+   - The **Stride Launcher** is using this file in `Urls.Designer.cs`.

en/contributors/documentation/installation.md

@@ -28,7 +28,7 @@ Enter the following command to install the latest docfx
 dotnet tool install -g docfx
 ```
 
-Or check the inslalled version is at least `2.67.0`
+Or check the installed version is at least `2.74.1`
 
 ```
 docfx --version
@@ -45,12 +45,11 @@ dotnet tool update -g docfx
 Install a specific version of Docfx
 
 ```
-dotnet tool update -g docfx --version 2.67.0
+dotnet tool update -g docfx --version 2.74.1
 ```
 
 Uninstall Docfx if you need to downgrade
 
-
 ```
 dotnet tool uninstall -g docfx
 ```

en/contributors/website/eleventy.md

@@ -73,7 +73,7 @@ The folder structure is crucial for Eleventy, as it determines the output of the
 - `posts` - Blog posts
 - `posts/2014-2021` - Old blog posts which are merged to the same output folder as `/posts`
   - this folder is only for convenience to easily access new posts
-- `wiki` - Excluded from build process, used only for wiki deployment
+- `wiki` - GitHub wiki content - Excluded from build process, used only for wiki deployment. This will be decommissioned because the content was moved to Stride Docs
 
 ### Files
 

en/tutorials/index.html

@@ -1,38 +0,0 @@
-<div class="row g-4 mb-4">
-    <div class="col-md-6">
-        <div class="card h-100">
-            <img src="media/gamestudio.jpg" class="card-img-top" alt="Game studio tutorials">
-            <div class="card-body">
-                <h5 class="card-title">Game Studio</h5>
-                <p class="card-text">The Stride engine comes with an editor called Game Studio.</p>
-                <p>Read about Stride launcher, main inteface, scene management, transforming entities, asset pipelines and more.</p>
-            </div>
-            <p class="px-3 mb-4">Jump to the <a href="gamestudio/index.md">Game Studio tutorials</a>.</p>
-        </div>
-    </div>
-    <div class="col-md-6">
-        <div class="card h-100">
-            <img src="media/csharp-beginner.png" class="card-img-top" alt="C# beginner tutorials">
-            <div class="card-body">
-                <h5 class="card-title">C# Beginner</h5>
-                <p class="card-text">These tutorials cover the beginner principles of using C# when working with the Stride game engine.</p>
-                <p>Read about entities, transform positions, editor properties, components, delta time, cloning, keyboar and mouse input and more.</p>
-            </div>
-            <p class="px-3 mb-4">Jump to the <a href="csharpbeginner/index.md">C# beginner tutorials</a>.</p>
-        </div>
-    </div>
-</div>
-<div class="row">
-    <div class="col-md-6">
-        <div class="card h-100">
-            <img src="media/csharp-intermediate.png" class="card-img-top" alt="C# intermediate tutorials">
-            <div class="card-body">
-                <h5 class="card-title">C# Intermediate</h5>
-                <p class="card-text">These tutorials cover various intermediate principles of using C# when working with the Stride game engine.</p>
-                <p>Read more about UI basics, collision triggers, raycasting, async scripts, scenes, animations, audio, camera and navigation.</p>
-                <p><span class="badge text-bg-success">New</span></p>
-            </div>
-            <p class="px-3 mb-4">Jump to the <a href="csharpintermediate/index.md">C# intermediate tutorials</a>.</p>
-        </div>
-    </div>
-</div>