Skip to content

Deploy docs with GitHub Pages workflow#118

Merged
Zehina merged 1 commit into
masterfrom
fix/github-pages-deploy
Mar 11, 2026
Merged

Deploy docs with GitHub Pages workflow#118
Zehina merged 1 commit into
masterfrom
fix/github-pages-deploy

Conversation

@Zehina

@Zehina Zehina commented Mar 11, 2026

Copy link
Copy Markdown
Owner

Summary

  • add a dedicated GitHub Pages workflow that builds MkDocs and deploys on pushes to master
  • stop using the old release-only mkdocs gh-deploy path, which no longer matches the current Pages setup
  • update the docs site_url to the canonical GitHub Pages URL

Verification

  • uv run mkdocs build --strict

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 43b3d6c63d

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

on:
push:
branches:
- master

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Trigger Pages deploy from the active default branch

This workflow only runs on pushes to master, but in this repository the active branch is main (the checkout has no master ref, and other project metadata like README.md badges and mkdocs.yml edit links target main), so normal doc updates will never trigger a Pages deployment. Since this commit also removed the release-based mkdocs gh-deploy path, this branch filter can silently stop documentation publishing entirely.

Useful? React with 👍 / 👎.

@Zehina Zehina force-pushed the fix/github-pages-deploy branch from 43b3d6c to e83f149 Compare March 11, 2026 23:36
@Zehina Zehina merged commit 627d69f into master Mar 11, 2026
7 checks 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.

1 participant