Skip to content

Add VitePress user guide#677

Open
brandonpayton wants to merge 1 commit into
mainfrom
emdash/what-is-the-state-of-our-docs-5na1c
Open

Add VitePress user guide#677
brandonpayton wants to merge 1 commit into
mainfrom
emdash/what-is-the-state-of-our-docs-5na1c

Conversation

@brandonpayton

Copy link
Copy Markdown
Member

Summary

  • add a VitePress Kandelo guide covering the current browser UI, browser-app integration, VFS images, publishing, API stability, and troubleshooting
  • deploy the guide from the existing docs workflow to https://automattic.github.io/kandelo/guide/ while preserving API docs at /api/
  • update public URLs and copy so VFS images are central and the old URL-folding tagline is reserved for the docs dream section

Testing

  • VITEPRESS_BASE=/kandelo/guide/ npm run docs:build
  • git diff --check
  • ruby -e "require 'yaml'; YAML.load_file('.github/workflows/docs.yml'); puts 'ok'"
  • cd host && npm run typecheck

Note

  • Local cd host && npx typedoc still fails on existing host TypeScript/Typedoc errors, so the updated docs workflow only runs API docs steps when host docs inputs change. Guide-only changes are deployed independently within the same workflow.

@brandonpayton brandonpayton force-pushed the emdash/what-is-the-state-of-our-docs-5na1c branch from ebf25eb to 8a88e72 Compare June 11, 2026 19:58
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