Ver Fonte

feat: Readme updated

Vaclav Elias há 1 ano atrás
pai
commit
ce9885787a
1 ficheiros alterados com 35 adições e 21 exclusões
  1. 35 21
      README.md

+ 35 - 21
README.md

@@ -1,13 +1,13 @@
 # Stride Docs Development
 
-Welcome to the Stride Docs repository. This repository contains all the source files for the Stride documentation https://doc.stride3d.net/.
+Welcome to the Stride Docs repository. This repository contains all the source files for the Stride documentation [Stride Docs](https://doc.stride3d.net/).
 
-* [Getting Started](#-getting-started)
-* [Contributing](#-contributing)
-* [Roadmap](#%EF%B8%8F-roadmap)
-* [Stride Documentation Landscape](#-stride-documentation-landscape)
-* [.NET Foundation](#-net-foundation)
-* [License](#%EF%B8%8Flicense)
+* [🚀 Getting Started](#-getting-started)
+* [🤝 Contributing](#-contributing)
+* [🗺️ Roadmap](#%EF%B8%8F-roadmap)
+* [📖 Stride Documentation Landscape](#-stride-documentation-landscape)
+* [🌐 .NET Foundation](#-net-foundation)
+* [🛡️ License](#%EF%B8%8Flicense)
 
 ## 🚀 Getting Started
 
@@ -16,23 +16,23 @@ All the information you need to get started with Stride Docs development can be
 ## 🤝 Contributing
 
 Use [Discord](https://discord.gg/f6aerfE) for questions and general discussions. 
-Use [Issues](https://github.com/stride3d/stride-docs/issues) to report bugs and proposing features.
+Use [Issues](https://github.com/stride3d/stride-docs/issues) to report bugs and propose features.
 
 We welcome code contributions through pull requests. Issues tagged as **[`help wanted`](https://github.com/stride3d/stride-docs/labels/help%20wanted)** are good candidates for starting to contribute code.
 
-### Branch and Release
+### Branching and Releases
 
 The `master` branch is the default branch for pull requests and most other development activities. 
 
-Releases are based on a stable `master` branch. Use of [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) is encouraged.
+Releases are based on a stable `master` branch. Use of [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) is encouraged.
 
-Stride Docs website is _not_ released under a regular cadence; new updates arrive when maintainers fix issues or see enough changes that warrant a new releases.
+The Stride Docs website is _not_ released on a regular cadence; new updates arrive when maintainers fix issues or see enough changes that warrant a new release.
 
 ### Staging
 
 The staging website allows us to test new features and significant changes before their official release.
 
-The staging website is available at https://stride-doc-staging.azurewebsites.net/
+The staging website is available at [Stride Docs Staging](https://stride-doc-staging.azurewebsites.net/).
 
 ## 🗺️ Roadmap
 
@@ -40,21 +40,35 @@ Our [Roadmap](https://doc.stride3d.net/latest/en/contributors/documentation/road
 
 ## 📖 Stride Documentation Landscape
 
-The Stride documentation landscape is organized across different locations. Here's how it's structured:
-
-1. [Stride Website](https://www.stride3d.net/) - Stride's official site showcasing its free, open-source 2D and 3D game engine, alongside blog posts
-   - [Stride Website - Contributing](https://doc.stride3d.net/latest/en/contributors/website/index.html) - This serves as a comprehensive guide for those looking to contribute to or develop the Stride Website
-1. [Stride Docs](https://doc.stride3d.net/) - Here you'll find Stride's documentation, including manuals, tutorials, and API references
-   - [Stride Docs - Contributing](https://doc.stride3d.net/latest/en/contributors/documentation/index.html) - This is a comprehensive guide for individuals interested in contributing to or developing the Stride Docs
-1. [Stride Wiki](https://github.com/stride3d/stride/wiki) - A thorough guide for those who wish to contribute to or develop Stride game engine 
+The Stride documentation is organized across different locations. Here's how it's structured:
+
+1. [Stride Game Engine](https://github.com/stride3d/stride) - The main repository for Stride, a free and open-source 2D and 3D game engine.
+   - [Contributing to Stride](https://doc.stride3d.net/latest/en/contributors/engine/index.html) - A guide for developers interested in contributing to or developing the Stride engine.
+1. [Stride Website](https://www.stride3d.net/) - The official site showcasing Stride, featuring:
+   - [Features](https://www.stride3d.net/features/) 
+   - [Blog](https://www.stride3d.net/blog/)
+   - [Community](https://www.stride3d.net/community/)
+   - [Download](https://www.stride3d.net/download/)
+   - [Sponsor](https://www.stride3d.net/sponsor/)
+   - [Contributing to the Website](https://doc.stride3d.net/latest/en/contributors/website/index.html) - Guide for contributing to the Stride website.
+2. [Stride Docs](https://doc.stride3d.net/) - The official documentation, including:
+   - [Manual](https://doc.stride3d.net/latest/en/manual/index.html)
+   - [Tutorials](https://doc.stride3d.net/latest/en/tutorials/index.html)
+   - [Release Notes](https://doc.stride3d.net/latest/en/ReleaseNotes/ReleaseNotes.html)
+   - [Ways to contribute](https://doc.stride3d.net/latest/en/contributors/index.html)
+   - [API Reference](https://doc.stride3d.net/latest/en/api/index.html)
+   - [Community Resources](https://doc.stride3d.net/latest/en/community-resources/index.html) - Demos, articles, shaders, physics examples, and more.
+   - [Contributing to the Docs](https://doc.stride3d.net/latest/en/contributors/documentation/index.html) - Guide for contributing to the Stride documentation.
+4. [Stride Community Toolkit](https://stride3d.github.io/stride-community-toolkit/index.html) - A set of C# helpers and extensions to enhance your experience with the Stride game engine.
+   - [Contributing to Toolkit](https://github.com/stride3d/stride-community-toolkit) - Contribute to or explore the toolkit's source code.
 
 ## 🌐 .NET Foundation
 
 This project is supported by the [.NET Foundation](http://www.dotnetfoundation.org).
 
 This project has adopted the code of conduct defined by the [Contributor Covenant](http://contributor-covenant.org/) to clarify expected behavior in our community.
-For more information see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
+For more information, see the [.NET Foundation Code of Conduct](http://www.dotnetfoundation.org/code-of-conduct).
 
-## 🛡️License
+## 🛡️ License
 
 This project is licensed under the [MIT](https://github.com/stride3d/stride-docs/blob/master/LICENSE.md) License.