Skip to content

Complete docs rewrite: Histoire → VitePress (includes breaking changes)#557

Closed
Copilot wants to merge 1 commit intodocs-rewritefrom
copilot/sub-pr-506
Closed

Complete docs rewrite: Histoire → VitePress (includes breaking changes)#557
Copilot wants to merge 1 commit intodocs-rewritefrom
copilot/sub-pr-506

Conversation

Copy link
Contributor

Copilot AI commented Jan 21, 2026

Migrates documentation from Histoire to VitePress for better performance and maintainability. Note: Includes breaking changes to the library API.

Breaking Changes

  • Spinner component removed from library exports - any imports of Spinner will fail
  • Histoire development scripts removed - story:dev, story:build, story:preview no longer available
  • Histoire dependencies removed - @histoire/plugin-vue, histoire, @vitepress-demo-preview/plugin

Documentation Migration

  • 140 old Histoire/story files removed
  • 200 new VitePress documentation files added
  • New component documentation with interactive examples
  • Improved search, navigation, and design tokens showcase
  • Documentation now at: https://frappe-ui.netlify.app

Component Enhancements (Backward Compatible)

  • Alert: Added dismiss event emission, JSDoc comments, slot definitions
  • Popover: Added offset prop, simplified placement values (top|bottom|left|right), slot definitions
  • Multiple components: Enhanced TypeScript support with JSDoc comments

CI/CD Updates

  • GitHub Actions updated (v1→v4, Node 18→20)
  • New VitePress deployment workflow for GitHub Pages
  • NPM publish workflow modernized with OIDC authentication

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@netlify
Copy link

netlify bot commented Jan 21, 2026

Deploy Preview for frappe-ui ready!

Name Link
🔨 Latest commit dc0492a
🔍 Latest deploy log https://app.netlify.com/projects/frappe-ui/deploys/69709f7aaa355300083c1125
😎 Deploy Preview https://deploy-preview-557--frappe-ui.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot AI changed the title [WIP] Refactor documentation website using Vitepress Complete docs rewrite: Histoire → VitePress (includes breaking changes) Jan 21, 2026
Copilot AI requested a review from netchampfaris January 21, 2026 09:47
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.

2 participants