Skip to content

Set up GitHub Pages for documentation site#86

Open
zp6 wants to merge 1 commit into
sorosave-protocol:mainfrom
zp6:setup-github-pages
Open

Set up GitHub Pages for documentation site#86
zp6 wants to merge 1 commit into
sorosave-protocol:mainfrom
zp6:setup-github-pages

Conversation

@zp6
Copy link
Copy Markdown

@zp6 zp6 commented May 15, 2026

Changes

Implements #21 - deploys VitePress docs to GitHub Pages.

1. GitHub Actions workflow (.github/workflows/docs.yml)

  • Triggers on push to main when docs/ or workflow file changes
  • Supports manual workflow_dispatch trigger
  • Builds VitePress site and deploys to GitHub Pages
  • Uses actions/deploy-pages@v4 with proper permissions

2. VitePress search (docs/.vitepress/config.mjs)

  • Enabled built-in local search via themeConfig.search.provider: 'local'

Setup Required

After merging, the repo admin needs to:

  1. Go to Settings > Pages
  2. Set Source to GitHub Actions
  3. The workflow will deploy automatically on next push to main

Fixes #21


Wallet: zp6

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.

Set up GitHub Pages for documentation site

1 participant