Welcome to the Stride Docs repository. This repository contains all the source files for the Stride documentation http://doc.stride3d.net/.
All the information you need to get started with Stride Docs development can be found in the 📚 Stride Docs Wiki.
Use Discord for questions and general discussions. Use Issues to report bugs and proposing features.
We welcome code contributions through pull requests. Issues tagged as help-wanted
are good candidates for starting to contribute code.
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 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 staging website allows us to test new features and significant changes before their official release.
The staging website is available at https://stride-docs-staging.azurewebsites.net/
Our Wiki Roadmap communicates upcoming changes to the Stride Docs.
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.
This project is licensed under the MIT License.
- Dark Theme by Default
Anyone is welcome to contribute! Before you start, please take the time to read the guidelines.
You can find basic information about editing the documentation in Getting Started dedicated page.
Don't forget to change $version
in deploy.ps1 when branching before first deployment.
Each Stride minor version (i.e. 4.0, 4.1, etc.) should have its own branch, named in the fashion master-<version>
. The only exception is latest version, which should be master
.