Skip to content

Fix README DocFX output directory and deployment trigger#63

Closed
Copilot wants to merge 18 commits intomainfrom
copilot/sub-pr-58-again
Closed

Fix README DocFX output directory and deployment trigger#63
Copilot wants to merge 18 commits intomainfrom
copilot/sub-pr-58-again

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 9, 2026

Description

README's "Building Documentation" section had two inaccuracies about the DocFX setup that didn't match the actual config and workflow files.

Fixes:

  • Output directory: docs/docfx_project/_site/ (matches "output": "_site" in docfx_project/docfx.json)
  • Deployment trigger: "pushed to main" → triggered via workflow_call from release.yaml on GitHub Release publish, or manually via workflow_dispatch (matches .github/workflows/docfx.yaml)
  • Documentation Structure list: Updated docs/ entry to docfx_project/_site/ for consistency

Type of change

  • Documentation update

How Has This Been Tested?

  • Cross-referenced docfx_project/docfx.json ("output": "_site") and .github/workflows/docfx.yaml (on: workflow_call / workflow_dispatch) against the updated README text

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Screenshots (if applicable)

N/A

Additional context

This is a stacked PR addressing review feedback on #58.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Chris-Wolfgang and others added 17 commits March 8, 2026 22:33
- Add .editorconfig for strict C# style, async/await, and analyzer rules
- Add .gitattributes for cross-platform line ending consistency
- Expand .gitignore for modern build, IDE, and tool artifacts
- Add .globalconfig for global analyzer and Roslynator settings
- Add BannedSymbols.txt to block sync/obsolete APIs (e.g., Task.Wait, .Result)
- Update Directory.Build.props: latest C# version, analyzers, warnings as errors
- Enforce maintainable, modern, and secure async-first codebase
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Chris-Wolfgang <210299580+Chris-Wolfgang@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Chris-Wolfgang <210299580+Chris-Wolfgang@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Chris-Wolfgang <210299580+Chris-Wolfgang@users.noreply.github.com>
Copilot AI changed the title [WIP] Update changes in response to review comments Fix README DocFX output directory and deployment trigger Mar 9, 2026
Base automatically changed from repo to main March 9, 2026 21:21
@Chris-Wolfgang Chris-Wolfgang deleted the copilot/sub-pr-58-again branch March 12, 2026 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants