@delmaredigital/payload-puck 0.2.0 → 0.3.0

package/README.md

@@ -9,17 +9,14 @@ A PayloadCMS plugin for integrating [Puck](https://puckeditor.com) visual page b
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Styling Setup](#styling-setup)
-- [Setup Checklist](#setup-checklist)
 - [Core Concepts](#core-concepts)
 - [Components](#components)
-- [Configuration](#configuration)
 - [Custom Fields](#custom-fields)
 - [Theming](#theming)
 - [Layouts](#layouts)
-- [API Routes](#api-routes)
-- [SEO Fields](#seo-fields)
-- [Plugin Options](#plugin-options)
+- [Page-Tree Integration](#page-tree-integration)
 - [Hybrid Integration](#hybrid-integration)
+- [Advanced Configuration](#advanced-configuration)
 - [License](#license)
 
 ---
@@ -32,65 +29,24 @@ A PayloadCMS plugin for integrating [Puck](https://puckeditor.com) visual page b
 |------------|---------|---------|
 | `@measured/puck` | >= 0.20.0 | Visual editor core |
 | `payload` | >= 3.0.0 | CMS backend |
-| `next` | >= 15.4.8 | React framework |
+| `@payloadcms/next` | >= 3.0.0 | Payload Next.js integration |
+| `next` | >= 14.0.0 | React framework |
 | `react` | >= 18.0.0 | UI library |
 | `@tailwindcss/typography` | >= 0.5.0 | RichText component styling |
 
-> **⚠️ Don't skip the styling setup!** After Quick Start, you must configure Tailwind to scan this package. See [Styling Setup](#styling-setup).
-
 ### Install
 
 ```bash
 pnpm add @delmaredigital/payload-puck @measured/puck
 ```
 
-Or install from GitHub:
-
-```bash
-pnpm add github:delmaredigital/payload-puck#main @measured/puck
-```
-
 ---
 
 ## Quick Start
 
-> **📋 Important:** After completing these steps, continue to [Styling Setup](#styling-setup) and verify with the [Setup Checklist](#setup-checklist).
-
-<details>
-<summary><strong>Option A: Copy Boilerplate (Fastest)</strong></summary>
-
-The package includes ready-to-use example files:
-
-```bash
-# Copy API routes
-cp -r node_modules/@delmaredigital/payload-puck/examples/api/puck src/app/api/
-
-# Copy editor layout (REQUIRED - imports Tailwind CSS) and page
-mkdir -p src/app/\(manage\)/pages/\[id\]/edit
-cp node_modules/@delmaredigital/payload-puck/examples/app/\(manage\)/layout.tsx src/app/\(manage\)/
-cp node_modules/@delmaredigital/payload-puck/examples/app/pages/\[id\]/edit/page.tsx src/app/\(manage\)/pages/\[id\]/edit/
-
-# Copy frontend routes (homepage + dynamic pages)
-mkdir -p src/app/\(frontend\)
-cp node_modules/@delmaredigital/payload-puck/examples/app/\(frontend\)/page.tsx src/app/\(frontend\)/
-mkdir -p src/app/\(frontend\)/\[...slug\]
-cp node_modules/@delmaredigital/payload-puck/examples/app/\[...slug\]/page.tsx src/app/\(frontend\)/\[...slug\]/
-
-# Copy theme config (optional)
-mkdir -p src/lib
-cp node_modules/@delmaredigital/payload-puck/examples/lib/puck-theme.ts src/lib/
-```
-
-> **Important:** Update the CSS import path in `src/app/(manage)/layout.tsx` to match your project's globals.css location.
-
-See `examples/README.md` for detailed customization instructions.
-
-</details>
-
-<details>
-<summary><strong>Option B: Manual Setup</strong></summary>
+The plugin integrates directly into Payload's admin UI with minimal configuration. API endpoints and admin views are registered automatically.
 
-#### Step 1: Add the Plugin
+### Step 1: Add the Plugin
 
 ```typescript
 // payload.config.ts
@@ -107,254 +63,146 @@ export default buildConfig({
 })
 ```
 
-#### Step 2: Create API Routes
-
-```typescript
-// app/api/puck/pages/route.ts
-import { createPuckApiRoutes } from '@delmaredigital/payload-puck/api'
-import { getPayload } from 'payload'
-import config from '@payload-config'
-import { headers } from 'next/headers'
-
-export const { GET, POST } = createPuckApiRoutes({
-  collection: 'pages',
-  payloadConfig: config,
-  auth: {
-    authenticate: async (request) => {
-      const payload = await getPayload({ config })
-      const { user } = await payload.auth({ headers: await headers() })
-      if (!user) return { authenticated: false }
-      return { authenticated: true, user: { id: user.id } }
-    },
-  },
-})
-```
-
-```typescript
-// app/api/puck/pages/[id]/route.ts
-import { createPuckApiRoutesWithId } from '@delmaredigital/payload-puck/api'
-import config from '@payload-config'
-
-export const { GET, PATCH, DELETE } = createPuckApiRoutesWithId({
-  collection: 'pages',
-  payloadConfig: config,
-  auth: {
-    authenticate: async (request) => {
-      // Same auth logic as above
-    },
-  },
-})
-```
-
-#### Step 3: Create the Editor Layout & Page
+This automatically:
+- Creates a `pages` collection with Puck fields (or adds fields to your existing collection)
+- Registers API endpoints at `/api/puck/:collection`
+- Adds the Puck editor view at `/admin/puck-editor/:collection/:id`
+- Adds "Edit with Puck" buttons to the admin UI
 
-First, create a layout that imports your Tailwind CSS:
+### Step 2: Provide Puck Configuration
 
-```typescript
-// app/(manage)/layout.tsx
-import '@/app/(frontend)/globals.css' // Adjust path to your CSS
-
-export const metadata = {
-  title: 'Puck Editor',
-  description: 'Visual page editor',
-}
-
-export default function ManageLayout({ children }: { children: React.ReactNode }) {
-  return (
-    // data-theme may be required if your CSS hides content until theme is set
-    <html lang="en" data-theme="light">
-      <body>{children}</body>
-    </html>
-  )
-}
-```
-
-Then create the editor page:
+Wrap your app with `PuckConfigProvider` to supply the Puck configuration. This is required because Puck configs contain React components that cannot be serialized from server to client.
 
 ```typescript
-// app/(manage)/pages/[id]/edit/page.tsx
-'use client'
-
-import { PuckEditorView } from '@delmaredigital/payload-puck/editor'
+// app/(app)/layout.tsx (covers both admin and frontend)
+import { PuckConfigProvider } from '@delmaredigital/payload-puck/client'
 import { editorConfig } from '@delmaredigital/payload-puck/config/editor'
 
-export default function EditorPage() {
+export default function RootLayout({ children }: { children: React.ReactNode }) {
   return (
-    <PuckEditorView
-      config={editorConfig}
-      collectionSlug="pages"
-      apiBasePath="/api/puck"
-      backUrl="/admin/collections/pages"
-      previewUrl={(slug) => `/${slug}`}
-    />
+    <html lang="en">
+      <body>
+        <PuckConfigProvider config={editorConfig}>
+          {children}
+        </PuckConfigProvider>
+      </body>
+    </html>
   )
 }
 ```
 
-The editor includes:
-- **Save Draft** - Saves without publishing
-- **Publish** - Publishes the page
-- **Draft/Published badge** - Shows current document status
-- **Unsaved changes warning** - Prevents accidental navigation
-- **Heading Analyzer** - WCAG-compliant heading outline visualization (enabled by default)
-
-**Heading Analyzer Plugin**
-
-The heading analyzer plugin is included by default and displays a heading outline in the editor sidebar. It helps identify accessibility issues like skipped heading levels (e.g., jumping from H1 to H3).
-
-To add additional plugins or disable the default:
+### Step 3: Create a Frontend Route
 
-```typescript
-// Add additional plugins (headingAnalyzer is still included)
-<PuckEditorView
-  plugins={[myCustomPlugin]}
-  // ...
-/>
-
-// Disable all default plugins
-<PuckEditorView
-  plugins={false}
-  // ...
-/>
-```
+The plugin can't auto-create frontend routes (Next.js App Router is file-based), but here's copy-paste ready code:
 
-#### Step 4: Create a Frontend Route
+<details>
+<summary><strong>📄 app/(frontend)/[[...slug]]/page.tsx</strong> (click to expand)</summary>
 
 ```typescript
-// app/(frontend)/[...slug]/page.tsx
 import { getPayload } from 'payload'
 import config from '@payload-config'
 import { PageRenderer } from '@delmaredigital/payload-puck/render'
 import { baseConfig } from '@delmaredigital/payload-puck/config'
 import { notFound } from 'next/navigation'
+import type { Metadata } from 'next'
 
-export default async function Page({ params }: { params: Promise<{ slug: string[] }> }) {
-  const { slug } = await params
+// Fetch page by slug (or homepage if no slug)
+async function getPage(slug?: string[]) {
   const payload = await getPayload({ config })
+  const slugPath = slug?.join('/') || ''
 
+  // Try to find by slug, or find homepage
   const { docs } = await payload.find({
     collection: 'pages',
-    where: { slug: { equals: slug.join('/') } },
+    where: slugPath
+      ? { slug: { equals: slugPath } }
+      : { isHomepage: { equals: true } },
     limit: 1,
   })
 
-  const page = docs[0]
+  return docs[0] || null
+}
+
+// Generate metadata from page SEO fields
+export async function generateMetadata({
+  params
+}: {
+  params: Promise<{ slug?: string[] }>
+}): Promise<Metadata> {
+  const { slug } = await params
+  const page = await getPage(slug)
+
+  if (!page) return {}
+
+  return {
+    title: page.meta?.title || page.title,
+    description: page.meta?.description,
+  }
+}
+
+// Render the page
+export default async function Page({
+  params
+}: {
+  params: Promise<{ slug?: string[] }>
+}) {
+  const { slug } = await params
+  const page = await getPage(slug)
+
   if (!page) notFound()
 
   return <PageRenderer config={baseConfig} data={page.puckData} />
 }
 ```
 
-#### Step 5: Enable Version History (Optional)
-
-```typescript
-// app/api/puck/pages/[id]/versions/route.ts
-import { createPuckApiRoutesVersions } from '@delmaredigital/payload-puck/api'
-import config from '@payload-config'
+</details>
 
-export const { GET, POST } = createPuckApiRoutesVersions({
-  collection: 'pages',
-  payloadConfig: config,
-  auth: {
-    authenticate: async (request) => {
-      // Same auth logic as your main routes
-    },
-  },
-})
-```
+> **Note:** The `[[...slug]]` pattern with double brackets makes the slug optional, so this handles both `/` (homepage) and `/any/path`.
 
-The History button automatically appears when this route exists.
+### That's It!
 
-</details>
+- The plugin registers the editor view at `/admin/puck-editor/:collection/:id`
+- "Edit with Puck" buttons appear in the collection list view
+- The editor runs inside Payload's admin UI with full navigation
+- API endpoints are handled automatically via Payload's endpoint system
 
 ---
 
 ## Styling Setup
 
-> **⚠️ This section is critical.** Without proper styling setup, components will render with broken or missing styles.
-
-<details>
-<summary><strong>⚠️ Tailwind Typography</strong> — Required for RichText component</summary>
+### Tailwind Typography (Required)
 
-The RichText component uses the `prose` class from `@tailwindcss/typography`. **Without this, rich text content will be unstyled** — no proper heading sizes, list styles, blockquote formatting, etc.
+The RichText component uses `@tailwindcss/typography`:
 
 ```bash
 pnpm add @tailwindcss/typography
 ```
 
-**Tailwind v4** — Add the `@plugin` directive to your main CSS file:
-
+**Tailwind v4:**
 ```css
 @import "tailwindcss";
 @plugin "@tailwindcss/typography";
 ```
 
-**Tailwind v3** — Add to your Tailwind config:
-
+**Tailwind v3:**
 ```javascript
 // tailwind.config.js
 module.exports = {
-  plugins: [
-    require('@tailwindcss/typography'),
-  ],
+  plugins: [require('@tailwindcss/typography')],
 }
 ```
 
-</details>
-
-<details>
-<summary><strong>⚠️ Tailwind Source Scanning</strong> — Required for component styles</summary>
-
-**Without this, Tailwind won't include the plugin's CSS classes in your build.** Components will have missing styles.
+### Package Scanning (Required)
 
-The `@source` directive (v4) or `content` path (v3) tells Tailwind to scan the package for class names.
-
-**Tailwind v4**
-
-The path is relative to your CSS file's location and must resolve to your project's `node_modules`:
-
-| CSS file location | `@source` path |
-|-------------------|----------------|
-| `globals.css` (root) | `./node_modules/@delmaredigital/payload-puck` |
-| `src/globals.css` | `../node_modules/@delmaredigital/payload-puck` |
-| `src/styles/tailwind.css` | `../../node_modules/@delmaredigital/payload-puck` |
+Tell Tailwind to scan the plugin's components:
 
+**Tailwind v4:**
 ```css
-@import "tailwindcss";
-@plugin "@tailwindcss/typography";
-
-/* Adjust path based on your CSS file location */
+/* Adjust path relative to your CSS file */
 @source "../node_modules/@delmaredigital/payload-puck";
-
-@theme inline {
-  --color-background: var(--background);
-  --color-foreground: var(--foreground);
-  --color-primary: var(--primary);
-  --color-primary-foreground: var(--primary-foreground);
-  --color-secondary: var(--secondary);
-  --color-secondary-foreground: var(--secondary-foreground);
-  --color-muted: var(--muted);
-  --color-muted-foreground: var(--muted-foreground);
-  --color-accent: var(--accent);
-  --color-accent-foreground: var(--accent-foreground);
-  --color-destructive: var(--destructive);
-  --color-destructive-foreground: var(--destructive-foreground);
-  --color-border: var(--border);
-  --color-input: var(--input);
-  --color-ring: var(--ring);
-  --color-popover: var(--popover);
-  --color-popover-foreground: var(--popover-foreground);
-  --color-card: var(--card);
-  --color-card-foreground: var(--card-foreground);
-  --radius-sm: calc(var(--radius) - 4px);
-  --radius-md: calc(var(--radius) - 2px);
-  --radius-lg: var(--radius);
-  --radius-xl: calc(var(--radius) + 4px);
-}
 ```
 
-**Tailwind v3**
-
+**Tailwind v3:**
 ```javascript
 // tailwind.config.js
 module.exports = {
@@ -365,118 +213,57 @@ module.exports = {
 }
 ```
 
-</details>
-
-<details>
-<summary><strong>⚠️ Theme CSS Variables</strong> — Required if not using shadcn/ui</summary>
-
-The field components use [shadcn/ui](https://ui.shadcn.com)-style CSS variables.
-
-**If you use shadcn/ui:** No action needed — components inherit your existing theme.
-
-**If you don't use shadcn/ui:** Copy the theme boilerplate:
-
-```bash
-cp node_modules/@delmaredigital/payload-puck/examples/styles/puck-theme.css src/styles/
-```
+### Theme CSS Variables
 
-Then import it:
+The plugin uses [shadcn/ui](https://ui.shadcn.com)-style CSS variables. If you don't use shadcn/ui, define these in your CSS:
 
 ```css
-@import './puck-theme.css';
+:root {
+  --background: 0 0% 100%;
+  --foreground: 222.2 84% 4.9%;
+  --primary: 222.2 47.4% 11.2%;
+  --primary-foreground: 210 40% 98%;
+  --secondary: 210 40% 96%;
+  --secondary-foreground: 222.2 47.4% 11.2%;
+  --muted: 210 40% 96%;
+  --muted-foreground: 215.4 16.3% 46.9%;
+  --accent: 210 40% 96%;
+  --accent-foreground: 222.2 47.4% 11.2%;
+  --destructive: 0 84.2% 60.2%;
+  --destructive-foreground: 210 40% 98%;
+  --border: 214.3 31.8% 91.4%;
+  --input: 214.3 31.8% 91.4%;
+  --ring: 222.2 84% 4.9%;
+  --radius: 0.5rem;
+}
 ```
 
-<details>
-<summary>CSS Variable Reference</summary>
-
-| Variable | Purpose |
-|----------|---------|
-| `--background` | Page background color |
-| `--foreground` | Default text color |
-| `--primary` | Primary buttons, active states |
-| `--primary-foreground` | Text on primary backgrounds |
-| `--secondary` | Secondary buttons |
-| `--secondary-foreground` | Text on secondary backgrounds |
-| `--muted` | Subtle backgrounds, disabled states |
-| `--muted-foreground` | Muted text |
-| `--accent` | Hover states |
-| `--accent-foreground` | Text on accent backgrounds |
-| `--destructive` | Error messages, delete buttons |
-| `--destructive-foreground` | Text on destructive backgrounds |
-| `--border` | General borders |
-| `--input` | Form input borders |
-| `--ring` | Focus rings |
-| `--popover` | Dropdown/modal backgrounds |
-| `--popover-foreground` | Text in popovers |
-| `--card` | Card backgrounds |
-| `--card-foreground` | Text in cards |
-| `--radius` | Base border radius |
-
-</details>
-
-</details>
-
----
-
-## Setup Checklist
-
-Use this checklist to verify your setup is complete.
-
-### ✅ Core Setup
-
-- [ ] Install packages: `@delmaredigital/payload-puck` and `@measured/puck`
-- [ ] Add `createPuckPlugin()` to your Payload config
-- [ ] Create API routes (`/api/puck/pages` and `/api/puck/pages/[id]`)
-- [ ] Create editor route layout that imports Tailwind CSS (see examples)
-- [ ] Create the editor page component with `PuckEditorView`
-- [ ] Create a frontend route with `PageRenderer`
-
-### ⚠️ Styling Setup
-
-- [ ] Install and configure `@tailwindcss/typography`
-- [ ] Add Tailwind `@source` directive (v4) or `content` path (v3)
-- [ ] Set up theme CSS variables (if not using shadcn/ui)
-
-### ⚙️ Collection Config
-
-- [ ] Enable `versions: { drafts: true }` on your pages collection
-
-### 📦 Optional
-
-- [ ] Version history API route (`/api/puck/pages/[id]/versions`)
-- [ ] Custom theme configuration via `ThemeProvider`
-- [ ] Custom layouts with headers/footers
-- [ ] Custom components
-
 ---
 
-<details>
-<summary><strong>Core Concepts</strong> — Server vs Client configs, Draft system</summary>
+## Core Concepts
 
 ### Server vs Client Configuration
 
-The plugin provides two configurations to handle React Server Components:
+The plugin provides two configurations for React Server Components:
 
 | Config | Import | Use Case |
 |--------|--------|----------|
 | `baseConfig` | `@delmaredigital/payload-puck/config` | Server-safe rendering with `PageRenderer` |
-| `editorConfig` | `@delmaredigital/payload-puck/config/editor` | Client-side editing with full TipTap support |
+| `editorConfig` | `@delmaredigital/payload-puck/config/editor` | Client-side editing with full interactivity |
 
 ```typescript
 // Server component - use baseConfig
 import { baseConfig } from '@delmaredigital/payload-puck/config'
 <PageRenderer config={baseConfig} data={page.puckData} />
 
-// Client component - use editorConfig
+// PuckConfigProvider - use editorConfig
 import { editorConfig } from '@delmaredigital/payload-puck/config/editor'
-<PuckEditor config={editorConfig} ... />
+<PuckConfigProvider config={editorConfig}>
 ```
 
 ### Draft System
 
-The editor uses Payload's native draft system.
-
-> **⚠️ Required:** Without `drafts: true`, the Save Draft and Publish buttons won't work correctly.
+The editor uses Payload's native draft system. The plugin automatically enables drafts on the pages collection. You can also enable it manually:
 
 ```typescript
 {
@@ -487,978 +274,306 @@ The editor uses Payload's native draft system.
 }
 ```
 
-</details>
-
 ---
 
-<details>
-<summary><strong>Components</strong> — Layout, Typography, Media, Interactive</summary>
+## Components
 
 ### Layout
 
-| Component | Description | Responsive Controls |
-|-----------|-------------|---------------------|
-| **Container** | Content wrapper with max-width and background options | Dimensions, Padding, Margin, Visibility |
-| **Flex** | Flexible box layout with direction and alignment | Dimensions, Padding, Margin, Visibility |
-| **Grid** | CSS Grid layout with responsive columns | Dimensions, Padding, Margin, Visibility |
-| **Section** | Full-width section with slot for nested content | Dimensions, Padding, Margin, Visibility |
-| **Spacer** | Vertical/horizontal spacing element | Visibility |
-| **Template** | Reusable component arrangements - save and load templates | Dimensions, Padding, Margin, Visibility |
+| Component | Description |
+|-----------|-------------|
+| **Container** | Content wrapper with max-width and background |
+| **Flex** | Flexible box layout with direction and alignment |
+| **Grid** | CSS Grid layout with responsive columns |
+| **Section** | Two-layer: full-bleed section + constrained content area |
+| **Spacer** | Vertical/horizontal spacing element |
+| **Template** | Save/load reusable component arrangements |
 
 ### Typography
 
-| Component | Description | Responsive Controls |
-|-----------|-------------|---------------------|
-| **Heading** | H1-H6 headings with size and alignment options | — |
-| **Text** | Paragraph text with styling options | — |
-| **RichText** | TipTap-powered WYSIWYG editor | — |
-
-> **⚠️ RichText requires `@tailwindcss/typography`** — see [Styling Setup](#styling-setup). Without it, content renders without proper formatting.
-
-### Media
+| Component | Description |
+|-----------|-------------|
+| **Heading** | H1-H6 headings with size and alignment |
+| **Text** | Paragraph text with styling options |
+| **RichText** | TipTap-powered WYSIWYG editor |
 
-| Component | Description | Responsive Controls |
-|-----------|-------------|---------------------|
-| **Image** | Responsive image with alt text and sizing | Visibility |
+### Media & Interactive
 
-### Interactive
-
-| Component | Description | Responsive Controls |
-|-----------|-------------|---------------------|
-| **Button** | Styled button/link with variants | — |
-| **Card** | Content card with optional image header | — |
-| **Divider** | Horizontal rule with style options | — |
-| **Accordion** | Expandable content sections | — |
+| Component | Description |
+|-----------|-------------|
+| **Image** | Responsive image with alt text |
+| **Button** | Styled button/link with variants |
+| **Card** | Content card with optional image |
+| **Divider** | Horizontal rule with styles |
+| **Accordion** | Expandable content sections |
 
 ### Responsive Controls
 
-Components with responsive controls allow you to customize their behavior at different breakpoints (mobile, tablet, desktop). Available controls:
+Layout components support per-breakpoint customization:
+- **Dimensions** - Width, max-width, height constraints
+- **Padding/Margin** - Spacing per breakpoint
+- **Visibility** - Show/hide at specific breakpoints
 
-- **Dimensions** - Width, max-width, height constraints per breakpoint
-- **Padding** - Inner spacing per breakpoint
-- **Margin** - Outer spacing per breakpoint
-- **Visibility** - Show/hide components at specific breakpoints
+---
 
-Breakpoints follow Tailwind CSS conventions:
-| Breakpoint | Min Width | Description |
-|------------|-----------|-------------|
-| base | 0px | Mobile (default) |
-| sm | 640px | Small tablets |
-| md | 768px | Tablets |
-| lg | 1024px | Laptops |
-| xl | 1280px | Desktops |
+## Custom Fields
 
-### Template Component
+All fields are imported from `@delmaredigital/payload-puck/fields`.
 
-The Template component allows saving groups of components as reusable templates. The plugin automatically creates a `puck-templates` collection in Payload.
+### Field Reference
 
-**Saving a template:**
-1. Add a Template component to your page
-2. Add child components inside the Template slot
-3. Click "Save as Template" and give it a name/category
+| Field | Description |
+|-------|-------------|
+| **MediaField** | Payload media library integration |
+| **TiptapField** | Rich text editor with formatting |
+| **ColorPickerField** | Color picker with opacity and presets |
+| **BackgroundField** | Solid colors, gradients, images |
+| **PaddingField / MarginField** | Visual spacing editors |
+| **BorderField** | Border width, style, color, radius |
+| **DimensionsField** | Width/height with constraints |
+| **AlignmentField** | Text alignment options |
+| **AnimationField** | Entrance animations |
+| **ResponsiveVisibilityField** | Show/hide per breakpoint |
+| **FolderPickerField** | Hierarchical folder selection (page-tree) |
+| **PageSegmentField** | URL segment with slugification (page-tree) |
+| **SlugPreviewField** | Read-only computed slug (page-tree) |
+
+### Usage Example
+
+```typescript
+import { createMediaField, createBackgroundField, backgroundValueToCSS } from '@delmaredigital/payload-puck/fields'
+
+const HeroConfig = {
+  fields: {
+    image: createMediaField({ label: 'Background Image' }),
+    background: createBackgroundField({ label: 'Overlay' }),
+  },
+  render: ({ image, background }) => (
+    <section style={{ background: backgroundValueToCSS(background) }}>
+      {/* content */}
+    </section>
+  ),
+}
+```
 
-**Loading a template:**
-1. Add a Template component to your page
-2. Select a saved template from the dropdown
-3. The template's components are loaded into the slot
+### CSS Helper Functions
 
-</details>
+```typescript
+import {
+  backgroundValueToCSS,
+  dimensionsValueToCSS,
+  animationValueToCSS,
+  visibilityValueToCSS,
+} from '@delmaredigital/payload-puck/fields'
+```
 
 ---
 
-<details>
-<summary><strong>Configuration</strong> — Merging configs, Custom components</summary>
+## Theming
 
-### Merging Custom Components
+Customize button styles, color presets, and focus rings:
 
 ```typescript
-import { mergeConfigs } from '@delmaredigital/payload-puck/config'
-import { baseConfig } from '@delmaredigital/payload-puck/config'
-import { MyCustomComponent } from './components/MyCustomComponent'
+import { PageRenderer } from '@delmaredigital/payload-puck/render'
+import { ThemeProvider } from '@delmaredigital/payload-puck/theme'
 
-const customConfig = mergeConfigs({
-  base: baseConfig,
-  components: {
-    MyCustomComponent,
-  },
-  categories: {
-    custom: { title: 'Custom', components: ['MyCustomComponent'] },
+<ThemeProvider theme={{
+  buttonVariants: {
+    default: { classes: 'bg-primary text-white hover:bg-primary/90' },
+    secondary: { classes: 'bg-secondary text-foreground hover:bg-secondary/90' },
   },
-  exclude: ['Spacer'], // Optionally remove components
-})
+  focusRingColor: 'focus:ring-primary',
+  colorPresets: [
+    { hex: '#3b82f6', label: 'Brand Blue' },
+    { hex: '#10b981', label: 'Success' },
+  ],
+}}>
+  <PageRenderer config={baseConfig} data={page.puckData} />
+</ThemeProvider>
 ```
 
-### Creating Custom Components
-
-Components need two variants to work across server rendering and the editor:
-
-| File | Purpose | Used By |
-|------|---------|---------|
-| `MyComponent.server.tsx` | Server-safe render (no hooks/interactivity) | `baseConfig` → `PageRenderer` |
-| `MyComponent.tsx` or `.editor.tsx` | Full interactivity + field definitions | `editorConfig` → `PuckEditor` |
+---
 
-**Server variant** (`MyComponent.server.tsx`):
-- No `'use client'` directive
-- No React hooks (`useState`, `useEffect`, etc.)
-- No event handlers that require client JS
-- **If component has slots**: Must include `fields: { content: { type: 'slot' } }` (Puck needs this to transform slot data into a renderable component)
-- Other fields can be omitted (not used in rendering)
+## Layouts
 
-**Editor variant** (`MyComponent.tsx`):
-- Can use `'use client'` if needed
-- Full interactivity with hooks
-- Includes all `fields` for the Puck sidebar
+Define page layouts with headers, footers, and styling:
 
-<details>
-<summary><strong>Example: Interactive Component</strong></summary>
+```typescript
+// lib/puck-layouts.ts
+import type { LayoutDefinition } from '@delmaredigital/payload-puck/layouts'
+import { SiteHeader } from '@/components/header'
+import { SiteFooter } from '@/components/footer'
 
-```tsx
-// components/Tabs.server.tsx - Server-safe version
-import type { ComponentConfig } from '@measured/puck'
+export const siteLayouts: LayoutDefinition[] = [
+  {
+    value: 'default',
+    label: 'Default',
+    description: 'Standard page with header and footer',
+    maxWidth: '1200px',
+    header: SiteHeader,
+    footer: SiteFooter,
+    stickyHeaderHeight: 80,
+  },
+  {
+    value: 'landing',
+    label: 'Landing',
+    description: 'Full-width landing page',
+    fullWidth: true,
+  },
+]
+```
 
-export interface TabsProps {
-  items: { title: string; content: string }[]
-  defaultTab: number
-}
+Pass layouts to the `PuckConfigProvider`:
 
-export const TabsConfig: ComponentConfig<TabsProps> = {
-  label: 'Tabs',
-  defaultProps: {
-    items: [{ title: 'Tab 1', content: 'Content 1' }],
-    defaultTab: 0,
-  },
-  // No fields - server version only renders
-  render: ({ items, defaultTab }) => (
-    <div>
-      {/* Render only the default tab statically */}
-      <div className="flex border-b">
-        {items.map((item, i) => (
-          <div key={i} className={i === defaultTab ? 'border-b-2 border-primary' : ''}>
-            {item.title}
-          </div>
-        ))}
-      </div>
-      <div>{items[defaultTab]?.content}</div>
-    </div>
-  ),
-}
+```typescript
+<PuckConfigProvider config={editorConfig} layouts={siteLayouts}>
+  {children}
+</PuckConfigProvider>
 ```
 
-```tsx
-// components/Tabs.tsx - Editor version with interactivity
-'use client'
+And use them with `PageRenderer`:
 
-import type { ComponentConfig } from '@measured/puck'
-import { useState } from 'react'
+```typescript
+import { LayoutWrapper } from '@delmaredigital/payload-puck/layouts'
 
-export interface TabsProps {
-  items: { title: string; content: string }[]
-  defaultTab: number
-}
+const layout = siteLayouts.find(l => l.value === page.puckData?.root?.props?.pageLayout)
 
-export const TabsConfig: ComponentConfig<TabsProps> = {
-  label: 'Tabs',
-  fields: {
-    items: {
-      type: 'array',
-      label: 'Tabs',
-      arrayFields: {
-        title: { type: 'text', label: 'Title' },
-        content: { type: 'textarea', label: 'Content' },
-      },
-    },
-    defaultTab: { type: 'number', label: 'Default Tab' },
-  },
-  defaultProps: {
-    items: [{ title: 'Tab 1', content: 'Content 1' }],
-    defaultTab: 0,
-  },
-  render: ({ items, defaultTab }) => {
-    const [activeTab, setActiveTab] = useState(defaultTab)
-
-    return (
-      <div>
-        <div className="flex border-b">
-          {items.map((item, i) => (
-            <button
-              key={i}
-              onClick={() => setActiveTab(i)}
-              className={i === activeTab ? 'border-b-2 border-primary' : ''}
-            >
-              {item.title}
-            </button>
-          ))}
-        </div>
-        <div>{items[activeTab]?.content}</div>
-      </div>
-    )
-  },
-}
+<LayoutWrapper layout={layout}>
+  <PageRenderer config={baseConfig} data={page.puckData} />
+</LayoutWrapper>
 ```
 
-Then register both:
-```tsx
-// In your custom baseConfig
-import { TabsConfig } from './components/Tabs.server'
+---
 
-// In your custom editorConfig
-import { TabsConfig } from './components/Tabs'
-```
-</details>
+## Page-Tree Integration
 
-<details>
-<summary><strong>Example: Component with Slot (nested components)</strong></summary>
+When `@delmaredigital/payload-page-tree` is detected, the plugin automatically adds folder management to the Puck sidebar.
 
-```tsx
-// components/Card.server.tsx - Server-safe version WITH slot field
-import type { ComponentConfig } from '@measured/puck'
+### How It Works
 
-export interface CardProps {
-  content: unknown // Slot for nested components
-  title: string
-}
+The plugin checks if your collection has a `pageSegment` field (page-tree's signature). When detected:
 
-export const CardConfig: ComponentConfig<CardProps> = {
-  label: 'Card',
-  // CRITICAL: Slot field MUST be defined for Puck to transform data into component
-  fields: {
-    content: { type: 'slot' },
-  },
-  defaultProps: {
-    content: [],
-    title: 'Card Title',
-  },
-  render: ({ content: Content, title }) => (
-    <div className="border rounded-lg p-4">
-      <h3 className="font-bold mb-2">{title}</h3>
-      <Content /> {/* Renders nested components */}
-    </div>
-  ),
-}
-```
+1. **Folder Picker** - Select a folder from the hierarchy
+2. **Page Segment** - Edit the page's URL segment
+3. **Slug Preview** - See the computed slug (folder path + segment)
 
-```tsx
-// components/Card.tsx - Editor version with all fields
-import type { ComponentConfig } from '@measured/puck'
+### Configuration
 
-export interface CardProps {
-  content: unknown
-  title: string
-}
+```typescript
+createPuckPlugin({
+  // Auto-detect (default)
+  pageTreeIntegration: undefined,
 
-export const CardConfig: ComponentConfig<CardProps> = {
-  label: 'Card',
-  fields: {
-    title: { type: 'text', label: 'Title' },
-    content: { type: 'slot' },
-  },
-  defaultProps: {
-    content: [],
-    title: 'Card Title',
+  // Explicitly enable with custom config
+  pageTreeIntegration: {
+    folderSlug: 'payload-folders',
+    pageSegmentFieldName: 'pageSegment',
   },
-  render: ({ content: Content, title }) => (
-    <div className="border rounded-lg p-4">
-      <h3 className="font-bold mb-2">{title}</h3>
-      <Content />
-    </div>
-  ),
-}
+
+  // Explicitly disable
+  pageTreeIntegration: false,
+})
 ```
 
-**Why slots need the field definition:** Puck stores slot content as an array of component data. The `fields: { content: { type: 'slot' } }` tells Puck to transform this array into a renderable `<Content />` component before passing it to `render()`. Without this, you'll get "Element type is invalid: got array" errors.
-</details>
+### Performance
 
-</details>
+Detection is instant - it reads the in-memory collection config, no database queries.
 
 ---
 
-<details>
-<summary><strong>Custom Fields</strong> — 19 field types with usage examples</summary>
+## Hybrid Integration
 
-All fields are imported from `@delmaredigital/payload-puck/fields`.
+Add Puck to existing collections with legacy blocks.
 
-### Field Reference
+### Automatic (Recommended)
 
-| Field | Description |
-|-------|-------------|
-| **MediaField** | Payload media library integration with upload/browse |
-| **TiptapField** | Rich text editor with formatting toolbar |
-| **ColorPickerField** | Color picker with presets and transparency |
-| **BackgroundField** | Backgrounds with solid colors, gradients, and images |
-| **PaddingField** | Visual padding editor with per-side controls |
-| **MarginField** | Visual margin editor with per-side controls |
-| **BorderField** | Border editor with width, style, color, radius |
-| **DimensionsField** | Width/height with min/max constraints |
-| **SizeField** | Preset sizes (sm, md, lg) or custom values |
-| **AlignmentField** | Text alignment (left, center, right, justify) |
-| **JustifyContentField** | Flexbox justify-content options |
-| **AlignItemsField** | Flexbox align-items options |
-| **VerticalAlignmentField** | Vertical alignment (top, center, bottom) |
-| **LockedTextField** | Protected text field with edit confirmation |
-| **LockedRadioField** | Protected radio field with edit confirmation |
-| **ResponsiveField** | Per-breakpoint values for responsive design |
-| **ResponsiveVisibilityField** | Show/hide toggle per breakpoint (Divi/Elementor-style) |
-| **AnimationField** | Entrance animations with easing/duration |
-| **TransformField** | CSS transforms (rotate, scale, translate) |
-| **GradientEditor** | Visual gradient builder |
-
-### Usage Examples
-
-<details>
-<summary><strong>MediaField</strong></summary>
-
-Integrates with Payload's media collection:
-
-```typescript
-import { createMediaField } from '@delmaredigital/payload-puck/fields'
-
-const config = {
-  components: {
-    Hero: {
-      fields: {
-        backgroundImage: createMediaField({
-          label: 'Background Image',
-          collection: 'media', // Default: 'media'
-        }),
-      },
-    },
-  },
-}
-```
-</details>
-
-<details>
-<summary><strong>TiptapField</strong></summary>
-
-Rich text editor with formatting toolbar:
-
-```typescript
-import { createTiptapField } from '@delmaredigital/payload-puck/fields'
-
-const config = {
-  components: {
-    TextBlock: {
-      fields: {
-        content: createTiptapField({ label: 'Content' }),
-      },
-    },
-  },
-}
-```
-</details>
-
-<details>
-<summary><strong>ColorPickerField</strong></summary>
-
-Color picker with presets and alpha channel:
-
-```typescript
-import { createColorPickerField } from '@delmaredigital/payload-puck/fields'
-
-const config = {
-  components: {
-    Section: {
-      fields: {
-        backgroundColor: createColorPickerField({
-          label: 'Background Color',
-        }),
-      },
-    },
-  },
-}
-```
-</details>
-
-<details>
-<summary><strong>BackgroundField</strong></summary>
-
-Full background editor with solid colors, gradients, and images:
-
-```typescript
-import { createBackgroundField, backgroundValueToCSS } from '@delmaredigital/payload-puck/fields'
-
-const config = {
-  components: {
-    Section: {
-      fields: {
-        background: createBackgroundField({ label: 'Background' }),
-      },
-      render: ({ background }) => (
-        <section style={{ background: backgroundValueToCSS(background) }}>
-          {/* content */}
-        </section>
-      ),
-    },
-  },
-}
-```
-</details>
-
-<details>
-<summary><strong>DimensionsField</strong></summary>
-
-Width/height with min/max constraints and alignment:
-
-```typescript
-import { createDimensionsField, dimensionsValueToCSS } from '@delmaredigital/payload-puck/fields'
-
-const config = {
-  components: {
-    Container: {
-      fields: {
-        dimensions: createDimensionsField({ label: 'Size' }),
-      },
-      render: ({ dimensions, children }) => (
-        <div style={dimensionsValueToCSS(dimensions)}>
-          {children}
-        </div>
-      ),
-    },
-  },
-}
-```
-</details>
-
-<details>
-<summary><strong>PaddingField & MarginField</strong></summary>
-
-Visual spacing editors:
+If you already have a `pages` collection, the plugin adds only the Puck-specific fields:
 
 ```typescript
-import { createPaddingField, createMarginField } from '@delmaredigital/payload-puck/fields'
-
-const config = {
-  components: {
-    Box: {
-      fields: {
-        padding: createPaddingField({ label: 'Padding' }),
-        margin: createMarginField({ label: 'Margin' }),
-      },
-    },
-  },
-}
-```
-</details>
-
-<details>
-<summary><strong>LockedTextField & LockedRadioField</strong></summary>
-
-Protected fields that require confirmation before editing:
-
-```typescript
-import {
-  createLockedTextField,
-  createLockedRadioField,
-  lockedSlugField,      // Pre-built slug field
-  lockedHomepageField,  // Pre-built homepage toggle
-} from '@delmaredigital/payload-puck/fields'
-
-// Use pre-built fields
-const config = {
-  root: {
-    fields: {
-      slug: lockedSlugField,
-      isHomepage: lockedHomepageField,
+// payload.config.ts
+export default buildConfig({
+  collections: [
+    {
+      slug: 'pages',
+      fields: [
+        { name: 'title', type: 'text', required: true },
+        { name: 'layout', type: 'blocks', blocks: [HeroBlock, CTABlock] },
+      ],
     },
-  },
-}
-
-// Or create custom locked fields
-const customLockedField = createLockedTextField({
-  label: 'API Key',
-  placeholder: 'Enter API key',
-  warningMessage: 'Changing this will break integrations.',
+  ],
+  plugins: [
+    createPuckPlugin({ pagesCollection: 'pages' }),
+  ],
 })
 ```
-</details>
-
-<details>
-<summary><strong>AnimationField</strong></summary>
-
-Entrance animations with customizable timing:
-
-```typescript
-import { createAnimationField, getEntranceAnimationClasses } from '@delmaredigital/payload-puck/fields'
-
-const config = {
-  components: {
-    AnimatedSection: {
-      fields: {
-        animation: createAnimationField({ label: 'Entrance Animation' }),
-      },
-      render: ({ animation, children }) => (
-        <div className={getEntranceAnimationClasses(animation)}>
-          {children}
-        </div>
-      ),
-    },
-  },
-}
-```
-</details>
-
-<details>
-<summary><strong>ResponsiveField</strong></summary>
-
-Values that change per breakpoint:
-
-```typescript
-import { createResponsiveField, BREAKPOINTS } from '@delmaredigital/payload-puck/fields'
-
-const config = {
-  components: {
-    Grid: {
-      fields: {
-        columns: createResponsiveField({
-          label: 'Columns',
-          field: { type: 'number' },
-          defaultValue: { sm: 1, md: 2, lg: 3 },
-        }),
-      },
-    },
-  },
-}
-```
-</details>
-
-<details>
-<summary><strong>ResponsiveVisibilityField</strong></summary>
-
-Show/hide components at different breakpoints (like Divi/Elementor):
-
-```typescript
-import { createResponsiveVisibilityField, visibilityValueToCSS } from '@delmaredigital/payload-puck/fields'
-
-const config = {
-  components: {
-    MobileOnlyBanner: {
-      fields: {
-        visibility: createResponsiveVisibilityField({ label: 'Visibility' }),
-      },
-      render: ({ visibility, children }) => {
-        const visibilityCSS = visibilityValueToCSS(visibility, 'mobile-banner')
-        return (
-          <>
-            {visibilityCSS && <style>{visibilityCSS}</style>}
-            <div className="mobile-banner">{children}</div>
-          </>
-        )
-      },
-    },
-  },
-}
-```
-
-The field displays device icons with visibility toggles. Green = visible, Red = hidden at that breakpoint.
-</details>
-
-### CSS Helper Functions
-
-Convert field values to CSS:
-
-```typescript
-import {
-  backgroundValueToCSS,
-  dimensionsValueToCSS,
-  animationValueToCSS,
-  transformValueToCSS,
-  gradientValueToCSS,
-  sizeValueToCSS,
-  // Responsive helpers
-  responsiveValueToCSS,
-  visibilityValueToCSS,
-} from '@delmaredigital/payload-puck/fields'
-
-const styles = {
-  background: backgroundValueToCSS(background),
-  ...dimensionsValueToCSS(dimensions),
-  animation: animationValueToCSS(animation),
-  transform: transformValueToCSS(transform),
-}
-
-// Responsive values generate CSS media queries
-const uniqueId = 'my-component-123'
-const { baseStyles, mediaQueryCSS } = responsiveValueToCSS(
-  dimensions,           // ResponsiveValue<T> or T
-  dimensionsValueToCSS, // Converter function
-  uniqueId              // CSS class selector
-)
-
-// Visibility generates show/hide media queries
-const visibilityCSS = visibilityValueToCSS(visibility, uniqueId)
-
-// Render with media queries
-return (
-  <>
-    {mediaQueryCSS && <style>{mediaQueryCSS}</style>}
-    {visibilityCSS && <style>{visibilityCSS}</style>}
-    <div className={uniqueId} style={baseStyles}>{children}</div>
-  </>
-)
-```
-
-</details>
 
----
-
-<details>
-<summary><strong>Theming</strong> — Button variants, color presets, focus rings</summary>
-
-Customize button styles, color presets, and focus rings to match your design system.
-
-### Basic Usage
-
-Wrap your `PageRenderer` with `ThemeProvider` to apply custom theming:
-
-```typescript
-import { PageRenderer } from '@delmaredigital/payload-puck/render'
-import { ThemeProvider } from '@delmaredigital/payload-puck/theme'
-
-<ThemeProvider theme={{
-  buttonVariants: {
-    default: { classes: 'bg-primary text-primary-foreground hover:bg-primary/90' },
-    secondary: { classes: 'bg-secondary text-secondary-foreground hover:bg-secondary/90' },
-  },
-  focusRingColor: 'focus:ring-primary',
-}}>
-  <PageRenderer config={baseConfig} data={page.puckData} />
-</ThemeProvider>
-```
+The `editorVersion` field auto-detects whether pages use legacy blocks or Puck.
 
-### Using the Example Theme
+### Manual with `getPuckFields()`
 
 ```typescript
-import { ThemeProvider, exampleTheme } from '@delmaredigital/payload-puck/theme'
-
-<ThemeProvider theme={exampleTheme}>
-  <PageRenderer data={page.puckData} />
-</ThemeProvider>
-
-// Or customize specific values
-<ThemeProvider theme={{
-  ...exampleTheme,
-  focusRingColor: 'focus:ring-brand',
-}}>
-  <PageRenderer data={page.puckData} />
-</ThemeProvider>
-```
-
-### Theme Options
-
-| Option | Description |
-|--------|-------------|
-| `buttonVariants` | Button component variant styles (default, secondary, outline, ghost) |
-| `ctaButtonVariants` | CallToAction button styles (primary, secondary, outline) |
-| `ctaBackgroundStyles` | CallToAction background styles (default, dark, light) |
-| `colorPresets` | Color picker preset swatches |
-| `extendColorPresets` | If true, adds to defaults instead of replacing |
-| `focusRingColor` | Focus ring class (e.g., `focus:ring-primary`) |
-
-### Custom Color Presets
+import { getPuckFields } from '@delmaredigital/payload-puck'
 
-```typescript
-<ThemeProvider theme={{
-  colorPresets: [
-    { hex: '#3b82f6', label: 'Brand Blue' },
-    { hex: '#10b981', label: 'Success' },
-    { hex: '#ef4444', label: 'Danger' },
+export const Pages: CollectionConfig = {
+  slug: 'pages',
+  fields: [
+    { name: 'title', type: 'text' },
+    { name: 'layout', type: 'blocks', blocks: [...] },
+    ...getPuckFields({
+      includeSEO: true,
+      includeEditorVersion: true,
+      includePageLayout: true,
+    }),
   ],
-  extendColorPresets: false, // Replace defaults
-}}>
-  <PageRenderer data={page.puckData} />
-</ThemeProvider>
-```
-
-### Direct Theme Imports
-
-```typescript
-import {
-  ThemeProvider,
-  useTheme,
-  getVariantClasses,
-  DEFAULT_THEME,
-} from '@delmaredigital/payload-puck/theme'
-
-function MyButton({ variant }) {
-  const theme = useTheme()
-  const classes = getVariantClasses(theme.buttonVariants, variant)
-  return <button className={classes}>Click me</button>
 }
 ```
 
-</details>
-
----
-
-<details>
-<summary><strong>Layouts</strong> — Page structure, headers/footers, responsive controls</summary>
-
-The layout system controls page structure, max-width constraints, and optional header/footer rendering. Layouts are selected per-page in the Puck editor's "Page Setup" panel.
-
-### Built-in Layouts
-
-| Layout | Description |
-|--------|-------------|
-| **Default** | Standard page with max-width container (1200px) |
-| **Landing** | Full-width sections, no container constraints |
-| **Full Width** | Edge-to-edge content |
-
-### Defining Custom Layouts
+### Rendering Hybrid Pages
 
 ```typescript
-// lib/puck-layouts.ts
-import type { LayoutDefinition } from '@delmaredigital/payload-puck/layouts'
-import { SiteHeader } from '@/components/header'
-import { SiteFooter } from '@/components/footer'
-
-export const siteLayouts: LayoutDefinition[] = [
-  {
-    value: 'default',
-    label: 'Default',
-    description: 'Standard page with header and footer',
-    maxWidth: '1200px',
-    header: SiteHeader,
-    footer: SiteFooter,
-    editorBackground: '#ffffff',
-    editorDarkMode: false,
-    stickyHeaderHeight: 80,
-    // Default background for frontend (overridden by pageBackground in Puck)
-    styles: {
-      wrapper: {
-        background: 'var(--site-bg)',
-        backgroundAttachment: 'fixed',
-      },
-    },
-  },
-  {
-    value: 'landing',
-    label: 'Landing',
-    description: 'Full-width landing page',
-    fullWidth: true,
-    editorBackground: '#f8fafc',
-    styles: {
-      wrapper: {
-        background: 'linear-gradient(180deg, #f8fafc 0%, #e2e8f0 100%)',
-      },
-    },
-  },
-  {
-    value: 'full-width',
-    label: 'Full Width',
-    description: 'Edge-to-edge content',
-    fullWidth: true,
-  },
-]
-```
-
-> **Background priority:** If a user sets `pageBackground` in the Puck editor, it overrides the layout's `styles.wrapper.background`. This allows layouts to define sensible defaults while letting individual pages customize their appearance.
-
-### Using Layouts in the Editor
+import { HybridPageRenderer } from '@delmaredigital/payload-puck/render'
+import { LegacyBlockRenderer } from '@/components/LegacyBlockRenderer'
 
-```typescript
-import { PuckEditor } from '@delmaredigital/payload-puck/editor'
-import { siteLayouts } from '@/lib/puck-layouts'
-
-<PuckEditor
-  config={editorConfig}
-  pageId={page.id}
-  initialData={page.puckData}
-  layouts={siteLayouts}
+<HybridPageRenderer
+  page={page}
+  config={puckConfig}
+  legacyRenderer={(blocks) => <LegacyBlockRenderer blocks={blocks} />}
 />
 ```
 
-### Using Layouts on the Frontend
-
-```typescript
-import { PageRenderer } from '@delmaredigital/payload-puck/render'
-import { LayoutWrapper, DEFAULT_LAYOUTS } from '@delmaredigital/payload-puck/layouts'
-
-export default async function Page({ params }) {
-  const page = await getPage(params.slug)
-  const layout = DEFAULT_LAYOUTS.find(l => l.value === page.puckData?.root?.props?.pageLayout)
-
-  return (
-    <LayoutWrapper layout={layout}>
-      <PageRenderer config={baseConfig} data={page.puckData} />
-    </LayoutWrapper>
-  )
-}
-```
-
-### Layout Definition Options
-
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `value` | `string` | — | Unique identifier |
-| `label` | `string` | — | Display name in editor |
-| `description` | `string` | — | Optional description |
-| `maxWidth` | `string` | — | Container max-width (e.g., `'1200px'`) |
-| `fullWidth` | `boolean` | `false` | If true, no container constraints |
-| `classes` | `object` | — | CSS classes for wrapper/container/content |
-| `styles` | `object` | — | Inline styles for wrapper/container/content |
-| `header` | `ComponentType` | — | Header component for editor preview and frontend |
-| `footer` | `ComponentType` | — | Footer component for editor preview and frontend |
-| `editorBackground` | `string` | `'#ffffff'` | Background color/gradient for editor preview |
-| `editorDarkMode` | `boolean` | `false` | Whether to use dark mode styling in editor preview |
-| `stickyHeaderHeight` | `number` | — | Height in px of sticky/fixed header for proper content offset |
-| `stickyFooter` | `boolean` | `true` | Push footer to bottom of viewport even with minimal content. Set to `false` to let footer flow naturally after content |
-
-### Page-Level Settings
-
-The editor automatically includes page-level controls that allow overriding layout defaults per-page:
-
-| Field | Options | Description |
-|-------|---------|-------------|
-| `showHeader` | `default`, `show`, `hide` | Override header visibility for this page |
-| `showFooter` | `default`, `show`, `hide` | Override footer visibility for this page |
-| `pageBackground` | Background field | Custom page background color/gradient/image |
-| `pageMaxWidth` | Select | Override layout's max-width constraint |
-
-These settings appear in the editor's "Page Setup" panel and are applied in both the editor preview and frontend rendering.
-
-</details>
-
----
-
-<details>
-<summary><strong>API Routes</strong> — Auth configuration, root props mapping</summary>
-
-### Auth Configuration
-
-The API routes require an `auth` configuration with permission hooks:
-
-```typescript
-const auth = {
-  // Required: Authenticate the request
-  authenticate: async (request) => {
-    const session = await getSession(request)
-    if (!session?.user) return { authenticated: false }
-    return { authenticated: true, user: session.user }
-  },
-
-  // Optional permission hooks
-  canList: async (user) => ({ allowed: true }),
-  canView: async (user, pageId) => ({ allowed: true }),
-  canEdit: async (user, pageId) => ({ allowed: user.role === 'editor' }),
-  canPublish: async (user, pageId) => ({ allowed: user.role === 'admin' }),
-  canDelete: async (user, pageId) => ({ allowed: user.role === 'admin' }),
-}
-```
-
-### Root Props Mapping
-
-Sync Puck root.props to Payload fields automatically:
-
-```typescript
-createPuckApiRoutesWithId({
-  // ...
-  rootPropsMapping: [
-    { from: 'title', to: 'meta.title' },
-    { from: 'description', to: 'meta.description' },
-    { from: 'pageLayout', to: 'pageLayout' },
-  ],
-})
-```
-
-</details>
-
 ---
 
-<details>
-<summary><strong>SEO Fields</strong> — Robots meta, sitemap integration</summary>
-
-The plugin adds SEO-related fields to each page in the `meta` group:
-
-| Field | Type | Description |
-|-------|------|-------------|
-| `meta.title` | text | Page title for search engines |
-| `meta.description` | textarea | Meta description |
-| `meta.image` | upload | Social sharing image |
-| `meta.noindex` | checkbox | Prevent search engine indexing |
-| `meta.nofollow` | checkbox | Prevent search engines from following links |
-| `meta.excludeFromSitemap` | checkbox | Exclude page from XML sitemap |
-
-**These fields are not automatically wired to your frontend.** You need to implement them based on your setup.
-
-### Robots Meta (Next.js App Router)
-
-In your page's `generateMetadata` function:
-
-```typescript
-// app/(frontend)/[...slug]/page.tsx
-export async function generateMetadata({ params }): Promise<Metadata> {
-  const page = await getPage(params.slug)
-
-  return {
-    title: page.meta?.title || page.title,
-    description: page.meta?.description,
-    robots: {
-      index: !page.meta?.noindex,
-      follow: !page.meta?.nofollow,
-    },
-  }
-}
-```
-
-### Dynamic Sitemap
+## Advanced Configuration
 
-Filter out pages marked as excluded in your `sitemap.ts`:
+### Plugin Options
 
-```typescript
-// app/sitemap.ts
-import type { MetadataRoute } from 'next'
-import { getPayload } from 'payload'
-import config from '@payload-config'
-
-export default async function sitemap(): Promise<MetadataRoute.Sitemap> {
-  const baseUrl = 'https://yoursite.com'
-  const payload = await getPayload({ config })
-
-  const { docs: pages } = await payload.find({
-    collection: 'pages',
-    limit: 1000,
-    where: {
-      or: [
-        { 'meta.excludeFromSitemap': { equals: false } },
-        { 'meta.excludeFromSitemap': { exists: false } },
-      ],
-    },
-    select: {
-      slug: true,
-      updatedAt: true,
-    },
-  })
-
-  return pages.map((page) => ({
-    url: `${baseUrl}/${page.slug}`,
-    lastModified: new Date(page.updatedAt),
-  }))
-}
-```
-
-</details>
-
----
-
-<details>
-<summary><strong>Plugin Options</strong> — Collection config, access control</summary>
+| Option | Default | Description |
+|--------|---------|-------------|
+| `pagesCollection` | `'pages'` | Collection slug to use for pages |
+| `autoGenerateCollection` | `true` | Create the collection if it doesn't exist, or add Puck fields to existing |
+| `enableEndpoints` | `true` | Register API endpoints at `/api/puck/:collection` for the editor |
+| `enableAdminView` | `true` | Register the Puck editor view in Payload admin |
+| `adminViewPath` | `'/puck-editor'` | Path for the editor (full path: `/admin/puck-editor/:collection/:id`) |
+| `pageTreeIntegration` | auto-detect | Integration with `@delmaredigital/payload-page-tree` |
+| `layouts` | `undefined` | Layout definitions for page templates |
 
 ```typescript
 createPuckPlugin({
-  // Collection slug for pages (default: 'pages')
   pagesCollection: 'pages',
-
-  // Auto-generate the Pages collection (default: true)
   autoGenerateCollection: true,
+  enableEndpoints: true,
+  enableAdminView: true,
+  adminViewPath: '/puck-editor',
+  pageTreeIntegration: undefined, // auto-detects
 
-  // Override collection config
+  // Collection overrides (merged with generated collection)
   collectionOverrides: {
     admin: {
       defaultColumns: ['title', 'slug', 'updatedAt'],
     },
   },
 
-  // Custom access control
+  // Access control
   access: {
     read: () => true,
     create: ({ req }) => !!req.user,
@@ -1468,197 +583,61 @@ createPuckPlugin({
 })
 ```
 
-</details>
+### Custom API Routes (Advanced)
 
----
-
-<details>
-<summary><strong>Hybrid Integration</strong> — Add Puck to existing collections with legacy blocks</summary>
-
-If you have an existing Pages collection with legacy Payload blocks, you can add Puck support without replacing your collection.
-
-### Automatic (Recommended)
-
-If you already have a `pages` collection defined, the plugin automatically adds only the Puck-specific fields that don't already exist:
-
-```typescript
-// payload.config.ts
-import { buildConfig } from 'payload'
-import { createPuckPlugin } from '@delmaredigital/payload-puck/plugin'
-
-export default buildConfig({
-  collections: [
-    {
-      slug: 'pages',
-      fields: [
-        { name: 'title', type: 'text', required: true },
-        { name: 'slug', type: 'text', required: true },
-        { name: 'layout', type: 'blocks', blocks: [HeroBlock, CTABlock] },
-      ],
-    },
-  ],
-  plugins: [
-    createPuckPlugin({ pagesCollection: 'pages' }),
-  ],
-})
-```
-
-The plugin adds: `puckData`, `editorVersion`, `pageLayout`, `meta` (SEO fields), and the "Edit with Puck" button.
-
-**Smart detection:** The `editorVersion` field automatically detects whether existing pages use legacy blocks or Puck data. Pages with legacy blocks are marked `'legacy'`, pages with Puck content are marked `'puck'`, and new empty pages use the configured default. This prevents migrations from incorrectly overwriting existing content.
-
-### Manual with `getPuckFields()`
-
-For full control, disable auto-generation and use `getPuckFields()`:
-
-```typescript
-// collections/Pages.ts
-import type { CollectionConfig } from 'payload'
-import { getPuckFields } from '@delmaredigital/payload-puck'
-
-export const Pages: CollectionConfig = {
-  slug: 'pages',
-  versions: { drafts: true },
-  fields: [
-    { name: 'title', type: 'text', required: true },
-    { name: 'slug', type: 'text', required: true },
-    { name: 'layout', type: 'blocks', blocks: [HeroBlock, CTABlock] },
-
-    ...getPuckFields({
-      includeSEO: false,
-      includeConversion: true,
-      // Custom conversion types (optional - defaults to standard types)
-      conversionTypeOptions: [
-        { label: 'Registration', value: 'registration' },
-        { label: 'Donation', value: 'donation' },
-        { label: 'Course Start', value: 'course_start' },
-        { label: 'Custom', value: 'custom' },
-      ],
-      includeEditorVersion: true,
-      includePageLayout: true,
-      includeIsHomepage: false,
-      // Custom layouts (only value/label needed for the field)
-      layouts: [
-        { value: 'default', label: 'Default' },
-        { value: 'landing', label: 'Landing' },
-      ],
-    }),
-  ],
-}
-```
+If you need custom API route handling beyond the built-in endpoints, you can disable automatic endpoints and create your own:
 
 ```typescript
 // payload.config.ts
 createPuckPlugin({
-  pagesCollection: 'pages',
-  autoGenerateCollection: false,
+  enableEndpoints: false, // Disable built-in endpoints
 })
 ```
 
-### Individual Field Imports
+Then create custom routes using the provided factories:
 
 ```typescript
-import {
-  puckDataField,
-  editorVersionField,
-  createPageLayoutField,
-  seoFieldGroup,
-  conversionFieldGroup,
-} from '@delmaredigital/payload-puck'
-
-const Pages: CollectionConfig = {
-  slug: 'pages',
-  fields: [
-    puckDataField,
-    editorVersionField,
-    createPageLayoutField(myCustomLayouts),
-  ],
-}
-```
-
-### Rendering Hybrid Pages
-
-**Option A: Using `HybridPageRenderer` (Recommended)**
-
-The `HybridPageRenderer` component handles the branching logic for you:
-
-```typescript
-// app/(frontend)/[...slug]/page.tsx
-import { HybridPageRenderer } from '@delmaredigital/payload-puck/render'
-import { puckConfig } from '@/puck/config'
-import { siteLayouts } from '@/lib/puck-layouts'
-import { LegacyBlockRenderer } from '@/components/LegacyBlockRenderer'
-
-export default async function Page({ params }) {
-  const page = await getPage(params.slug)
-
-  return (
-    <HybridPageRenderer
-      page={page}
-      config={puckConfig}
-      layouts={siteLayouts}
-      legacyRenderer={(blocks) => <LegacyBlockRenderer blocks={blocks} />}
-    />
-  )
-}
-```
-
-**Option B: Manual Branching**
-
-For more control, handle the branching yourself:
-
-```typescript
-// app/(frontend)/[...slug]/page.tsx
-import { PageRenderer } from '@delmaredigital/payload-puck/render'
-import { puckConfig } from '@/puck/config'
-import { siteLayouts } from '@/lib/puck-layouts'
-import { LegacyBlockRenderer } from '@/components/LegacyBlockRenderer'
-
-export default async function Page({ params }) {
-  const page = await getPage(params.slug)
-
-  if (page.editorVersion === 'puck' && page.puckData) {
-    return (
-      <PageRenderer
-        config={puckConfig}
-        data={page.puckData}
-        layouts={siteLayouts}
-      />
-    )
-  }
+// app/api/puck/[collection]/route.ts
+import { createPuckApiRoutes } from '@delmaredigital/payload-puck/api'
+import { getPayload } from 'payload'
+import config from '@payload-config'
+import { headers } from 'next/headers'
 
-  return <LegacyBlockRenderer blocks={page.layout} />
-}
+export const { GET, POST } = createPuckApiRoutes({
+  payloadConfig: config,
+  auth: {
+    authenticate: async (request) => {
+      const payload = await getPayload({ config })
+      const { user } = await payload.auth({ headers: await headers() })
+      if (!user) return { authenticated: false }
+      return { authenticated: true, user: { id: user.id } }
+    },
+  },
+})
 ```
 
-### Available Field Exports
-
-| Export | Description |
-|--------|-------------|
-| `getPuckFields(options)` | Returns array of Puck fields based on options |
-| `puckDataField` | JSON field for Puck editor data (hidden) |
-| `editorVersionField` | Select field: 'legacy' \| 'puck' (auto-detects based on content) |
-| `createEditorVersionField(default, sidebar, legacyBlocksFieldName)` | Factory for custom editor version field |
-| `pageLayoutField` | Layout selector with DEFAULT_LAYOUTS |
-| `createPageLayoutField(layouts, sidebar)` | Factory for custom layout options |
-| `isHomepageField` | Checkbox for homepage designation |
-| `seoFieldGroup` | Group named `meta` with title, description, image, noindex, etc. |
-| `conversionFieldGroup` | Group for conversion tracking analytics (default types) |
-| `createConversionFieldGroup(types, sidebar)` | Factory for custom conversion types |
-| `DEFAULT_CONVERSION_TYPES` | Default conversion types array |
-| `generatePuckEditField(slug, config)` | Creates the "Edit with Puck" UI button |
-
-### Available Render Exports
-
-| Export | Description |
-|--------|-------------|
-| `PageRenderer` | Renders Puck data with layout support |
-| `HybridPageRenderer` | Renders either Puck or legacy pages based on `editorVersion` |
+---
 
-</details>
+## Export Reference
+
+| Export Path | Description |
+|-------------|-------------|
+| `@delmaredigital/payload-puck` | Plugin creation, field utilities |
+| `@delmaredigital/payload-puck/plugin` | `createPuckPlugin` |
+| `@delmaredigital/payload-puck/config` | `baseConfig`, `createConfig()`, `extendConfig()` |
+| `@delmaredigital/payload-puck/config/editor` | `editorConfig` for editing |
+| `@delmaredigital/payload-puck/client` | `PuckConfigProvider`, `usePuckConfig`, client components |
+| `@delmaredigital/payload-puck/rsc` | `PuckEditorView` for Payload admin views |
+| `@delmaredigital/payload-puck/render` | `PageRenderer`, `HybridPageRenderer` |
+| `@delmaredigital/payload-puck/fields` | Custom Puck fields and CSS helpers |
+| `@delmaredigital/payload-puck/components` | Component configs for custom configurations |
+| `@delmaredigital/payload-puck/theme` | `ThemeProvider`, theme utilities |
+| `@delmaredigital/payload-puck/layouts` | Layout definitions, `LayoutWrapper` |
+| `@delmaredigital/payload-puck/api` | API route factories (for custom implementations) |
+| `@delmaredigital/payload-puck/admin/client` | `EditWithPuckButton`, `EditWithPuckCell` |
 
 ---
 
 ## License
 
-MIT
+MIT