feat: launch docs site and release distribution workflow

Add a dedicated Next.js docs app, registry hosting automation, and CI/release workflows while aligning package and registry usage with the @DevsTool scope for npm and shadcn installation flows.

Co-authored-by: Cursor <cursoragent@cursor.com>

Author: noobships

.changeset/README.md

@@ -0,0 +1,21 @@
+# Changesets
+
+This project uses Changesets for versioning and release notes.
+
+## Create a changeset
+
+```bash
+pnpm changeset
+```
+
+## Apply version updates
+
+```bash
+pnpm version-packages
+```
+
+## Publish
+
+```bash
+pnpm release
+```

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+  push:
+    branches: [main]
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Type check
+        run: pnpm type-check
+
+      - name: Lint
+        run: pnpm lint
+
+      - name: Build package
+        run: pnpm build
+
+      - name: Build registry assets
+        run: pnpm registry:build
+
+      - name: Verify registry assets
+        run: pnpm registry:verify
+
+      - name: Build docs app
+        run: pnpm -C apps/www build
+
+      - name: Verification suite (without visual baseline)
+        run: pnpm verify
+        env:
+          SKIP_VISUAL: "1"

.github/workflows/release.yml

@@ -0,0 +1,44 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v4
+        with:
+          version: 10
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: pnpm
+          registry-url: https://registry.npmjs.org
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Create release PR or publish
+        uses: changesets/action@v1
+        with:
+          version: pnpm version-packages
+          publish: pnpm release
+          commit: "chore: version packages"
+          title: "chore: version packages"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -1,11 +1,16 @@
 # Dependencies
 node_modules
+.pnpm-store
+.pnpm-store/
 .pnp
 .pnp.js
 
 # Build outputs
 dist
 build
+.next
+apps/www/public/r
+apps/www/public/registry.json
 *.tsbuildinfo
 
 # Environment
@@ -34,6 +39,10 @@ pnpm-debug.log*
 # Testing
 coverage
 .nyc_output
+test-results
+test-results/
+playwright-report
+playwright-report/
 
 # Misc
 .cache

README.md

@@ -1,59 +1,105 @@
-# @shadcn/echarts
+# @devstool/shadcn-echarts
 
-Apache ECharts charts styled to match shadcn/ui's design language with full dark/light mode support and excellent developer experience.
+Apache ECharts components styled to match shadcn/ui design language with automatic light/dark theming, minimal defaults, and tree-shakeable chart exports.
 
-## 🚧 Work in Progress
+## What you get
 
-This package is currently under active development. Phase 1 (Core Package Setup) is complete.
+- shadcn-style visual language with CSS variable driven theming
+- Auto dark/light mode sync
+- Defaults-only minimal preset that does not override explicit styling
+- Tree-shakeable per-chart imports
+- npm package + shadcn registry distribution
 
-## Features
+## Installation methods
 
-- 🎨 **shadcn/ui Design Language**: Charts automatically match your shadcn/ui theme
-- 🌓 **Dark/Light Mode**: Seamless theme switching with automatic detection
-- 📦 **Tree-shakeable**: Import only what you need for optimal bundle size
-- 🔒 **Type-safe**: Full TypeScript support with ECharts' ComposeOption pattern
-- ⚡ **SSR Support**: Server-side rendering utilities included
-- 🎯 **Developer Experience**: Clean API with React hooks and utilities
+### 1) npm package
 
-## Installation
+```bash
+pnpm add @devstool/shadcn-echarts echarts react
+```
+
+### 2) shadcn direct URL install
 
 ```bash
-pnpm add @shadcn/echarts echarts react
+npx shadcn@latest add https://shadcn-echarts.vercel.app/r/bar-chart.json
 ```
 
-## Usage
+### 3) shadcn namespace install
+
+Add a registry namespace in your `components.json`:
+
+```json
+{
+  "registries": {
+    "@devstool": "https://shadcn-echarts.vercel.app/r/{name}.json"
+  }
+}
+```
+
+Then install by namespace:
+
+```bash
+npx shadcn@latest add @devstool/bar-chart
+```
 
