Skip to content

docs: validate MkDocs on PRs and link published site - #156

Merged
antonysallas merged 1 commit into
redhat-cop:mainfrom
jeffmcutter:fix/docs-workflow-pr-validation
Aug 13, 2026
Merged

docs: validate MkDocs on PRs and link published site#156
antonysallas merged 1 commit into
redhat-cop:mainfrom
jeffmcutter:fix/docs-workflow-pr-validation

Conversation

@jeffmcutter

@jeffmcutter jeffmcutter commented Aug 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Run the docs workflow on PRs that touch docs (build with --strict); deploy with mkdocs gh-deploy only on push to main
  • Install docs deps via .[docs] and set site_url for GitHub Pages
  • Point README and pyproject.toml Documentation URL at https://redhat-cop.github.io/aap-bridge/

Closes #73

Test plan

  • Confirm this PR triggers the Deploy Docs workflow and the build step passes
  • After merge, confirm a docs-path push to main still runs gh-deploy and updates https://redhat-cop.github.io/aap-bridge/
  • Spot-check the new README / project Documentation links

Made with Cursor

Build docs with --strict on pull requests while keeping gh-deploy on
main, and point README/project metadata at GitHub Pages.

Closes redhat-cop#73

Co-authored-by: Cursor <cursoragent@cursor.com>

@antonysallas antonysallas left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved.

@antonysallas
antonysallas merged commit 8c2a007 into redhat-cop:main Aug 13, 2026
1 check passed
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.

Git Hub workflow for Docs needs some attention

2 participants