stride3d / stride3d/stride-docs

test: Check if we can update source branch name

Open
#486 0 comments 0 reactions 1 assignee View on GitHub

@VaclavElias is already working on this.

Since Mar 11, 2026.

API bug-fix ci-cd
Dominant language
PowerShell
Stars
39
Forks
74
Avg merge
3h 36m
Merged PRs (30d)
2

Description

This issue: Stride API Docs pages' source links are pointing into incorrect (non-existing) branch release.

According this https://github.com/dotnet/docfx/blob/main/docs/reference/docfx-environment-variables-reference.md#L13-L20 we should be able to override branch name.

We might be able to simplify also PowerShell script.

- name: Build API Docs with docfx
  env:
    DOCFX_SOURCE_REPOSITORY_URL: https://github.com/stride3d/stride  # ← The Stride source repo
    DOCFX_SOURCE_BRANCH_NAME: master                                  # ← The correct branch in Stride repo
  run: dotnet tool run docfx docfx.json

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.