Skip to content

Storybook to the project for interactive component development and documentation#1

Merged
Lil-Code30 merged 3 commits intomainfrom
dev
Nov 8, 2025
Merged

Storybook to the project for interactive component development and documentation#1
Lil-Code30 merged 3 commits intomainfrom
dev

Conversation

@Lil-Code30
Copy link
Member

This pull request introduces Storybook to the project for interactive component development and documentation, updates branding and documentation to reflect the @acadxp/xpui package name, and improves project configuration and developer experience. The most important changes are grouped below:

Storybook Integration & Configuration:

  • Added Storybook configuration files (.storybook/main.ts, .storybook/preview.ts) to enable component previews and documentation, including custom backgrounds and theme settings. [1] [2]
  • Added a comprehensive Storybook story for the Button component in src/stories/Button.stories.tsx, showcasing all variants, sizes, states, and gaming UI examples.
  • Updated package.json scripts and dependencies to support Storybook development and build workflows. [1] [2] [3] [4]

Documentation & Branding Updates:

  • Refreshed README.md with new branding, usage instructions, installation steps for @acadxp/xpui, contribution guidelines, and development commands. [1] [2] [3] [4] [5] [6]
  • Improved favicon and SEO metadata in index.html and added a web manifest for better PWA support. [1] [2]

Project Configuration & Housekeeping:

  • Added .vercelignore to exclude unnecessary files from deployment.
  • Added vercel.json to configure Vercel deployment for Storybook static output.
  • Updated tsconfig.app.json to include .mdx files for Storybook documentation support.

Linting & Release Workflow:

  • Integrated eslint-plugin-storybook for linting Storybook files and updated eslint.config.js accordingly.
  • Removed the legacy release workflow guide (RELEASE.md) as Storybook and new documentation supersede it.

Replaced vite.svg with new favicon assets and updated index.html to reference them. Added comprehensive SEO and social sharing metadata, including Open Graph and Twitter tags, and included a site manifest and og-image for improved branding and discoverability.
Integrates Storybook with React Vite by adding configuration files and updating scripts in package.json. Adds Storybook-related files to .gitignore and .vercelignore, updates eslint config for Storybook linting, enhances index.html with a welcome message, and removes RELEASE.md. Also updates dependencies to include Storybook and related packages.
Enhanced the README with a new logo, improved project description, updated installation and usage instructions to use the @acadxp/xpui package, added badges, expanded feature list, and included development and contribution guidelines. This update provides clearer guidance for users and contributors, and better reflects the project's branding and capabilities.
@Lil-Code30 Lil-Code30 merged commit 443520c into main Nov 8, 2025
1 check passed
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