fix(docs): exclude samples/benchmarks/tools from docfx metadata; add PR doc-build check#81
Merged
JerrettDavis merged 1 commit intomainfrom Apr 23, 2026
Merged
Conversation
…PR doc build check - docs/docfx.json: exclude samples/**, benchmarks/**, tools/** from metadata generation to avoid CS0234 error from Razor-generated namespaces in DashboardHost - .github/workflows/ci.yml: add docs-build-check job that runs on PRs to validate the doc build before merging Agent-Logs-Url: https://github.com/JerrettDavis/ExperimentFramework/sessions/12ff95e6-c91d-44bd-87ad-db23ef71b9a4 Co-authored-by: JerrettDavis <2610199+JerrettDavis@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
JerrettDavis
April 23, 2026 16:09
View session
github-actions
Bot
added
documentation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Snapshot WarningsEnsure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice. Scanned FilesNone |
Code Coverage |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #81 +/- ##
==========================================
+ Coverage 83.51% 89.55% +6.04%
==========================================
Files 193 193
Lines 7035 7035
Branches 1213 996 -217
==========================================
+ Hits 5875 6300 +425
+ Misses 852 735 -117
+ Partials 308 0 -308
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
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
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
Fixes the failing docs build (run #24844962791) and adds a PR gate so the same breakage can't happen silently again.
Root cause
docs/docfx.jsonincluded all*.csprojfiles in the repo when generating API metadata — including sample projects such asExperimentFramework.DashboardHost. That host'sProgram.csuses:This namespace is produced by the Razor compiler at build time. docfx runs its own internal MSBuild/Roslyn metadata pass without the Razor SDK step, so the namespace is never generated and the build fails with:
Changes
docs/docfx.json**/samples/**,**/benchmarks/**,**/tools/**to the metadataexcludelist so onlysrc/library projects are documented..github/workflows/ci.ymldocs-build-checkPR job that runsdotnet build+docfx docs/docfx.json, ensuring doc-build regressions are caught before merging.Testing
docs-build-checkCI job will validate each PR going forward.