-### Basic Example
+### 4) Manual source ownership
+
+Copy files from `registry/default/*` into your project and customize freely.
+
+## Usage
 
 ```tsx
-import { BarChart } from '@shadcn/echarts'
-import { useEChartsTheme } from '@shadcn/echarts/hooks'
+import { BarChart } from "@devstool/shadcn-echarts";
 
-function MyChart() {
-  const { theme } = useEChartsTheme()
-  
+export function MyChart() {
   return (
     <BarChart
-      data={[5, 20, 36, 10, 10, 20]}
-      categories={['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat']}
-      theme={theme}
+      option={{
+        xAxis: { type: "category", data: ["Mon", "Tue", "Wed"] },
+        yAxis: { type: "value" },
+        series: [{ type: "bar", data: [150, 230, 224] }],
+      }}
+      height={320}
     />
-  )
+  );
 }
 ```
 
-### Theme Setup
+## Local development
 
-```tsx
-import { registerShadcnThemes } from '@shadcn/echarts/themes'
+```bash
+# library build/watch
+pnpm build
+pnpm dev
+
+# registry assets for docs site
+pnpm registry:build
+pnpm registry:verify
 
-// Register themes on app initialization
-registerShadcnThemes()
+# public docs website
+pnpm www:dev
+pnpm www:build
+
+# interactive demo workspace
+pnpm -C demo dev
 ```
 
-## Documentation
+## Registry endpoints
+
+- Registry index: `/registry.json`
+- Registry items: `/r/<component>.json`
+
+On Vercel this resolves to:
+
+- `https://shadcn-echarts.vercel.app/registry.json`
+- `https://shadcn-echarts.vercel.app/r/bar-chart.json`
+
+## Project docs
 
-Full documentation coming soon. See the [implementation plan](.cursor/plans/shadcn-echarts_implementation_plan_44021a4f.plan.md) for current progress.
+- `docs/polish/style-spec.md`
+- `docs/polish/presets.md`
+- `docs/polish/theming.md`
+- `docs/release/vercel-github-checklist.md`
 
 ## License
 

apps/www/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": ["next/core-web-vitals"]
+}

apps/www/README.md

@@ -0,0 +1,17 @@
+# www
+
+Public docs website for shadcn-echarts.
+
+## Local development
+
+```bash
+pnpm registry:build
+pnpm -C apps/www dev
+```
+
+## Production build
+
+```bash
+pnpm registry:build
+pnpm -C apps/www build
+```

apps/www/app/components/page.tsx

@@ -0,0 +1,52 @@
+import { registryItemUrl } from "../../lib/site-config";
+
+const componentExamples = [
+  "area-chart",
+  "bar-chart",
+  "line-chart",
+  "pie-chart",
+  "radar-chart",
+  "scatter-chart",
+  "heatmap-chart",
+  "sankey-chart",
+  "treemap-chart",
+  "bar-3d-chart",
+  "globe-3d-chart",
+  "surface-3d-chart",
+];
+
+export default function ComponentsPage() {
+  return (
+    <>
+      <h1>Components and examples</h1>
+      <p className="lead">
+        Registry currently includes 36 chart components (2D + 3D/WebGL).
+      </p>
+
+      <h2>Install examples</h2>
+      {componentExamples.map((name) => (
+        <pre key={name}>
+          <code>{`npx shadcn@latest add ${registryItemUrl(name)}`}</code>
+        </pre>
+      ))}
+
+      <h2>Interactive demo</h2>
+      <p>
+        For broad example exploration, use the demo workspace in this repository:
+      </p>
+      <pre>
+        <code>{`pnpm -C demo dev`}</code>
+      </pre>
+      <p>
+        Demo source:{" "}
+        <a
+          href="https://github.com/noobships/shadcn-echarts/tree/main/demo"
+          target="_blank"
+          rel="noreferrer"
+        >
+          github.com/noobships/shadcn-echarts/tree/main/demo
+        </a>
+      </p>
+    </>
+  );
+}