Skip to content

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

Notifications You must be signed in to change notification settings

IXLLEGACYIXL/stride-docs-next

 
 

Repository files navigation

Stride Docs Development

🚀 Getting Started

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

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.

Happy editing!

  • Building 1620 file(s) in ResourceDocumentProcessor(ValidateResourceMetadata)...
  • Building 304 file(s) in ConceptualDocumentProcessor(BuildConceptualDocument=>CountWord=>ValidateConceptualDocumentMetadata)...
  • Building 2133 file(s) in ManagedReferenceDocumentProcessor(BuildManagedReferenceDocument=>SplitClassPageToMemberLevel=>ValidateManagedReferenceDocumentMetadata=>ApplyOverwriteDocumentForMref=>FillReferenceInformation)...
  • Building 6 file(s) in TocDocumentProcessor(BuildTocDocument)...
  • Applying templates to 4063 model(s)...

  • Building 2516 file(s) in ManagedReferenceDocumentProcessor(BuildManagedReferenceDocument=>SplitClassPageToMemberLevel=>ValidateManagedReferenceDocumentMetadata=>ApplyOverwriteDocumentForMref=>FillReferenceInformation)...
  • Applying templates to 4446 model(s)...

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.

Don't forget to change $version in deploy.ps1 when branching before first deployment.

🤝 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. Sometimes we use prereleases to get feedbacks from the community.

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

Docs

Installation

Prerequisites:

  • Familiarity with the command line
  • Install .NET SDK 6.0 (link) or higher

Make sure you have .NET SDK installed, then open a terminal and enter the following command to install the latest docfx:

dotnet tool install -g docfx

Or check the inslalled version is at least 2.66.0

docfx --version

Other options

Update to the latest docfx

dotnet tool update -g docfx

Install a specific version of docfx

dotnet tool update -g docfx --version 2.66.0

Build

Go to stride-docs folder

run

run.bat
  • en and jp docs only, without API - 3 minutes

Post-Release Features

  • Dark Theme by Default

Documentation Build Workflow

  • "BuildAll - Yes" is used for CI/CD.
  • "BuildAll - No" is used for local development with an interactive command-line UI.
%% Define styles

%% Main Graph
graph TB

%% Nodes
    A[Read-LanguageConfigurations]
    B{BuildAll}
    C[Get-UserInput]
    D[Generate-APIDoc]
    E{Ask-IncludeAPI}
    End[End]
    F[Start-LocalWebsite]
    G[Cancel]
    H[Remove-APIDoc]
    M{isEnLanguage or isAllLanguages}
    N[Build-EnglishDoc]
    O[PostProcessing-FixingSitemap]
    O1[PostProcessing-Fixing404AbsolutePath]
    P[Copy-ExtraItems]
    R{isAllLanguages}
    S[Build-AllLanguagesDocs]
    T[Build-NonEnglishDoc]
    Y[PostProcessing-DocFxDocUrl]
    Z[End]

%% Edges
    A --> B
    B -->|Yes| D
    B -->|No| C
    subgraph User Interaction
    C --> E
    C --> F
    C --> G
    end
    F --> End
    G --> End
    E -->|Yes| D
    E -->|No| H
    subgraph Documentation Generation
    H --> M
    D --> M
    M -->|Yes| N
    M -->|No| R
    N --> DocFX{{DocFX}} --> O --> O1--> P
    P --> R
    R -->|Yes| S
    R -->|No| T
    S --> T
    T --> X{{DocFX}}
    X --> Y
    Y --> Z
    end
Loading

About

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.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PowerShell 48.4%
  • JavaScript 22.5%
  • C# 20.8%
  • HTML 5.4%
  • CSS 2.4%
  • Batchfile 0.5%