Skip to content

Publish Markdown documentation with VitePress - #20

Merged
cazala merged 5 commits into
mainfrom
codex/vitepress-docs
Jul 23, 2026
Merged

cazala merged 5 commits into
mainfrom
codex/vitepress-docs

Conversation

@cazala

@cazala cazala commented Jul 22, 2026

Copy link
Copy Markdown
Owner

Summary

  • generate a static VitePress documentation site at /party/docs/ from the existing Markdown guides
  • use README.md as the documentation homepage source and rewrite its repository-relative links only in generated HTML
  • provide global Documentation, Playground, and GitHub navigation plus local search, unique metadata, canonical URLs, and a sitemap
  • point the playground Learn button to the generated docs
  • merge the docs build into the existing Cloudflare Pages artifact without changing the visual homepage
  • preserve both origin-style and /party/-prefixed shared-session SPA fallbacks

Implementation notes

  • VitePress builds after the playground because Vite recreates packages/playground/dist
  • guide source-code links are rewritten to their corresponding GitHub files during rendering
  • the broad Pages catch-all rewrite was removed so real /docs/* assets can be served; Pages default SPA fallback continues handling session paths

Verification

  • npm run build
  • npm run type-check
  • npm run build:docs
  • pnpm install --frozen-lockfile --offline
  • git diff --check
  • local wrangler pages dev checks for docs home, all guide routes, docs assets, preview-prefixed routes, and shared-session fallback routes

@github-actions

github-actions Bot commented Jul 22, 2026 •

Copy link
Copy Markdown

Preview deployment ready

@cazala
cazala merged commit ccf53ac into main Jul 23, 2026
1 check passed
@cazala
cazala deleted the codex/vitepress-docs branch July 23, 2026 00:30

This branch was successfully deployed

1 active deployment
preview — b754684a Deployed Jul 23, 2026 by github-actions[bot]
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