decryptedchaos / stride-docs

This repository hosts the source code for the Stride documentation. Contributors can follow the build instructions provided to run the website locally.

Stride Docs Development

Welcome to the Stride Docs repository. This repository contains all the source files for the Stride documentation https://doc.stride3d.net/.

• 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 Wiki.

🤝 Contributing

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.

Branch and Release

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.

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/

🗺️ Roadmap

Our Wiki Roadmap communicates upcoming changes to the Stride Docs.

📖 Stride Documentation Landscape

The Stride documentation landscape is organized across different repositories and their respective wikis to cater to both users and contributors. Here's how it's structured:

1. Stride Website - Stride's official site showcasing its free, open-source 2D and 3D game engine, alongside blog posts
   • Stride Website Wiki - This wiki serves as a comprehensive guide for those looking to contribute to or develop the Stride Website
2. Stride Docs - Here you'll find Stride's documentation, including manuals, tutorials, and API references
   • Stride Docs Wiki - This wiki is a comprehensive guide for individuals interested in contributing to or developing the Stride Docs
3. Stride Wiki - A thorough guide for those who wish to contribute to or develop Stride game engine

🌐 .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.