docs: publish DocFX site to GitHub Pages#64
Merged
Conversation
github-actions
Bot
added
documentation
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
1 participant
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 adds a real publish step for the DocFX site so the generated docs are deployed from
mainto GitHub Pages, not just built in CI.Highlights
Publishing workflow
.github/workflows/publish-docs.ymlto build the DocFX site on push tomain._siteoutput as a GitHub Pages artifact.User-facing docs
README.mdso contributors can find the rendered docs.Why
The previous DocFX change validated the docs build in CI, but users still had no rendered site to browse. Publishing the site from
maincloses that gap and makes the generated API reference actually visible.Checks
git diff --checkCloses