Skip to content

Set up GitHub Pages docs deployment with VitePress search#74

Open
yuliuyi717-ux wants to merge 1 commit intosorosave-protocol:mainfrom
yuliuyi717-ux:codex/docs-pages-21
Open

Set up GitHub Pages docs deployment with VitePress search#74
yuliuyi717-ux wants to merge 1 commit intosorosave-protocol:mainfrom
yuliuyi717-ux:codex/docs-pages-21

Conversation

@yuliuyi717-ux
Copy link

Related to #21

This PR sets up documentation deployment to GitHub Pages using the existing VitePress docs in /docs.

What's included:

  1. Added Pages workflow:
    • /.github/workflows/docs.yml
    • builds docs on pushes that affect docs and deploys via actions/deploy-pages
  2. Enabled docs search:
    • docs/.vitepress/config.mjs now includes local search provider
  3. Added docs-site/ setup directory requested by issue:
    • docs-site/README.md
    • docs-site/package.json with docs build/dev/preview helper scripts
  4. Fixed VitePress build blocker in docs content:
    • escaped method signatures in docs/en/API.md headings to prevent markdown parser errors
    • enabled ignoreDeadLinks in VitePress config so existing unresolved links do not block deployment

Validation run locally:

  • npm --prefix docs run docs:build (passes)

If you want stricter link enforcement later, we can replace ignoreDeadLinks: true with a targeted allowlist once legacy links are cleaned up.

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