Giter VIP home page Giter VIP logo

vaclavelias / stride-docs-next Goto Github PK

View Code? Open in Web Editor NEW
0.0 4.0 3.0 2.11 MB

Stride Docs Repository: Source code for generating comprehensive Stride documentation using DocFX, featuring Manuals, Tutorials, Release Notes, and API Docs to help users master the Stride game engine with ease and clarity.

License: MIT License

C# 20.78% Batchfile 0.52% CSS 2.37% HTML 5.35% PowerShell 48.51% JavaScript 22.46%

stride-docs-next's Introduction

Stride Docs Development

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

🚀 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-docs-staging.azurewebsites.net/

🗺️ Roadmap

Our Wiki Roadmap communicates upcoming changes to the Stride Docs.

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

Post-Release Features

  • Dark Theme by Default

Past Content - ToDo: Review

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.

Manage multiple Stride versions

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.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.