README.md
Stride Docs Development
Welcome to the Stride Docs repository. This repository contains all the source files for the Stride documentation Stride Docs.
- 🚀 Getting Started
- 🤝 Contributing
- 🗺️ Roadmap
- 📖 Stride Documentation Landscape
- 🌐 .NET Foundation
- 🛡️ License
🚀 Getting Started
All the information you need to get started with Stride Docs development can be found in the 📚 Stride Docs - Contributing.
🤝 Contributing
Use Discord for questions and general discussions. Use Issues to report bugs and propose features.
We welcome code contributions through pull requests. Issues tagged as help wanted are good candidates for starting to contribute code.
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 Commits is encouraged.
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 Stride Docs Staging.
🗺️ Roadmap
Our Roadmap communicates upcoming changes to the Stride Docs.
📖 Stride Documentation Landscape
The Stride documentation is organized across different locations. Here's how it's structured:
- Stride Game Engine - The main repository for Stride, a free and open-source 2D and 3D game engine.
- Contributing to Stride - A guide for developers interested in contributing to or developing the Stride engine.
- Stride Website - The official site showcasing Stride, featuring:
- Stride Docs - The official documentation, including:
- Manual
- Tutorials
- Release Notes
- Ways to contribute
- API Reference
- Community Resources - Demos, articles, shaders, physics examples, and more.
- Contributing to the Docs - Guide for contributing to the Stride documentation.
- Stride Community Toolkit - A set of C# helpers and extensions to enhance your experience with the Stride game engine.
- Contributing to Toolkit - Contribute to or explore the toolkit's source code.
🌐 .NET Foundation
This project is supported by the .NET Foundation.
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information, see the .NET Foundation Code of Conduct.
🛡️ License
This project is licensed under the MIT License.