Skip to content

docs: add GitHub Pages auto-deploy workflow#90

Open
copernicusjones wants to merge 1 commit into
sorosave-protocol:mainfrom
copernicusjones:docs/github-pages-deploy
Open

docs: add GitHub Pages auto-deploy workflow#90
copernicusjones wants to merge 1 commit into
sorosave-protocol:mainfrom
copernicusjones:docs/github-pages-deploy

Conversation

@copernicusjones
Copy link
Copy Markdown

Summary

Adds a GitHub Pages auto-deploy workflow for the VitePress documentation site as requested in #21.

Changes

  • New file: .github/workflows/docs.yml
    • Triggers on push to main and manual dispatch
    • Installs Node 20, runs npm ci in docs/
    • Builds with vitepress build
    • Deploys to GitHub Pages via actions/deploy-pages

Acceptance criteria

  • Auto-deploy on push to main
  • Includes all docs from /docs directory (VitePress handles this)
  • Search functionality (VitePress has built-in search)
  • New .github/workflows/docs.yml file

- Deploy VitePress docs to GitHub Pages on push to main
- Uses actions/deploy-pages for zero-config hosting
- Build step installs deps, runs vitepress build, uploads artifact
- Deploy step publishes to github-pages environment

Closes sorosave-protocol#21
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