Skip to content

Publish Markdown documentation with VitePress - #1

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

cazala merged 2 commits into
mainfrom
codex/vitepress-docs-seo

Conversation

@cazala

@cazala cazala commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Summary

  • generate a static VitePress documentation site at /automata/docs/ from the existing Markdown guides
  • add local search, clean guide routes, canonical URLs, a sitemap, and unique description/Open Graph/Twitter metadata
  • merge the docs build into the existing Cloudflare Pages artifact after the Vite playground build
  • link the playground homepage to the generated documentation and preserve /automata/-prefixed preview routes
  • expand the repository README around the Party README structure, including key features, all built-in automata, core concepts, performance, and the previously missing Worker package
  • document the docs workflow in the contributor and deployment guides

Implementation notes

  • VitePress builds after Vite because Vite recreates packages/playground/dist
  • documentation links stay useful on GitHub while generated pages rewrite guides to clean routes and source-code paths to GitHub
  • the broad Pages catch-all rewrite is replaced with a prefix-preserving proxy so real /docs/* assets can be served; Pages continues to provide its default SPA fallback
  • this follows the static-docs pipeline and SEO concept established in Publish Markdown documentation with VitePress party#20, tailored to Automata's routes and content

Verification

  • core Rollup build
  • playground TypeScript check
  • playground Vite production build with /automata/ base
  • Worker TypeScript check
  • VitePress production build
  • generated route, asset, sitemap, canonical metadata, and internal-link checks
  • local HTTP smoke tests for the playground, docs home, guide route, sitemap, and docs CSS
  • git diff --check

@github-actions

github-actions Bot commented Jul 23, 2026 •

Copy link
Copy Markdown

Preview deployment ready

@cazala
cazala merged commit c8866cb into main Jul 23, 2026
1 check passed
@cazala
cazala deleted the codex/vitepress-docs-seo branch July 23, 2026 01:59

This branch was successfully deployed

1 active deployment
preview — 8b40bec4 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