Skip to content

ci: deploy docs site on pushes to main #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jiangki merged 1 commit into from
Jul 23, 2026
Merged

ci: deploy docs site on pushes to main #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions .github/workflows/docs-deploy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# Deploys the mdBook docs site to GitHub Pages.
#
# DELIBERATELY manual-only (workflow_dispatch) so documentation deployments
# remain explicit. Add a `push: branches: [main]` trigger if continuous
# deployment becomes preferable.
# Deploys on every push to main (docs stay in sync with the default branch)
# and still allows manual runs via workflow_dispatch.
#
# Prerequisite: repository Settings -> Pages -> Source = "GitHub Actions".
name: Deploy docs

on:
push:
branches: [main]
workflow_dispatch:

permissions:
Expand Down
Loading