Skip to content

Add user docs Pages deployment workflow#31

Merged
Naganathan05 merged 1 commit into
Naganathan05:mainfrom
xiaopeng215-sys:codex/deploy-user-docs
May 12, 2026
Merged

Add user docs Pages deployment workflow#31
Naganathan05 merged 1 commit into
Naganathan05:mainfrom
xiaopeng215-sys:codex/deploy-user-docs

Conversation

@xiaopeng215-sys

Copy link
Copy Markdown
Contributor

Closes #27.

/assign

Summary

  • Added a GitHub Actions workflow that builds the VitePress user docs when User-docs/ or the workflow changes.
  • Deploys the built User-docs/docs/.vitepress/dist artifact to GitHub Pages on pushes to main and manual dispatches.
  • Keeps pull requests as build-only checks so docs changes can be validated before deployment.

Verification

  • npm ci
  • npm run docs:build
  • git diff --check

@Naganathan05 Naganathan05 left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

LGTM

@Naganathan05 Naganathan05 merged commit 4fd2b02 into Naganathan05:main May 12, 2026
3 checks passed
@xiaopeng215-sys

Copy link
Copy Markdown
Contributor Author

/claim #27

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.

CI/CD Pipeline for Auto-Deploying User Docs (VitePress)

2 participants