Prebuild Assemblies And Reference Them For Documentation Builds#175
Merged
Conversation
…x attempt to build projects
SimonDarksideJ
approved these changes
Sep 2, 2025
Gaetz
pushed a commit
to Gaetz/docs.monogame.github.io
that referenced
this pull request
Oct 29, 2025
…Game#175) * Use dll assemblies for documentation reference instead of having docfx attempt to build projects * Added bash and powershell scripts to build perform documentation build * Update workflows to use bash script for build * Initialize submodules and build only if needed * Add serve script * Update readme * Use projects for CI builds
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR resolves documentation build failures by updating DocFX configuration to use pre-built assemblies instead of building from source. Previously, native build failures in both local environments and GitHub workflows prevented complete documentation generation with valid cross-reference links.
Problem
DocFX was attempting to build MonoGame projects from source during documentation generation, which failed due to native build dependencies. This resulted in:
Solution
Configure DocFX to reference pre-built assemblies directly, bypassing the native build process while maintaining complete API documentation coverage.
Changes Made
docfx.json: Modified configuration to referenceMonoGame.Framework.dllandMonoGame.Framework.Content.Pipeline.dllassemblies for API documentation generationbuild.sh- Bash script for Unix/Linux/macOS environmentsbuild.ps- PowerShell script for Windows environments