Open
Conversation
Adds a new GitHub Actions workflow that builds the mkdocs documentation site on every push and pull request to main. This catches documentation build failures early, preventing broken builds from being merged. Closes the gap where Python source changes or dependency updates could break the docs build without being detected by CI. Co-authored-by: sei-renae <190382933+sei-renae@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add missing docs build check for mkdocs
Add CI workflow to check mkdocs build on PRs
Mar 12, 2026
sei-renae
reviewed
Mar 18, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Actions CI gate to ensure the MkDocs site builds successfully on PRs and pushes to main, catching documentation build breakages earlier than the publish-branch deployment workflow.
Changes:
- Add a new workflow that runs on
pushandpull_requestevents targetingmain. - Install locked, non-dev dependencies via
uv sync --no-dev --frozen. - Build the documentation with
uv run mkdocs build --clean(matching the deploy workflow).
You can also share your feedback on Copilot code review. Take the survey.
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.
The docs site build (
uv run mkdocs build) has no CI gate on PRs tomain. The existingdeploy_site.ymlonly runs on thepublishbranch, so Python source changes or dependency updates that break the docs build go undetected until deploy time.Adds
.github/workflows/docs_build_check.yml:main(same scope aspython-app.yml)uv sync --no-dev --frozen— mkdocs and plugins are main deps, not dev;--frozencatches lockfile driftmkdocs build --cleanmatching the production build command indeploy_site.ymlOriginal prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.