fix(examples/live-preview): regenerates yarn lockfiles (#6356)

BREAKING:

`LexicalBlock`, `RichTextFieldRequiredEditor` and `FieldWithRichTextRequiredEditor` types have been removed. Instead of `LexicalBlock`, use `Block`. Instead of `RichTextFieldRequiredEditor`, use `RichTextField`. And instead of `FieldWithRichTextRequiredEditor`, use `Field`.

.eslintignore

@@ -8,7 +8,3 @@
 **/dist/**
 **/node_modules
 **/temp
-playwright.config.ts
-jest.config.js
-test/live-preview/next-app
-tsconfig.tsbuildinfo

.eslintrc.cjs

@@ -1,72 +0,0 @@
-/** @type {import('eslint').Linter.Config} */
-module.exports = {
-  extends: ['@payloadcms'],
-  ignorePatterns: ['README.md', 'packages/**/*.spec.ts'],
-  overrides: [
-    {
-      files: ['packages/**'],
-      plugins: ['payload'],
-      rules: {
-        'payload/no-jsx-import-statements': 'warn',
-        'payload/no-relative-monorepo-imports': 'error',
-        'payload/no-imports-from-exports-dir': 'error',
-      },
-    },
-    {
-      files: ['scripts/**'],
-      rules: {
-        '@typescript-eslint/no-unused-vars': 'off',
-        'no-console': 'off',
-        'perfectionist/sort-object-types': 'off',
-        'perfectionist/sort-objects': 'off',
-      },
-    },
-    {
-      extends: ['plugin:@typescript-eslint/disable-type-checked'],
-      files: ['*.js', '*.cjs', '*.json', '*.md', '*.yml', '*.yaml'],
-    },
-    {
-      files: ['packages/eslint-config-payload/**'],
-      rules: {
-        'perfectionist/sort-objects': 'off',
-      },
-    },
-    {
-      files: ['templates/vercel-postgres/**'],
-      rules: {
-        'no-restricted-exports': 'off',
-      },
-    },
-    {
-      files: ['package.json', 'tsconfig.json'],
-      rules: {
-        'perfectionist/sort-array-includes': 'off',
-        'perfectionist/sort-astro-attributes': 'off',
-        'perfectionist/sort-classes': 'off',
-        'perfectionist/sort-enums': 'off',
-        'perfectionist/sort-exports': 'off',
-        'perfectionist/sort-imports': 'off',
-        'perfectionist/sort-interfaces': 'off',
-        'perfectionist/sort-jsx-props': 'off',
-        'perfectionist/sort-keys': 'off',
-        'perfectionist/sort-maps': 'off',
-        'perfectionist/sort-named-exports': 'off',
-        'perfectionist/sort-named-imports': 'off',
-        'perfectionist/sort-object-types': 'off',
-        'perfectionist/sort-objects': 'off',
-        'perfectionist/sort-svelte-attributes': 'off',
-        'perfectionist/sort-union-types': 'off',
-        'perfectionist/sort-vue-attributes': 'off',
-      },
-    },
-  ],
-  parserOptions: {
-    project: ['./tsconfig.json'],
-    tsconfigRootDir: __dirname,
-    EXPERIMENTAL_useSourceOfProjectReferenceRedirect: true,
-    EXPERIMENTAL_useProjectService: true,
-    sourceType: 'module',
-    ecmaVersion: 'latest',
-  },
-  root: true,
-}

.eslintrc.js

@@ -0,0 +1,38 @@
+module.exports = {
+  extends: ['@payloadcms'],
+  overrides: [
+    {
+      extends: ['plugin:@typescript-eslint/disable-type-checked'],
+      files: ['*.js', '*.cjs', '*.json', '*.md', '*.yml', '*.yaml'],
+    },
+    {
+      files: ['packages/eslint-config-payload/**'],
+      rules: {
+        'perfectionist/sort-objects': 'off',
+      },
+    },
+    {
+      files: ['package.json', 'tsconfig.json'],
+      rules: {
+        'perfectionist/sort-array-includes': 'off',
+        'perfectionist/sort-astro-attributes': 'off',
+        'perfectionist/sort-classes': 'off',
+        'perfectionist/sort-enums': 'off',
+        'perfectionist/sort-exports': 'off',
+        'perfectionist/sort-imports': 'off',
+        'perfectionist/sort-interfaces': 'off',
+        'perfectionist/sort-jsx-props': 'off',
+        'perfectionist/sort-keys': 'off',
+        'perfectionist/sort-maps': 'off',
+        'perfectionist/sort-named-exports': 'off',
+        'perfectionist/sort-named-imports': 'off',
+        'perfectionist/sort-object-types': 'off',
+        'perfectionist/sort-objects': 'off',
+        'perfectionist/sort-svelte-attributes': 'off',
+        'perfectionist/sort-union-types': 'off',
+        'perfectionist/sort-vue-attributes': 'off',
+      },
+    },
+  ],
+  root: true,
+}

.git-blame-ignore-revs

@@ -16,6 +16,3 @@ fb7d1be2f3325d076b7c967b1730afcef37922c2
 
 # lint and format create-payload-app
 5fd3d430001efe86515262ded5e26f00c1451181
-
-# 3.0 prettier & lint everywhere
-6789e61488a1d3de56f472ac3214faf344030005

.github/CODEOWNERS

@@ -1,21 +1,23 @@
 # Order matters. The last matching pattern takes precedence.
 
-### Package Exports ###
-/**/exports/ @denolfe @jmikrut
+### Core ###
 
-### Packages ###
+### Adapters ###
 /packages/richtext-*/ @AlessioGr
+
+### Plugins ###
 /packages/plugin-cloud*/ @denolfe
-/packages/email-*/ @denolfe
-/packages/storage-*/ @denolfe
-/packages/create-payload-app/ @denolfe
-/packages/eslint-*/ @denolfe
 
 ### Templates ###
 /templates/ @jacobsfletch @denolfe
 
+### Misc ###
+/packages/create-payload-app/ @denolfe
+/packages/eslint-*/ @denolfe
+
 ### Build Files ###
 /**/package.json @denolfe
+
 /tsconfig.json @denolfe
 /**/tsconfig*.json @denolfe
 

.github/actions/setup/action.yml

@@ -1,48 +0,0 @@
-name: Setup node and pnpm
-description: Configure the Node.js and pnpm versions
-
-inputs:
-  node-version:
-    description: 'The Node.js version to use'
-    required: true
-    default: 18.20.2
-  pnpm-version:
-    description: 'The pnpm version to use'
-    required: true
-    default: 8.15.7
-
-runs:
-  using: composite
-  steps:
-    # https://github.com/actions/virtual-environments/issues/1187
-    - name: tune linux network
-      shell: bash
-      run: sudo ethtool -K eth0 tx off rx off
-
-    - name: Setup Node@${{ inputs.node-version }}
-      uses: actions/setup-node@v4
-      with:
-        node-version: ${{ inputs.node-version }}
-
-    - name: Install pnpm
-      uses: pnpm/action-setup@v3
-      with:
-        version: ${{ inputs.pnpm-version }}
-        run_install: false
-
-    - name: Get pnpm store directory
-      shell: bash
-      run: |
-        echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-
-    - name: Setup pnpm cache
-      uses: actions/cache@v4
-      with:
-        path: ${{ env.STORE_PATH }}
-        key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-        restore-keys: |
-          pnpm-store-
-          pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-
-    - shell: bash
-      run: pnpm install

.github/workflows/label-author.yml

@@ -1,50 +0,0 @@
-name: label-author
-
-on:
-  pull_request:
-    types: [opened]
-  issues:
-    types: [opened]
-
-permissions:
-  contents: read
-  pull-requests: write
-  issues: write
-
-jobs:
-  debug-context:
-    runs-on: ubuntu-latest
-    steps:
-      - name: View context attributes
-        uses: actions/github-script@v7
-        with:
-          script: console.log(context)
-
-  label-created-by:
-    name: Label pr/issue on opening
-    runs-on: ubuntu-latest
-    steps:
-      - name: Tag with 'created-by'
-        uses: actions/github-script@v7
-        if: github.event.action == 'opened'
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            const type = context.payload.pull_request ? 'pull_request' : 'issue';
-            const association = context.payload[type].author_association;
-            let label = ''
-            if (association === 'MEMBER' || association === 'OWNER') {
-              label = 'created-by: Payload team';
-            } else if (association === 'CONTRIBUTOR') {
-              label = 'created-by: Contributor';
-            }
-
-            if (!label) return;
-
-            github.rest.issues.addLabels({
-              issue_number: context.issue.number,
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              labels: [label],
-            });
-            console.log('Added created-by: Payload team label');

.github/workflows/main.yml

@@ -2,25 +2,9 @@ name: build
 
 on:
   pull_request:
-    types:
-      - opened
-      - reopened
-      - synchronize
+    types: [ opened, reopened, synchronize ]
   push:
-    branches:
-      - main
-      - beta
-
-concurrency:
-  # <workflow_name>-<branch_name>-<true || commit_sha if branch is protected>
-  group: ${{ github.workflow }}-${{ github.ref }}-${{ github.ref_protected && github.sha || ''}}
-  cancel-in-progress: true
-
-env:
-  NODE_VERSION: 18.20.2
-  PNPM_VERSION: 8.15.7
-  DO_NOT_TRACK: 1 # Disable Turbopack telemetry
-  NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry
+    branches: [ 'main' ]
 
 jobs:
   changes:
@@ -38,7 +22,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 25
-      - uses: dorny/paths-filter@v3
+      - uses: dorny/paths-filter@v2
         id: filter
         with:
           filters: |
@@ -55,52 +39,7 @@ jobs:
           echo "needs_build: ${{ steps.filter.outputs.needs_build }}"
           echo "templates: ${{ steps.filter.outputs.templates }}"
 
-  lint:
-    if: >
-      github.event_name == 'pull_request' && !contains(github.event.pull_request.title, 'no-lint') && !contains(github.event.pull_request.title, 'skip-lint')
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: ${{ env.PNPM_VERSION }}
-          run_install: false
-
-      - name: Get pnpm store directory
-        shell: bash
-        run: |
-          echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
-
-      - name: Setup pnpm cache
-        uses: actions/cache@v4
-        timeout-minutes: 720
-        with:
-          path: ${{ env.STORE_PATH }}
-          key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-          restore-keys: |
-            pnpm-store-
-            pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
-
-      - run: pnpm install
-      - name: Lint staged
-        run: |
-          git diff --name-only --diff-filter=d origin/${GITHUB_BASE_REF}...${GITHUB_SHA}
-          npx lint-staged --diff="origin/${GITHUB_BASE_REF}...${GITHUB_SHA}"
-
-  build:
+  core-build:
     needs: changes
     if: ${{ needs.changes.outputs.needs_build == 'true' }}
     runs-on: ubuntu-latest
@@ -114,15 +53,15 @@ jobs:
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: ${{ env.PNPM_VERSION }}
+          version: 8
           run_install: false
 
       - name: Get pnpm store directory
@@ -130,72 +69,31 @@ jobs:
         run: |
           echo "STORE_PATH=$(pnpm store path --silent)" >> $GITHUB_ENV
 
-      - name: Setup pnpm cache
-        uses: actions/cache@v4
-        timeout-minutes: 720
+      - uses: actions/cache@v4
+        name: Setup pnpm cache
         with:
           path: ${{ env.STORE_PATH }}
-          key: pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+          key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
           restore-keys: |
-            pnpm-store-
-            pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
+            ${{ runner.os }}-pnpm-store-
+            ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
 
       - run: pnpm install
-      - run: pnpm run build:all
-        env:
-          DO_NOT_TRACK: 1 # Disable Turbopack telemetry
+      - run: pnpm run build
 
       - name: Cache build
         uses: actions/cache@v4
-        timeout-minutes: 10
         with:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
 
-  tests-unit:
+  tests:
     runs-on: ubuntu-latest
-    needs: build
-
-    steps:
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: ${{ env.PNPM_VERSION }}
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v4
-        timeout-minutes: 10
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Unit Tests
-        run: pnpm test:unit
-        env:
-          NODE_OPTIONS: --max-old-space-size=8096
-
-  tests-int:
-    runs-on: ubuntu-latest
-    needs: build
+    needs: core-build
     strategy:
       fail-fast: false
       matrix:
-        database:
-          - mongodb
-          - postgres
-          - postgres-custom-schema
-          - postgres-uuid
-          - supabase
+        database: [mongoose, postgres, postgres-custom-schema, postgres-uuid, supabase]
     env:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
@@ -210,20 +108,19 @@ jobs:
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: ${{ env.PNPM_VERSION }}
+          version: 8
           run_install: false
 
       - name: Restore build
         uses: actions/cache@v4
-        timeout-minutes: 10
         with:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
@@ -234,7 +131,7 @@ jobs:
       - name: Start PostgreSQL
         uses: CasperWA/postgresql-action@v1.2
         with:
-          postgresql version: '14' # See https://hub.docker.com/_/postgres for available versions
+          postgresql version: '14'  # See https://hub.docker.com/_/postgres for available versions
           postgresql db: ${{ env.POSTGRES_DB }}
           postgresql user: ${{ env.POSTGRES_USER }}
           postgresql password: ${{ env.POSTGRES_PASSWORD }}
@@ -273,6 +170,9 @@ jobs:
           echo "POSTGRES_URL=postgresql://postgres:postgres@127.0.0.1:54322/postgres" >> $GITHUB_ENV
         if: matrix.database == 'supabase'
 
+      - name: Component Tests
+        run: pnpm test:components
+
       - name: Integration Tests
         run: pnpm test:int
         env:
@@ -282,180 +182,71 @@ jobs:
 
   tests-e2e:
     runs-on: ubuntu-latest
-    needs: build
+    needs: core-build
     strategy:
       fail-fast: false
       matrix:
-        # find test -type f -name 'e2e.spec.ts' | sort | xargs dirname | xargs -I {} basename {}
-        suite:
-          - _community
-          - access-control
-          - admin__e2e__1
-          - admin__e2e__2
-          - auth
-          - field-error-states
-          - fields-relationship
-          - fields
-          - fields__collections__Blocks
-          - fields__collections__Array
-          - fields__collections__Relationship
-          - fields__collections__RichText
-          - fields__collections__Lexical__e2e__main
-          - fields__collections__Lexical__e2e__blocks
-          - fields__collections__Date
-          - fields__collections__Number
-          - fields__collections__Point
-          - fields__collections__Tabs
-          - fields__collections__Text
-          - fields__collections__Upload
-          - live-preview
-          - localization
-          - i18n
-          - plugin-cloud-storage
-          - plugin-form-builder
-          - plugin-nested-docs
-          - plugin-seo
-          - versions
-          - uploads
-    env:
-      SUITE_NAME: ${{ matrix.suite }}
+        part: [ 1/8, 2/8, 3/8, 4/8, 5/8, 6/8, 7/8, 8/8 ]
+
     steps:
       # https://github.com/actions/virtual-environments/issues/1187
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: ${{ env.PNPM_VERSION }}
+          version: 8
           run_install: false
 
       - name: Restore build
         uses: actions/cache@v4
-        timeout-minutes: 10
         with:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
 
-      - name: Start LocalStack
-        run: pnpm docker:start
-        if: ${{ matrix.suite == 'plugin-cloud-storage' }}
-
-      - name: Store Playwright's Version
-        run: |
-          # Extract the version number using a more targeted regex pattern with awk
-          PLAYWRIGHT_VERSION=$(pnpm ls @playwright/test --depth=0 | awk '/@playwright\/test/ {print $2}')
-          echo "Playwright's Version: $PLAYWRIGHT_VERSION"
-          echo "PLAYWRIGHT_VERSION=$PLAYWRIGHT_VERSION" >> $GITHUB_ENV
-
-      - name: Cache Playwright Browsers for Playwright's Version
-        id: cache-playwright-browsers
-        uses: actions/cache@v4
-        with:
-          path: ~/.cache/ms-playwright
-          key: playwright-browsers-${{ env.PLAYWRIGHT_VERSION }}
-
-      - name: Setup Playwright - Browsers and Dependencies
-        if: steps.cache-playwright-browsers.outputs.cache-hit != 'true'
-        run: pnpm exec playwright install --with-deps chromium
-
-      - name: Setup Playwright - Dependencies-only
-        if: steps.cache-playwright-browsers.outputs.cache-hit == 'true'
-        run: pnpm exec playwright install-deps chromium
-
       - name: E2E Tests
-        run: PLAYWRIGHT_JSON_OUTPUT_NAME=results_${{ matrix.suite }}.json pnpm test:e2e ${{ matrix.suite }}
-        env:
-          PLAYWRIGHT_JSON_OUTPUT_NAME: results_${{ matrix.suite }}.json
-          NEXT_TELEMETRY_DISABLED: 1
+        uses: nick-fields/retry@v2
+        with:
+          retry_on: error
+          max_attempts: 2
+          timeout_minutes: 15
+          command: pnpm test:e2e --part ${{ matrix.part }} --bail
 
-      - uses: actions/upload-artifact@v4
+      - uses: actions/upload-artifact@v3
         if: always()
         with:
-          name: test-results-${{ matrix.suite }}
-          path: test/test-results/
-          if-no-files-found: ignore
+          name: test-results
+          path: test-results/
           retention-days: 1
 
-      # Disabled until this is fixed: https://github.com/daun/playwright-report-summary/issues/156
-      # - uses: daun/playwright-report-summary@v3
-      #   with:
-      #     report-file: results_${{ matrix.suite }}.json
-      #     report-tag: ${{ matrix.suite }}
-      #     job-summary: true
-
-  app-build-with-packed:
-    runs-on: ubuntu-latest
-    needs: build
-
-    steps:
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: ${{ env.PNPM_VERSION }}
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v4
-        timeout-minutes: 10
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.10.0
-        with:
-          mongodb-version: 6.0
-
-      - name: Pack and build app
-        run: |
-          set -ex
-          pnpm run script:pack --dest templates/blank-3.0
-          cd templates/blank-3.0
-          cp .env.example .env
-          ls -la
-          pnpm add ./*.tgz --ignore-workspace
-          pnpm install --ignore-workspace --no-frozen-lockfile
-          cat package.json
-          pnpm run build
-
   tests-type-generation:
     runs-on: ubuntu-latest
-    needs: build
+    needs: core-build
 
     steps:
       # https://github.com/actions/virtual-environments/issues/1187
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Install pnpm
         uses: pnpm/action-setup@v3
         with:
-          version: ${{ env.PNPM_VERSION }}
+          version: 8
           run_install: false
 
       - name: Restore build
         uses: actions/cache@v4
-        timeout-minutes: 10
         with:
           path: ./*
           key: ${{ github.sha }}-${{ github.run_number }}
@@ -466,27 +257,114 @@ jobs:
       - name: Generate GraphQL schema file
         run: pnpm dev:generate-graphql-schema graphql-schema-gen
 
+  build-packages:
+    runs-on: ubuntu-latest
+    needs: core-build
+    strategy:
+      fail-fast: false
+      matrix:
+        pkg:
+          - db-mongodb
+          - db-postgres
+          - bundler-webpack
+          - bundler-vite
+          - richtext-slate
+          - richtext-lexical
+          - live-preview
+          - live-preview-react
+
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 8
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v4
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Build ${{ matrix.pkg }}
+        run: pnpm turbo run build --filter=${{ matrix.pkg }}
+
+  plugins:
+    runs-on: ubuntu-latest
+    needs: core-build
+    strategy:
+      fail-fast: false
+      matrix:
+        pkg:
+          - create-payload-app
+          - plugin-cloud
+          - plugin-cloud-storage
+          - plugin-form-builder
+          - plugin-nested-docs
+          - plugin-search
+          - plugin-sentry
+          - plugin-seo
+
+    steps:
+      # https://github.com/actions/virtual-environments/issues/1187
+      - name: tune linux network
+        run: sudo ethtool -K eth0 tx off rx off
+
+      - name: Use Node.js 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 8
+          run_install: false
+
+      - name: Restore build
+        uses: actions/cache@v4
+        with:
+          path: ./*
+          key: ${{ github.sha }}-${{ github.run_number }}
+
+      - name: Build ${{ matrix.pkg }}
+        run: pnpm turbo run build --filter=${{ matrix.pkg }}
+
+      - name: Test ${{ matrix.pkg }}
+        run: pnpm --filter ${{ matrix.pkg }} run test
+        if: matrix.pkg != 'create-payload-app' # degit doesn't work within GitHub Actions
+
   templates:
     needs: changes
-    if: false # Disable until templates are updated for 3.0
+    if: ${{ needs.changes.outputs.templates == 'true' }}
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        template: [blank, website, ecommerce]
+        template: [ blank, website, ecommerce ]
 
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 25
+
       # https://github.com/actions/virtual-environments/issues/1187
       - name: tune linux network
         run: sudo ethtool -K eth0 tx off rx off
 
-      - name: Setup Node@${{ env.NODE_VERSION }}
+      - name: Use Node.js 20
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ env.NODE_VERSION }}
+          node-version: 20
 
       - name: Start MongoDB
         uses: supercharge/mongodb-github-action@1.10.0
@@ -500,48 +378,3 @@ jobs:
           yarn install
           yarn build
           yarn generate:types
-
-  generated-templates:
-    needs: build
-    runs-on: ubuntu-latest
-
-    steps:
-      # https://github.com/actions/virtual-environments/issues/1187
-      - name: tune linux network
-        run: sudo ethtool -K eth0 tx off rx off
-
-      - name: Setup Node@${{ env.NODE_VERSION }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-
-      - name: Install pnpm
-        uses: pnpm/action-setup@v3
-        with:
-          version: ${{ env.PNPM_VERSION }}
-          run_install: false
-
-      - name: Restore build
-        uses: actions/cache@v4
-        timeout-minutes: 10
-        with:
-          path: ./*
-          key: ${{ github.sha }}-${{ github.run_number }}
-
-      - name: Build all generated templates
-        run: pnpm tsx ./scripts/build-generated-templates.ts
-
-  all-green:
-    name: All Green
-    if: always()
-    runs-on: ubuntu-latest
-    needs:
-      - lint
-      - build
-      - tests-unit
-      - tests-int
-      - tests-e2e
-
-    steps:
-      - if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')) }}
-        run: exit 1

.github/workflows/pr-title.yml

@@ -1,103 +0,0 @@
-name: pr-title
-
-on:
-  pull_request:
-    types:
-      - opened
-      - edited
-      - synchronize
-
-permissions:
-  pull-requests: write
-
-jobs:
-  main:
-    name: lint-pr-title
-    runs-on: ubuntu-latest
-    steps:
-      - uses: amannn/action-semantic-pull-request@v5
-        id: lint_pr_title
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          types: |
-            build
-            chore
-            ci
-            docs
-            feat
-            fix
-            perf
-            refactor
-            revert
-            style
-            test
-            types
-          scopes: |
-            cpa
-            db-\*
-            db-mongodb
-            db-postgres
-            email-nodemailer
-            eslint
-            graphql
-            live-preview
-            live-preview-react
-            next
-            payload
-            plugin-cloud
-            plugin-cloud-storage
-            plugin-form-builder
-            plugin-nested-docs
-            plugin-redirects
-            plugin-relationship-object-ids
-            plugin-search
-            plugin-sentry
-            plugin-seo
-            plugin-stripe
-            richtext-\*
-            richtext-lexical
-            richtext-slate
-            storage-\*
-            storage-azure
-            storage-gcs
-            storage-vercel-blob
-            storage-s3
-            translations
-            ui
-            templates
-            examples(\/(\w|-)+)?
-            deps
-
-          # Disallow uppercase letters at the beginning of the subject
-          subjectPattern: ^(?![A-Z]).+$
-          subjectPatternError: |
-            The subject "{subject}" found in the pull request title "{title}"
-            didn't match the configured pattern. Please ensure that the subject
-            doesn't start with an uppercase character.
-
-      - uses: marocchino/sticky-pull-request-comment@v2
-        # When the previous steps fails, the workflow would stop. By adding this
-        # condition you can continue the execution with the populated error message.
-        if: always() && (steps.lint_pr_title.outputs.error_message != null)
-        with:
-          header: pr-title-lint-error
-          message: |
-            Pull Request titles must follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and have valid scopes.
-
-            ${{ steps.lint_pr_title.outputs.error_message }}
-
-            ```
-            feat(ui): add Button component
-            ^    ^    ^
-            |    |    |__ Subject
-            |    |_______ Scope
-            |____________ Type
-            ```
-
-      # Delete a previous comment when the issue has been resolved
-      - if: ${{ steps.lint_pr_title.outputs.error_message == null }}
-        uses: marocchino/sticky-pull-request-comment@v2
-        with:
-          header: pr-title-lint-error
-          delete: true

.github/workflows/release-canary.yml

@@ -2,35 +2,10 @@ name: release-canary
 
 on:
   workflow_dispatch:
-    branches:
-      - beta
-
-env:
-  NODE_VERSION: 18.20.2
-  PNPM_VERSION: 8.15.7
-  DO_NOT_TRACK: 1 # Disable Turbopack telemetry
-  NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry
 
 jobs:
-  release:
-    permissions:
-      id-token: write
+  test:
     runs-on: ubuntu-latest
     steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-      - name: Setup
-        uses: ./.github/actions/setup
-        with:
-          node-version: ${{ env.NODE_VERSION }}
-          pnpm-version: ${{ env.PNPM_VERSION }}
-      - name: Load npm token
-        run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - name: Canary release script
-        # dry run hard-coded to true for testing and no npm token provided
-        run: pnpm tsx ./scripts/publish-canary.ts
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          NPM_CONFIG_PROVENANCE: true
+      - name: Echo
+        run: echo "Register release-canary workflow"

.gitignore

@@ -3,21 +3,12 @@ package-lock.json
 dist
 /.idea/*
 !/.idea/runConfigurations
-!/.idea/payload.iml
 
 test-results
 .devcontainer
 .localstack
 /migrations
 .localstack
-.turbo
-
-.turbo
-
-# Ignore test directory media folder/files
-/media
-test/media
-/versions
 
 # Created by https://www.toptal.com/developers/gitignore/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
 # Edit at https://www.toptal.com/developers/gitignore?templates=node,macos,windows,webstorm,sublimetext,visualstudiocode
@@ -290,4 +281,3 @@ $RECYCLE.BIN/
 # End of https://www.toptal.com/developers/gitignore/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
 
 /build
-.swc

.idea/payload.iml

@@ -1,81 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<module type="WEB_MODULE" version="4">
-  <component name="NewModuleRootManager">
-    <content url="file://$MODULE_DIR$">
-      <excludeFolder url="file://$MODULE_DIR$/.tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/temp" />
-      <excludeFolder url="file://$MODULE_DIR$/tmp" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/components" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/examples" />
-      <excludeFolder url="file://$MODULE_DIR$/media" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/create-payload-app/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/create-payload-app/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-mongodb/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-mongodb/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-postgres/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-postgres/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/graphql/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/graphql/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-react/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-react/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/next/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/next/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/fields" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud-storage/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud-storage/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-cloud/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-form-builder/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-nested-docs/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-nested-docs/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-redirects/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-redirects/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-search/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-search/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-sentry/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-seo/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-seo/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-stripe/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-lexical/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-lexical/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/templates" />
-      <excludeFolder url="file://$MODULE_DIR$/test/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/versions" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-slate/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/richtext-slate/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/email-nodemailer/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/email-nodemailer/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/email-resend/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/email-resend/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-vue/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/live-preview-vue/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/payload/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-form-builder/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-relationship-object-ids/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-relationship-object-ids/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/plugin-stripe/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-azure/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-azure/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-gcs/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-gcs/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-s3/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-s3/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-uploadthing/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-uploadthing/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-vercel-blob/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/storage-vercel-blob/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/translations/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/translations/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/ui/.swc" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/ui/.turbo" />
-    </content>
-    <orderEntry type="inheritedJdk" />
-    <orderEntry type="sourceFolder" forTests="false" />
-  </component>
-</module>

.idea/runConfigurations/Run_Dev_Fields.xml

@@ -1,8 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Dev Fields" type="NodeJSConfigurationType" application-parameters="--no-deprecation fields" path-to-js-file="test/dev.js" working-dir="$PROJECT_DIR$">
-    <envs>
-      <env name="NODE_OPTIONS" value="--no-deprecation" />
-    </envs>
+  <configuration default="false" name="Run Dev Fields" type="NodeJSConfigurationType" application-parameters="fields" path-to-js-file="node_modules/.pnpm/nodemon@3.0.3/node_modules/nodemon/bin/nodemon.js" working-dir="$PROJECT_DIR$">
     <method v="2" />
   </configuration>
 </component>

.idea/runConfigurations/Run_Dev__community.xml

@@ -1,8 +1,5 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Dev _community" type="NodeJSConfigurationType" application-parameters="--no-deprecation _community" path-to-js-file="test/dev.js" working-dir="$PROJECT_DIR$">
-    <envs>
-      <env name="NODE_OPTIONS" value="--no-deprecation" />
-    </envs>
+  <configuration default="false" name="Run Dev _community" type="NodeJSConfigurationType" application-parameters="_community" path-to-js-file="node_modules/.pnpm/nodemon@3.0.3/node_modules/nodemon/bin/nodemon.js" working-dir="$PROJECT_DIR$">
     <method v="2" />
   </configuration>
 </component>

.idea/runConfigurations/_template__of_JavaScriptTestRunnerJest.xml

@@ -1,9 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="true" type="JavaScriptTestRunnerJest">
-    <node-interpreter value="project" />
-    <node-options value="--experimental-vm-modules --no-deprecation" />
-    <envs />
-    <scope-kind value="ALL" />
-    <method v="2" />
-  </configuration>
-</component>

.node-version

@@ -1 +1 @@
-v18.20.2
+v18.17.1

.nvmrc

@@ -1 +1 @@
-v18.20.2
+v18.17.1

.prettierignore

@@ -9,8 +9,3 @@
 **/node_modules
 **/temp
 **/docs/**
-tsconfig.json
-packages/payload/*.js
-packages/payload/*.d.ts
-payload-types.ts
-tsconfig.tsbuildinfo

.release-it.pre.js

@@ -0,0 +1,16 @@
+module.exports = {
+  verbose: true,
+  git: {
+    requireCleanWorkingDir: false,
+    commit: false,
+    push: false,
+    tag: false,
+  },
+  npm: {
+    skipChecks: true,
+    tag: 'beta',
+  },
+  hooks: {
+    'before:init': ['pnpm install', 'pnpm clean', 'pnpm build'],
+  },
+}

.swcrc

@@ -1,24 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/swcrc",
-  "sourceMaps": "inline",
-  "jsc": {
-    "target": "esnext",
-    "parser": {
-      "syntax": "typescript",
-      "tsx": true,
-      "dts": true
-    },
-    "transform": {
-      "react": {
-        "runtime": "automatic",
-        "pragmaFrag": "React.Fragment",
-        "throwIfNamespace": true,
-        "development": false,
-        "useBuiltins": true
-      }
-    }
-  },
-  "module": {
-    "type": "es6"
-  }
-}

.vscode/extensions.json

@@ -1,8 +1,3 @@
 {
-  "recommendations": [
-    "dbaeumer.vscode-eslint",
-    "esbenp.prettier-vscode",
-    "firsttris.vscode-jest-runner",
-    "ms-playwright.playwright"
-  ]
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
 }

.vscode/launch.json

@@ -3,59 +3,12 @@
   // Hover to view descriptions of existing attributes.
   "configurations": [
     {
-      "command": "pnpm generate:types",
-      "name": "Generate Types CLI",
-      "request": "launch",
-      "type": "node-terminal",
-      "cwd": "${workspaceFolder}"
-    },
-    {
-      "command": "node --no-deprecation test/dev.js _community",
+      "command": "pnpm run dev _community",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Community",
       "request": "launch",
       "type": "node-terminal"
     },
-    {
-      "command": "node --no-deprecation test/dev.js storage-uploadthing",
-      "cwd": "${workspaceFolder}",
-      "name": "Uploadthing",
-      "request": "launch",
-      "type": "node-terminal",
-      "envFile": "${workspaceFolder}/test/storage-uploadthing/.env"
-    },
-    {
-      "command": "node --no-deprecation test/dev.js live-preview",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Live Preview",
-      "request": "launch",
-      "type": "node-terminal"
-    },
-    {
-      "command": "node --no-deprecation test/loader/init.js",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Loader",
-      "request": "launch",
-      "type": "node-terminal",
-      "env": {
-        "LOADER_TEST_FILE_PATH": "./dependency-test.js"
-        // "LOADER_TEST_FILE_PATH": "../fields/config.ts"
-      }
-    },
-    {
-      "command": "node --no-deprecation test/dev.js admin",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Admin",
-      "request": "launch",
-      "type": "node-terminal"
-    },
-    {
-      "command": "node --no-deprecation test/dev.js auth",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Auth",
-      "request": "launch",
-      "type": "node-terminal"
-    },
     {
       "command": "pnpm run dev plugin-cloud-storage",
       "cwd": "${workspaceFolder}",
@@ -67,56 +20,56 @@
       }
     },
     {
-      "command": "node --no-deprecation test/dev.js collections-graphql",
+      "command": "pnpm run dev collections-graphql",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev GraphQL",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "node --no-deprecation test/dev.js fields",
+      "command": "pnpm run dev fields",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Fields",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "node --no-deprecation test/dev.js versions",
+      "command": "pnpm run dev:postgres fields",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Postgres",
       "request": "launch",
-      "type": "node-terminal",
-      "env": {
-        "PAYLOAD_DATABASE": "postgres"
-      }
+      "type": "node-terminal"
     },
     {
-      "command": "node --no-deprecation test/dev.js versions",
+      "command": "pnpm run dev versions",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Versions",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "node --no-deprecation test/dev.js localization",
+      "command": "pnpm run dev localization",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Localization",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "node --no-deprecation test/dev.js uploads",
+      "command": "pnpm run dev uploads",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Uploads",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "node --no-deprecation test/dev.js field-error-states",
+      "command": "PAYLOAD_BUNDLER=vite pnpm run dev fields",
       "cwd": "${workspaceFolder}",
-      "name": "Run Dev Field Error States",
+      "name": "Run Dev Fields (Vite)",
       "request": "launch",
-      "type": "node-terminal"
+      "type": "node-terminal",
+      "env": {
+        "NODE_ENV": "production"
+      }
     },
     {
       "command": "pnpm run test:int live-preview",
@@ -156,6 +109,17 @@
       "request": "launch",
       "type": "node-terminal"
     },
+    {
+      "command": "ts-node ./packages/payload/src/bin/index.ts generate:types",
+      "env": {
+        "PAYLOAD_CONFIG_PATH": "test/_community/config.ts",
+        "DISABLE_SWC": "true" // SWC messes up debugging the bin scripts
+      },
+      "name": "Generate Types CLI",
+      "outputCapture": "std",
+      "request": "launch",
+      "type": "node-terminal"
+    },
     {
       "command": "ts-node ./packages/payload/src/bin/index.ts migrate:status",
       "env": {

.vscode/settings.json

@@ -35,15 +35,5 @@
   "eslint.rules.customizations": [{ "rule": "*", "severity": "warn" }],
   "typescript.tsdk": "node_modules/typescript/lib",
   // Load .git-blame-ignore-revs file
-  "gitlens.advanced.blame.customArguments": ["--ignore-revs-file", ".git-blame-ignore-revs"],
-  "[javascript][typescript][typescriptreact]": {
-    "editor.codeActionsOnSave": {
-      "source.fixAll.eslint": "explicit"
-    }
-  },
-  "files.insertFinalNewline": true,
-  "jestrunner.jestCommand": "pnpm exec cross-env NODE_OPTIONS=\"--experimental-vm-modules --no-deprecation\" node 'node_modules/jest/bin/jest.js'",
-  "jestrunner.debugOptions": {
-    "runtimeArgs": ["--experimental-vm-modules", "--no-deprecation"]
-  }
+  "gitlens.advanced.blame.customArguments": ["--ignore-revs-file", ".git-blame-ignore-revs"]
 }

CHANGELOG.md

@@ -1,3 +1,164 @@
+## [2.16.1](https://github.com/payloadcms/payload/compare/v2.16.0...v2.16.1) (2024-05-07)
+
+
+### Features
+
+* **richtext-lexical:** add maxDepth property to various lexical features ([#6250](https://github.com/payloadcms/payload/issues/6250)) ([857b9a4](https://github.com/payloadcms/payload/commit/857b9a4ac3236c740458750f156a3a4274eda210)), closes [#6242](https://github.com/payloadcms/payload/issues/6242)
+
+
+### Bug Fixes
+
+* **richtext-lexical:** export missing HorizontalRuleFeature ([#6236](https://github.com/payloadcms/payload/issues/6236)) ([f829b08](https://github.com/payloadcms/payload/commit/f829b084ba9649ef596cce4a7bf6ae8c7ccf57e3))
+
+## [2.16.0](https://github.com/payloadcms/payload/compare/v2.15.0...v2.16.0) (2024-05-06)
+
+
+### Features
+
+* adds disableListColumn, disableListFilter to fields admin props ([#6188](https://github.com/payloadcms/payload/issues/6188)) ([db4aace](https://github.com/payloadcms/payload/commit/db4aacebb801f1cc11ef8732f9f3b78475256641))
+
+
+### Bug Fixes
+
+* graphql upload relations returning null ([#6233](https://github.com/payloadcms/payload/issues/6233)) ([cac52da](https://github.com/payloadcms/payload/commit/cac52da638a0df4356120a2f61c6aaf25641a5ad))
+* hide drag handles when `admin.isSortable: false` ([#6225](https://github.com/payloadcms/payload/issues/6225)) ([622cdb0](https://github.com/payloadcms/payload/commit/622cdb044002b2c3182c3b0432b51befbfb9b979))
+* **plugin-form-builder:** hook overrides not working as intended ([#6203](https://github.com/payloadcms/payload/issues/6203)) ([b735d6a](https://github.com/payloadcms/payload/commit/b735d6aa169acca8cb638859d2c8ba43e315f02c))
+
+## [2.15.0](https://github.com/payloadcms/payload/compare/v2.14.2...v2.15.0) (2024-05-03)
+
+
+### Features
+
+* add isSortable to arrays and blocks ([#5962](https://github.com/payloadcms/payload/issues/5962)) ([5c58bd3](https://github.com/payloadcms/payload/commit/5c58bd322da966fe610959df13dfd49add35a2ef))
+* use filterOptions in list relationship filter ([#6156](https://github.com/payloadcms/payload/issues/6156)) ([23f3eb1](https://github.com/payloadcms/payload/commit/23f3eb1cf0b75a4044319d7cd3e5000d5b4e42c4))
+
+
+### Bug Fixes
+
+* bulk publish from collection list ([#6063](https://github.com/payloadcms/payload/issues/6063)) ([84570e6](https://github.com/payloadcms/payload/commit/84570e6e3bbb81fcae80da92b01bc56d09906072))
+* cascade draft arg in nested GraphQL relationship queries ([#6141](https://github.com/payloadcms/payload/issues/6141)) ([a8ac8b4](https://github.com/payloadcms/payload/commit/a8ac8b463349664f3188ae77217f037da72f796b))
+* GraphQL nested relationships not respecting req locale ([#6117](https://github.com/payloadcms/payload/issues/6117)) ([3fccd34](https://github.com/payloadcms/payload/commit/3fccd34abe5a332f88f5e950b755cd1d21441fb6))
+* hide unusable fields from collection filter select ([#6135](https://github.com/payloadcms/payload/issues/6135)) ([2be5ad0](https://github.com/payloadcms/payload/commit/2be5ad0ebafd1d3c1c0567e2085ccfd593f18271))
+* incorrect `localesNotSaved` translation ([#5996](https://github.com/payloadcms/payload/issues/5996)) ([af67749](https://github.com/payloadcms/payload/commit/af67749e49db92e675b63b52190e562468894706))
+* **plugin-cloud:** purge cache for all sizes ([#5301](https://github.com/payloadcms/payload/issues/5301)) ([831f1ff](https://github.com/payloadcms/payload/commit/831f1ff5bed7e083cc076e9eb5ff9a2b2f1ed710))
+* properly adds `readonly` styles to disabled `radio` fields ([#6176](https://github.com/payloadcms/payload/issues/6176)) ([9b7e62d](https://github.com/payloadcms/payload/commit/9b7e62dc20dca7402c6c68dfb8a5995c211993af))
+* resets filter state when param state change within route ([#6169](https://github.com/payloadcms/payload/issues/6169)) ([6e38cc2](https://github.com/payloadcms/payload/commit/6e38cc2bcfb08b608abcb6aac4b4c1f6eea63428))
+* **richtext-lexical:** drag and add block handles disappear too quickly for smaller screen sizes. ([#6145](https://github.com/payloadcms/payload/issues/6145)) ([24f6972](https://github.com/payloadcms/payload/commit/24f697219b5071d91a5c37aafb50e2d823b68d4c))
+* **richtext-lexical:** floating toolbar caret positioned incorrectly for some line heights ([#6151](https://github.com/payloadcms/payload/issues/6151)) ([36b1f5a](https://github.com/payloadcms/payload/commit/36b1f5a763f782c140e62aa062b4077d6efd0738))
+* sanitizes fields in default edit view for drawer content ([#6175](https://github.com/payloadcms/payload/issues/6175)) ([43dab5c](https://github.com/payloadcms/payload/commit/43dab5c7053831a0c71f3a6860113f653cab674f))
+* version restoration ([#6039](https://github.com/payloadcms/payload/issues/6039)) ([91bac9c](https://github.com/payloadcms/payload/commit/91bac9c0aa1ff3da052b9c2ad83fa5ac23a16d1d))
+
+## [2.14.2](https://github.com/payloadcms/payload/compare/v2.14.1...v2.14.2) (2024-04-26)
+
+
+### Bug Fixes
+
+* **deps:** dedupes react ([#6058](https://github.com/payloadcms/payload/issues/6058)) ([d0ba694](https://github.com/payloadcms/payload/commit/d0ba694c80a1b699c4f2cad98b1f0bde1f0d43ca))
+
+## [2.14.1](https://github.com/payloadcms/payload/compare/v2.14.0...v2.14.1) (2024-04-25)
+
+
+### Bug Fixes
+
+* **db-postgres:** cumulative updates ([#6033](https://github.com/payloadcms/payload/issues/6033)) ([c31b8dc](https://github.com/payloadcms/payload/commit/c31b8dcaa0c43132d8a01e0cc43094f466cc9168))
+* disable api key checkbox does not remove api key ([#6017](https://github.com/payloadcms/payload/issues/6017)) ([0ffdcc6](https://github.com/payloadcms/payload/commit/0ffdcc685f4e917a02e62dbaccec7cc8ebbf695d))
+* **richtext-lexical:** minimize the amount of times sanitizeFields is called ([#6018](https://github.com/payloadcms/payload/issues/6018)) ([60372fa](https://github.com/payloadcms/payload/commit/60372faf36b7f6d92a61ccbaee0f528e50f5a51a))
+
+## [2.14.0](https://github.com/payloadcms/payload/compare/v2.13.0...v2.14.0) (2024-04-24)
+
+
+### Features
+
+* add count operation to collections ([#5936](https://github.com/payloadcms/payload/issues/5936)) ([c380dee](https://github.com/payloadcms/payload/commit/c380deee4a1db82bce9fea264060000957a53eee))
+
+### Bug Fixes
+
+* bulk publish ([#6006](https://github.com/payloadcms/payload/issues/6006)) ([c11600a](https://github.com/payloadcms/payload/commit/c11600aac38cd67019765faf2a41e62df13e50cc))
+* **db-postgres:** extra version suffix added to table names ([#5939](https://github.com/payloadcms/payload/issues/5939)) ([bd8b512](https://github.com/payloadcms/payload/commit/bd8b5123b0991e53eb209315897dbca10d14d45e))
+* **db-postgres:** Fixes nested groups inside nested blocks ([#5882](https://github.com/payloadcms/payload/issues/5882)) ([e258866](https://github.com/payloadcms/payload/commit/e25886649fce414d5d47918f35ba2d4d2ba59174))
+* **db-postgres:** row table names were not being built properly - v2 ([#5961](https://github.com/payloadcms/payload/issues/5961)) ([9152a23](https://github.com/payloadcms/payload/commit/9152a238d2982503e7f509350651b0ba3f83b1ec))
+* header filters ([#5997](https://github.com/payloadcms/payload/issues/5997)) ([ad01c67](https://github.com/payloadcms/payload/commit/ad01c6784d283386dc819dfcd47455cad5accfaa))
+* min/max attributes missing from number input ([#5779](https://github.com/payloadcms/payload/issues/5779)) ([985796b](https://github.com/payloadcms/payload/commit/985796be54b593af0a4934685ab8621b9badda10))
+* removes `equals` & `not_equals` operators from fields with `hasMany` ([#5885](https://github.com/payloadcms/payload/issues/5885)) ([a8c9625](https://github.com/payloadcms/payload/commit/a8c9625cdec33476a5da87bcd9f010f9d7fb9a94))
+
+## [2.13.0](https://github.com/payloadcms/payload/compare/v2.12.1...v2.13.0) (2024-04-19)
+
+
+### Features
+
+* allow configuration for setting headers on external file fetch ([ec1ad0b](https://github.com/payloadcms/payload/commit/ec1ad0b6628d400d7435821c8a72b6746bf87577))
+* **db-\*:** custom db table and enum names ([#5045](https://github.com/payloadcms/payload/issues/5045)) ([9bbacc4](https://github.com/payloadcms/payload/commit/9bbacc4fb1ad247634f394e95c42ee3adade8048))
+* json field schemas ([#5726](https://github.com/payloadcms/payload/issues/5726)) ([2c402cc](https://github.com/payloadcms/payload/commit/2c402cc65c9e8f7f33e2fb0ce5e1a8ceff52af1b))
+* **plugin-seo:** add Chinese translation ([#5429](https://github.com/payloadcms/payload/issues/5429)) ([fcb29bb](https://github.com/payloadcms/payload/commit/fcb29bb1c637867301bbc1070b4a84383bf0e90a))
+* **richtext-lexical:** add HorizontalRuleFeature ([d8e9084](https://github.com/payloadcms/payload/commit/d8e9084db21828968046ab59775633e409ce5c2a))
+* **richtext-lexical:** improve floating handle y-positioning by positioning it in the center for smaller elements. ([0055a8e](https://github.com/payloadcms/payload/commit/0055a8eb36b95722cccdc5eb3101a79d3e764f8b))
+
+
+### Bug Fixes
+
+* adds type error validations for `email` and `password` in login operation ([#4852](https://github.com/payloadcms/payload/issues/4852)) ([1f00360](https://github.com/payloadcms/payload/commit/1f0036054a9461535b0992f2449e91e4eaf97d4e))
+* avoids getting and setting doc preferences when creating new ([#5757](https://github.com/payloadcms/payload/issues/5757)) ([e3c3dda](https://github.com/payloadcms/payload/commit/e3c3ddac34dff8fa085f5b702be2838d513be300))
+* block field type missing dbName ([#5695](https://github.com/payloadcms/payload/issues/5695)) ([e7608f5](https://github.com/payloadcms/payload/commit/e7608f5507d3b85ea3f44b5cb1f43edf67608b1b))
+* **db-mongodb:** failing `contains` query with special chars ([#5774](https://github.com/payloadcms/payload/issues/5774)) ([5fa99fb](https://github.com/payloadcms/payload/commit/5fa99fb060cabbb69b5d6688748260e562e6bea3))
+* **db-mongodb:** ignore end session errors ([#5904](https://github.com/payloadcms/payload/issues/5904)) ([cb8d562](https://github.com/payloadcms/payload/commit/cb8d562132bee437798880e1d7f64dbfdee36949))
+* **db-mongodb:** version fields indexSortableFields ([#5863](https://github.com/payloadcms/payload/issues/5863)) ([fe0028c](https://github.com/payloadcms/payload/commit/fe0028c89945303a431b48efdae7b6e22304c8a3))
+* **db-postgres:** hasMany relationship query contains operator ([#4212](https://github.com/payloadcms/payload/issues/4212)) ([608d6d0](https://github.com/payloadcms/payload/commit/608d6d0a872af224ea42c3e6c8a3b4f21678f550))
+* **db-postgres:** issue querying by localised relationship not respecting locale as constraint ([#5666](https://github.com/payloadcms/payload/issues/5666)) ([44599cb](https://github.com/payloadcms/payload/commit/44599cbc7b8f23d6d8c7a3e05466237406812a6d))
+* **db-postgres:** query hasMany fields with in ([#5881](https://github.com/payloadcms/payload/issues/5881)) ([6185f8a](https://github.com/payloadcms/payload/commit/6185f8a5d845d12651f5a3ee128eb43d3b9d2449))
+* **db-postgres:** relationship query pagination ([#5802](https://github.com/payloadcms/payload/issues/5802)) ([65690a6](https://github.com/payloadcms/payload/commit/65690a675c17cfacebe775a327a57741ac09416a))
+* **db-postgres:** validateExistingBlockIsIdentical localized ([#5839](https://github.com/payloadcms/payload/issues/5839)) ([4c4f924](https://github.com/payloadcms/payload/commit/4c4f924e90ee23a73c9a7cc7e69bbc2caf902b92))
+* duplicate document multiple times in quick succession ([#5642](https://github.com/payloadcms/payload/issues/5642)) ([373787d](https://github.com/payloadcms/payload/commit/373787de31cbbd33b587aa4be6344948f082f5bb))
+* missing date locales ([#5656](https://github.com/payloadcms/payload/issues/5656)) ([c1c8600](https://github.com/payloadcms/payload/commit/c1c86009a5e9aad401a05f7c63ad37bd3f88dc84))
+* number ids were not sanitized to number in rest api ([51f84a4](https://github.com/payloadcms/payload/commit/51f84a4fcfd437eb73c7d83205b66e3620085909))
+* passes parent id instead of incoming id to saveVersion ([#5831](https://github.com/payloadcms/payload/issues/5831)) ([25c9a14](https://github.com/payloadcms/payload/commit/25c9a145bec9e9566d2bbcba59d5b34394e10bbd))
+* **plugin-seo:** uses correct key for ukrainian translation ([#5873](https://github.com/payloadcms/payload/issues/5873)) ([e47e544](https://github.com/payloadcms/payload/commit/e47e544364031ac834565a4d86ef6ec9c04e63c0))
+* properly handle drafts in bulk update ([#5872](https://github.com/payloadcms/payload/issues/5872)) ([ad38f76](https://github.com/payloadcms/payload/commit/ad38f760111abf947c6b0ee4b983ee1224a9bf1b))
+* req.collection being lost when querying a global inside a collection ([#5727](https://github.com/payloadcms/payload/issues/5727)) ([cbd03ed](https://github.com/payloadcms/payload/commit/cbd03ed2f8819ee8ac20e8739cc03e88ff4caa25))
+* **richtext-lexical:** catch errors that may occur during HTML generation ([#5754](https://github.com/payloadcms/payload/issues/5754)) ([9b44296](https://github.com/payloadcms/payload/commit/9b442960929d00faa07f1383b1267f71e6f44efe))
+* **richtext-lexical:** do not allow omitting editor prop for sub-richtext fields within lexical defined in the payload config ([#5766](https://github.com/payloadcms/payload/issues/5766)) ([6186493](https://github.com/payloadcms/payload/commit/6186493246157b4d4b33c8c47378f08581315942))
+* **richtext-lexical:** incorrect floating handle y-position calculation next to certain kinds of HTML elements like HR ([de5d6cc](https://github.com/payloadcms/payload/commit/de5d6cc4bd591745156f0b8c56795b7bd2eaad7e))
+* **richtext-lexical:** limit unnecessary floating handle positioning updates ([a00439e](https://github.com/payloadcms/payload/commit/a00439ea893e074d64be83ee6af1e780178a7ee3))
+* **richtext-lexical:** pass through config for schema generation. Makes it more robust ([#5700](https://github.com/payloadcms/payload/issues/5700)) ([cf135fd](https://github.com/payloadcms/payload/commit/cf135fd1e4aeb30121281399e26be901393ada6d))
+* **richtext-lexical:** use correct nodeType on HorizontalRule feature HTML converter ([#5805](https://github.com/payloadcms/payload/issues/5805)) ([3b1d331](https://github.com/payloadcms/payload/commit/3b1d3313165499616673f6d363c90ef884994525))
+* updates type name of `CustomPublishButtonProps` to `CustomPublishButtonType` ([#5644](https://github.com/payloadcms/payload/issues/5644)) ([7df7bf4](https://github.com/payloadcms/payload/commit/7df7bf448bd26e870a1fde8aaa47430904d68366))
+* updates var ([9530d28](https://github.com/payloadcms/payload/commit/9530d28a6760a667b718027a49ea43ba1accd546))
+* use isolateObjectProperty function in createLocalReq ([#5748](https://github.com/payloadcms/payload/issues/5748)) ([c0ba6cc](https://github.com/payloadcms/payload/commit/c0ba6cc19a20c043a08ca77caacd47ef7cfb48f4))
+* uses find instead of fieldIndex for custom ID check ([509ec67](https://github.com/payloadcms/payload/commit/509ec677c42993d9c08facf6928a5ef1e9767508))
+
+### ⚠ BREAKING CHANGES
+
+* **richtext-lexical:** do not allow omitting editor prop for sub-richtext fields within lexical defined in the payload config ([#5766](https://github.com/payloadcms/payload/issues/5766))
+
+## [2.12.1](https://github.com/payloadcms/payload/compare/v2.12.0...v2.12.1) (2024-04-03)
+
+
+### Bug Fixes
+
+* Skip parsing if operator is 'exist' ([#5404](https://github.com/payloadcms/payload/issues/5404)) ([742a7af](https://github.com/payloadcms/payload/commit/742a7af93d2e9ef4d41ee093cef875322792ae72))
+* updates colors of tooltip in light mode ([#5632](https://github.com/payloadcms/payload/issues/5632)) ([a7e7c92](https://github.com/payloadcms/payload/commit/a7e7c9276835e0a35a18daccb218c901ca2fdd8c))
+
+## [2.12.0](https://github.com/payloadcms/payload/compare/v2.11.2...v2.12.0) (2024-04-03)
+
+
+### Features
+
+* **plugin-seo:** adds Norwegian translation ([#5621](https://github.com/payloadcms/payload/issues/5621)) ([589b492](https://github.com/payloadcms/payload/commit/589b492b2e6bc578e6f17649ff6d936ffd88b8b5))
+* **richtext-*:** add ability to provide custom Field and Error components ([#5574](https://github.com/payloadcms/payload/issues/5574)) ([02d2c51](https://github.com/payloadcms/payload/commit/02d2c517176a775c6eeb4b164d9e6b45d8f5e4c1))
+
+
+### Bug Fixes
+
+* **db-postgres:** error on delete having joins ([#5459](https://github.com/payloadcms/payload/issues/5459)) ([9169230](https://github.com/payloadcms/payload/commit/916923071a2c28077326bfd2059d1665ef47e94f))
+* image resize tiff files ([#5415](https://github.com/payloadcms/payload/issues/5415)) ([8184e00](https://github.com/payloadcms/payload/commit/8184e0005af1b6da93d0921c31547515a4ce6343))
+* number field with hasMany accept defaultValue array ([#5618](https://github.com/payloadcms/payload/issues/5618)) ([a3ae416](https://github.com/payloadcms/payload/commit/a3ae4160850290c194bb228e1fbeb8c7533cead3))
+* regression of filterOptions using different transaction ([#5169](https://github.com/payloadcms/payload/issues/5169)) ([3ceb6ef](https://github.com/payloadcms/payload/commit/3ceb6efd32cfa9556c6656469fa43d61d7679b1d))
+* **richtext-lexical:** Blocks: generated output schema is not fully correct ([#5259](https://github.com/payloadcms/payload/issues/5259)) ([e7f6bfb](https://github.com/payloadcms/payload/commit/e7f6bfbe9da4cab42c7ec7019371d5e79af17ec9))
+* **richtext-lexical:** checklist html converter incorrectly outputting children ([#5570](https://github.com/payloadcms/payload/issues/5570)) ([2e5400f](https://github.com/payloadcms/payload/commit/2e5400fa7a5ac7441e00134a7f4299022228f64f))
+* **richtext-lexical:** disable instanceof HTMLImageElement check as it causes issues when used on the server ([2164dcc](https://github.com/payloadcms/payload/commit/2164dcc594b5c16d7111b71cdb01f5f7aaa7e127))
+* **richtext-lexical:** Link: add open-in-new-tab to html converter ([23df60d](https://github.com/payloadcms/payload/commit/23df60dba5682255ce6f60e3ee8e6901f6a70c7b))
+* **richtext-lexical:** properly center add- and drag-block handles ([#5568](https://github.com/payloadcms/payload/issues/5568)) ([48dc116](https://github.com/payloadcms/payload/commit/48dc116f57113c3124ff93a50fa1189053e21d76))
+* sets beforeValidateHook req type to required ([#5608](https://github.com/payloadcms/payload/issues/5608)) ([e10d5df](https://github.com/payloadcms/payload/commit/e10d5df0b2dd21b86cce44d0e36b31e9d3411b39))
+
 ## [2.11.2](https://github.com/payloadcms/payload/compare/v2.11.1...v2.11.2) (2024-02-23)
 
 

README.md

@@ -17,7 +17,7 @@
 <hr/>
 
 > [!IMPORTANT]
-> 🎉 <strong>Payload 2.0 is now available!</strong> Read more in the <a target="_blank" href="https://payloadcms.com/blog/payload-2-0" rel="dofollow"><strong>announcement post</strong></a>.
+> 🎉 <strong>Payload 3.0 beta released!</strong> You can now deploy Payload fully in any Next.js app folder. Read more in the <a target="_blank" href="https://payloadcms.com/blog/30-beta-install-payload-into-any-nextjs-app-with-one-line" rel="dofollow"><strong>announcement post</strong></a>.
 
 <h3>Benefits over a regular CMS</h3>
 <ul>

app/(payload)/admin/[[...segments]]/not-found.tsx

@@ -1,22 +0,0 @@
-/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-import type { Metadata } from 'next'
-
-import config from '@payload-config'
-/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
-import { NotFoundPage, generatePageMetadata } from '@payloadcms/next/views'
-
-type Args = {
-  params: {
-    segments: string[]
-  }
-  searchParams: {
-    [key: string]: string | string[]
-  }
-}
-
-export const generateMetadata = ({ params, searchParams }: Args): Promise<Metadata> =>
-  generatePageMetadata({ config, params, searchParams })
-
-const NotFound = ({ params, searchParams }: Args) => NotFoundPage({ config, params, searchParams })
-
-export default NotFound

app/(payload)/admin/[[...segments]]/page.tsx

@@ -1,22 +0,0 @@
-/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-import type { Metadata } from 'next'
-
-import config from '@payload-config'
-/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
-import { RootPage, generatePageMetadata } from '@payloadcms/next/views'
-
-type Args = {
-  params: {
-    segments: string[]
-  }
-  searchParams: {
-    [key: string]: string | string[]
-  }
-}
-
-export const generateMetadata = ({ params, searchParams }: Args): Promise<Metadata> =>
-  generatePageMetadata({ config, params, searchParams })
-
-const Page = ({ params, searchParams }: Args) => RootPage({ config, params, searchParams })
-
-export default Page

app/(payload)/api/[...slug]/route.ts

@@ -1,10 +0,0 @@
-/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-/* DO NOT MODIFY it because it could be re-written at any time. */
-import config from '@payload-config'
-import { REST_DELETE, REST_GET, REST_OPTIONS, REST_PATCH, REST_POST } from '@payloadcms/next/routes'
-
-export const GET = REST_GET(config)
-export const POST = REST_POST(config)
-export const DELETE = REST_DELETE(config)
-export const PATCH = REST_PATCH(config)
-export const OPTIONS = REST_OPTIONS(config)

app/(payload)/api/graphql-playground/route.ts

@@ -1,6 +0,0 @@
-/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-/* DO NOT MODIFY it because it could be re-written at any time. */
-import config from '@payload-config'
-import { GRAPHQL_PLAYGROUND_GET } from '@payloadcms/next/routes'
-
-export const GET = GRAPHQL_PLAYGROUND_GET(config)

app/(payload)/api/graphql/route.ts

@@ -1,6 +0,0 @@
-/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-/* DO NOT MODIFY it because it could be re-written at any time. */
-import config from '@payload-config'
-import { GRAPHQL_POST } from '@payloadcms/next/routes'
-
-export const POST = GRAPHQL_POST(config)

app/(payload)/layout.tsx

@@ -1,15 +0,0 @@
-/* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-import configPromise from '@payload-config'
-import { RootLayout } from '@payloadcms/next/layouts'
-/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
-import React from 'react'
-
-import './custom.scss'
-
-type Args = {
-  children: React.ReactNode
-}
-
-const Layout = ({ children }: Args) => <RootLayout config={configPromise}>{children}</RootLayout>
-
-export default Layout

app/my-route/route.ts

@@ -1,5 +0,0 @@
-export const GET = () => {
-  return Response.json({
-    hello: 'elliot',
-  })
-}

changelog.config.js

@@ -0,0 +1,39 @@
+module.exports = {
+  // gitRawCommitsOpts: {
+  //   from: 'v2.0.9',
+  //   path: 'packages/payload',
+  // },
+  // infile: 'CHANGELOG.md',
+  options: {
+    preset: {
+      name: 'conventionalcommits',
+      types: [
+        { section: 'Features', type: 'feat' },
+        { section: 'Features', type: 'feature' },
+        { section: 'Bug Fixes', type: 'fix' },
+        { section: 'Documentation', type: 'docs' },
+      ],
+    },
+  },
+  // outfile: 'NEW.md',
+  writerOpts: {
+    commitGroupsSort: (a, b) => {
+      const groupOrder = ['Features', 'Bug Fixes', 'Documentation']
+      return groupOrder.indexOf(a.title) - groupOrder.indexOf(b.title)
+    },
+
+    // Scoped commits at the end, alphabetical sort
+    commitsSort: (a, b) => {
+      if (a.scope || b.scope) {
+        if (!a.scope) return -1
+        if (!b.scope) return 1
+        return a.scope === b.scope
+          ? a.subject.localeCompare(b.subject)
+          : a.scope.localeCompare(b.scope)
+      }
+
+      // Alphabetical sort
+      return a.subject.localeCompare(b.subject)
+    },
+  },
+}

docs/access-control/globals.mdx

@@ -8,6 +8,8 @@ keywords: globals, access control, permissions, documentation, Content Managemen
 
 You can define Global-level Access Control within each Global's `access` property. All Access Control functions accept one `args` argument.
 
+\*\*Available argument properties:
+
 ## Available Controls
 
 | Function                | Allows/Denies Access                   |

docs/access-control/overview.mdx

@@ -19,7 +19,7 @@ Access control within Payload is extremely powerful while remaining easy and int
 - Restricting a `User` to only be able to see their own `Order`(s), but no others
 - Allowing `User`s that belong to a certain `Organization` to access only that `Organization`'s `Resource`s
 
-## Default Settings
+### Default Settings
 
 **By default, all Collections and Globals require that a user is logged in to be able to interact in any way.** The default Access Control function evaluates the `user` from the Express `req` and returns `true` if a user is logged in, and `false` if not.
 
@@ -43,7 +43,7 @@ const defaultPayloadAccess = ({ req: { user } }) => {
   to <strong>false</strong>.
 </Banner>
 
-## Access Control Types
+### Access Control Types
 
 You can manage access within Payload on three different levels:
 
@@ -51,7 +51,7 @@ You can manage access within Payload on three different levels:
 - [Fields](/docs/access-control/fields)
 - [Globals](/docs/access-control/globals)
 
-## When Access Control is Executed
+### When Access Control is Executed
 
 <Banner type="success">
   <strong>Note:</strong>
@@ -60,17 +60,17 @@ You can manage access within Payload on three different levels:
   your access control is executed.
 </Banner>
 
-### As you execute operations
+#### As you execute operations
 
 When you perform Payload operations like `create`, `read`, `update`, and `delete`, your access control functions will be executed before any changes or operations are completed.
 
-### Within the Admin UI
+#### Within the Admin UI
 
 The Payload Admin UI responds dynamically to the access control that you define. For example, if you restrict editing a `ExampleCollection` to only users that feature a `role` of `admin`, the Payload Admin UI will **hide** the `ExampleCollection` from the Admin UI entirely. This is super powerful and allows you to control who can do what with your Admin UI.
 
 To accomplish this, Payload ships with an `Access` operation, which is executed when a user logs into the Admin UI. Payload will execute each one of your access control functions, across all collections, globals, and fields, at the top level and return a response that contains a reflection of what the currently authenticated user can do with your application.
 
-## Argument Availability
+### Argument Availability
 
 <Banner type="warning">
   <strong>Important:</strong>

docs/admin/bundlers.mdx

@@ -7,7 +7,7 @@ desc: Bundlers are used to bundle the code that serves Payload's Admin Panel.
 
 Payload has two official bundlers, the [Webpack Bundler](/docs/admin/webpack) and the [Vite Bundler](/docs/admin/vite). You must install a bundler to use the admin panel.
 
-## Install a bundler
+##### Install a bundler
 
 Webpack (recommended):
 
@@ -21,7 +21,7 @@ Vite (beta):
 yarn add @payloadcms/bundler-vite
 ```
 
-## Configure the bundler
+##### Configure the bundler
 
 ```ts
 // payload.config.ts
@@ -33,13 +33,13 @@ import { webpackBundler } from '@payloadcms/bundler-webpack'
 export default buildConfig({
   // highlight-start
   admin: {
-    bundler: webpackBundler(), // or viteBundler()
+    bundler: webpackBundler() // or viteBundler()
   },
   // highlight-end
 })
 ```
 
-## What are bundlers?
+### What are bundlers?
 
 At their core, a bundler's main goal is to take a bunch of files and turn them into a few optimized files that you ship to the browser. The admin UI has a root `index.html` entry point, and from there the bundler traverses the dependency tree, bundling all of the files that are required from that point on.
 
@@ -48,7 +48,7 @@ Since the bundled file is sent to the browser, it can't include any server-only
 <Banner type="warning">
   <strong>Using environment variables in the admin UI</strong>
   <br />
-  Bundles should not contain sensitive information. By default, Payload excludes env variables from
-  the bundle. If you need to use env variables in your payload config, you need to prefix them with
-  `PAYLOAD_PUBLIC_` to make them available to the client-side code.
+  Bundles should not contain sensitive information. By default, Payload
+  excludes env variables from the bundle. If you need to use env variables in your payload config,
+  you need to prefix them with `PAYLOAD_PUBLIC_` to make them available to the client-side code.
 </Banner>

docs/admin/components.mdx

@@ -13,29 +13,29 @@ To swap in your own React component, first, consult the list of available compon
 <Banner type="success">
   <strong>Tip:</strong>
   <br />
-  Custom components will automatically be provided with all props that the default component
-  normally accepts.
+  Custom components will automatically be provided with all props that the default component normally
+  accepts.
 </Banner>
 
-## Base Component Overrides
+### Base Component Overrides
 
 You can override a set of admin panel-wide components by providing a component to your base Payload config's `admin.components` property. The following options are available:
 
-| Path                  | Description                                                                                                                                                                                               |
-|-----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`Nav`**             | Contains the sidebar / mobile menu in its entirety.                                                                                                                                                       |
-| **`BeforeNavLinks`**  | Array of components to inject into the built-in Nav, _before_ the links themselves.                                                                                                                       |
-| **`AfterNavLinks`**   | Array of components to inject into the built-in Nav, _after_ the links.                                                                                                                                   |
-| **`BeforeDashboard`** | Array of components to inject into the built-in Dashboard, _before_ the default dashboard contents.                                                                                                       |
-| **`AfterDashboard`**  | Array of components to inject into the built-in Dashboard, _after_ the default dashboard contents. [Demo](https://github.com/payloadcms/payload/tree/main/test/admin/components/AfterDashboard/index.tsx) |
-| **`BeforeLogin`**     | Array of components to inject into the built-in Login, _before_ the default login form.                                                                                                                   |
-| **`AfterLogin`**      | Array of components to inject into the built-in Login, _after_ the default login form.                                                                                                                    |
-| **`logout.Button`**   | A custom React component.                                                                                                                                                                                 |
-| **`graphics.Icon`**   | Used as a graphic within the `Nav` component. Often represents a condensed version of a full logo.                                                                                                        |
-| **`graphics.Logo`**   | The full logo to be used in contexts like the `Login` view.                                                                                                                                               |
-| **`providers`**       | Define your own provider components that will wrap the Payload Admin UI. [More](#custom-providers)                                                                                                        |
-| **`actions`**         | Array of custom components to be rendered in the Payload Admin UI header, providing additional interactivity and functionality.                                                                           |
-| **`views`**           | Override or create new views within the Payload Admin UI. [More](#views)                                                                                                                                  |
+| Path                  | Description                                                                                                                                                                                                 |
+| --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`Nav`**             | Contains the sidebar / mobile menu in its entirety.                                                                                                                                                         |
+| **`BeforeNavLinks`**  | Array of components to inject into the built-in Nav, _before_ the links themselves.                                                                                                                         |
+| **`AfterNavLinks`**   | Array of components to inject into the built-in Nav, _after_ the links.                                                                                                                                     |
+| **`BeforeDashboard`** | Array of components to inject into the built-in Dashboard, _before_ the default dashboard contents.                                                                                                         |
+| **`AfterDashboard`**  | Array of components to inject into the built-in Dashboard, _after_ the default dashboard contents. [Demo](https://github.com/payloadcms/payload/tree/main/test/admin/components/AfterDashboard/index.tsx)   |
+| **`BeforeLogin`**     | Array of components to inject into the built-in Login, _before_ the default login form.                                                                                                                     |
+| **`AfterLogin`**      | Array of components to inject into the built-in Login, _after_ the default login form.                                                                                                                      |
+| **`logout.Button`**   | A custom React component.                                                                                                                                                                                   |
+| **`graphics.Icon`**   | Used as a graphic within the `Nav` component. Often represents a condensed version of a full logo.                                                                                                          |
+| **`graphics.Logo`**   | The full logo to be used in contexts like the `Login` view.                                                                                                                                                 |
+| **`providers`**       | Define your own provider components that will wrap the Payload Admin UI. [More](#custom-providers)                                                                                                          |
+| **`actions`**         | Array of custom components to be rendered in the Payload Admin UI header, providing additional interactivity and functionality.                                                                             |
+| **`views`**           | Override or create new views within the Payload Admin UI. [More](#views)                                                                                                                                    |
 
 Here is a full example showing how to swap some of these components for your own.
 
@@ -73,14 +73,14 @@ export default buildConfig({
 })
 ```
 
-### Views
+#### Views
 
 You can easily swap entire views with your own by using the `admin.components.views` property. At the root level, Payload renders the following views by default, all of which can be overridden:
 
-| Property        | Description                                                                   |
-| --------------- | ----------------------------------------------------------------------------- |
-| **`Account`**   | The Account view is used to show the currently logged in user's Account page. |
-| **`Dashboard`** | The main landing page of the Admin panel.                                     |
+| Property           | Description                                                                                                                  |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`Account`**      | The Account view is used to show the currently logged in user's Account page.                                                |
+| **`Dashboard`**    | The main landing page of the Admin panel.                                                                                    |
 
 To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. For example:
 
@@ -111,7 +111,7 @@ For more granular control, pass a configuration object instead. Each view corres
 
 _\* An asterisk denotes that a property is required._
 
-### Adding new views
+#### Adding new views
 
 To add a _new_ view to the Admin Panel, simply add another key to the `views` object with at least a `path` and `Component` property. For example:
 
@@ -135,17 +135,14 @@ To add a _new_ view to the Admin Panel, simply add another key to the `views` ob
 <Banner type="warning">
   <strong>Note:</strong>
   <br />
-  Routes are cascading. This means that unless explicitly given the `exact` property, they will
-  match on URLs that simply _start_ with the route's path. This is helpful when creating catch-all
-  routes in your application. Alternatively, you could define your nested route _before_ your parent
-  route.
+  Routes are cascading. This means that unless explicitly given the `exact` property, they will match on URLs that simply _start_ with the route's path. This is helpful when creating catch-all routes in your application. Alternatively, you could define your nested route _before_ your parent route.
 </Banner>
 
 _For more examples regarding how to customize components, look at the following [examples](https://github.com/payloadcms/payload/tree/main/test/admin/components)._
 
 For help on how to build your own custom view components, see [building a custom view component](#building-a-custom-view-component).
 
-## Collections
+### Collections
 
 You can override components on a collection-by-collection basis via the `admin.components` property.
 
@@ -171,7 +168,7 @@ import * as React from 'react'
 import {
   CustomSaveButtonProps,
   CustomSaveDraftButtonProps,
-  CustomPublishButtonProps,
+  CustomPublishButtonType,
   CustomPreviewButtonProps,
 } from 'payload/types'
 
@@ -188,7 +185,7 @@ export const CustomSaveDraftButton: CustomSaveDraftButtonProps = ({
   return <DefaultButton label={label} disabled={disabled} saveDraft={saveDraft} />
 }
 
-export const CustomPublishButton: CustomPublishButtonProps = ({
+export const CustomPublishButton: CustomPublishButtonType = ({
   DefaultButton,
   disabled,
   label,
@@ -217,18 +214,18 @@ export const MyCollection: SanitizedCollectionConfig = {
         PreviewButton: CustomPreviewButton,
       },
     },
-  },
+  }
 }
 ```
 
-### Collection views
+#### Collection views
 
 To swap out entire views on collections, you can use the `admin.components.views` property on the collection's config. Payload renders the following views by default, all of which can be overridden:
 
-| Property   | Description                                                               |
-| ---------- | ------------------------------------------------------------------------- |
-| **`Edit`** | The Edit view is used to edit a single document for a given collection.   |
-| **`List`** | The List view is used to show a list of documents for a given collection. |
+| Property           | Description                                                                                                                  |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`Edit`**         | The Edit view is used to edit a single document for a given collection.                                                      |
+| **`List`**         | The List view is used to show a list of documents for a given collection.                                                    |
 
 To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. This will replace the entire view, including the page breadcrumbs, title, tabs, etc, _as well as all nested routes_.
 
@@ -297,7 +294,7 @@ Here's an example of how you can customize nested views within the `Edit` view i
 
 You can also add _new_ tabs to the `Edit` view by adding another key to the `components.views.Edit[key]` object with a `path` and `Component` property. See [Custom Tabs](#custom-tabs) for more information.
 
-## Globals
+### Globals
 
 As with Collections, you can override components on a global-by-global basis via the `admin.components` property.
 
@@ -309,13 +306,13 @@ As with Collections, you can override components on a global-by-global basis via
 | **`elements.PreviewButton`**   | Replace the default `Preview` button with a custom component.                                                          |
 | **`views`**                    | Override or create new views within the Payload Admin UI. [More](#global-views)                                        |
 
-### Global views
+#### Global views
 
 To swap out views for globals, you can use the `admin.components.views` property on the global's config. Payload renders the following views by default, all of which can be overridden:
 
-| Property   | Description                                                         |
-| ---------- | ------------------------------------------------------------------- |
-| **`Edit`** | The Edit view is used to edit a single document for a given Global. |
+| Property           | Description                                                                                                                  |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`Edit`**         | The Edit view is used to edit a single document for a given Global.                                                          |
 
 To swap out any of these views, simply pass in your custom component to the `admin.components.views` property of your Payload config. This will replace the entire view, including the page breadcrumbs, title, and tabs, _as well as all nested views_.
 
@@ -378,17 +375,17 @@ Here's how you can customize nested views within the `Edit` view in Globals, inc
 
 You can also add _new_ tabs to the `Edit` view by adding another key to the `components.views.Edit[key]` object with a `path` and `Component` property. See [Custom Tabs](#custom-tabs) for more information.
 
-## Custom Tabs
+### Custom Tabs
 
 You can easily swap individual collection or global edit views. To do this, pass an _object_ to the `admin.components.views.Edit` property of the config. Payload renders the following views by default, all of which can be overridden:
 
-| Property          | Description                                                                                                                 |
-| ----------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| **`Default`**     | The Default view is the primary view in which your document is edited.                                                      |
-| **`Versions`**    | The Versions view is used to view the version history of a single document. [More details](../versions)                     |
-| **`Version`**     | The Version view is used to view a single version of a single document for a given collection. [More details](../versions). |
-| **`API`**         | The API view is used to display the REST API JSON response for a given document.                                            |
-| **`LivePreview`** | The LivePreview view is used to display the Live Preview interface. [More details](../live-preview)                         |
+| Property           | Description                                                                                                                  |
+| ------------------ | ---------------------------------------------------------------------------------------------------------------------------- |
+| **`Default`**      | The Default view is the primary view in which your document is edited.                                                       |
+| **`Versions`**     | The Versions view is used to view the version history of a single document. [More details](../versions)                      |
+| **`Version`**      | The Version view is used to view a single version of a single document for a given collection. [More details](../versions).  |
+| **`API`**          | The API view is used to display the REST API JSON response for a given document.                                             |
+| **`LivePreview`**  | The LivePreview view is used to display the Live Preview interface. [More details](../live-preview)                          |
 
 Here is an example:
 
@@ -399,8 +396,7 @@ export const MyCollection: SanitizedCollectionConfig = {
   admin: {
     components: {
       views: {
-        Edit: {
-          // You can also define `components.views.Edit` as a component, this will override _all_ nested views
+        Edit: { // You can also define `components.views.Edit` as a component, this will override _all_ nested views
           Default: MyCustomDefaultTab,
           Versions: MyCustomVersionsTab,
           Version: MyCustomVersionTab,
@@ -427,7 +423,7 @@ export const MyCollection: SanitizedCollectionConfig = {
             Component: MyCustomTab,
             path: '/my-custom-tab',
             // You an swap the entire tab component out for your own
-            Tab: MyCustomTab,
+            Tab: MyCustomTab
           },
           AnotherCustomView: {
             Component: AnotherCustomView,
@@ -436,7 +432,7 @@ export const MyCollection: SanitizedCollectionConfig = {
             Tab: {
               label: 'Another Custom View',
               href: '/another-custom-view',
-            },
+            }
           },
         },
       },
@@ -445,7 +441,7 @@ export const MyCollection: SanitizedCollectionConfig = {
 }
 ```
 
-## Building a custom view component
+### Building a custom view component
 
 Your custom view components will be given all the props that a React Router `<Route />` typically would receive, as well as two props from Payload:
 
@@ -470,7 +466,7 @@ You can find examples of custom views in the [Payload source code `/test/admin/c
 
 To see how to pass in your custom views to create custom views of your own, take a look at the `admin.components.views` property of the [Payload test admin config](https://github.com/payloadcms/payload/blob/main/test/admin/config.ts).
 
-## Fields
+### Fields
 
 All Payload fields support the ability to swap in your own React components. So, for example, instead of rendering a default Text input, you might need to render a color picker that provides the editor with a custom color picker interface to restrict the data entered to colors only.
 
@@ -531,7 +527,7 @@ const CustomCell: React.FC<Props> = (props) => {
 
 When writing your own custom components you can make use of a number of hooks to set data, get reactive changes to other fields, get the id of the document or interact with a context from a custom provider.
 
-## Sending and receiving values from the form
+### Sending and receiving values from the form
 
 When swapping out the `Field` component, you'll be responsible for sending and receiving the field's `value` from the form itself. To do so, import the `useField` hook as follows:
 
@@ -543,6 +539,7 @@ const CustomTextField: React.FC<{ path: string }> = ({ path }) => {
   const { value, setValue } = useField<string>({ path })
   // highlight-end
 
+
   return <input onChange={(e) => setValue(e.target.value)} value={value} />
 }
 ```
@@ -556,20 +553,19 @@ const CustomTextField: React.FC<{ path: string }> = ({ path }) => {
 
 These are the props that will be passed to your custom Label.
 
-| Property       | Description                                                      |
-| -------------- | ---------------------------------------------------------------- |
-| **`htmlFor`**  | Property used to set `for` attribute for label.                  |
-| **`label`**    | Label value provided in field, it can be used with i18n.         |
-| **`required`** | A boolean value that represents if the field is required or not. |
+| Property         | Description                                                      |
+| ---------------- | ---------------------------------------------------------------- |
+| **`htmlFor`**    | Property used to set `for` attribute for label.                  |
+| **`label`**      | Label value provided in field, it can be used with i18n.         |
+| **`required`**   | A boolean value that represents if the field is required or not. |
 
 #### Example
 
 ```tsx
-'use client'
 import React from 'react'
-import { getTranslation } from '@payloadcms/translations'
-import { useTranslation } from '@payloadcms/ui/providers/Translation'
+import { useTranslation } from 'react-i18next'
 
+import { getTranslation } from 'payload/utilities/getTranslation'
 
 type Props = {
   htmlFor?: string
@@ -583,12 +579,10 @@ const CustomLabel: React.FC<Props> = (props) => {
   const { i18n } = useTranslation()
 
   if (label) {
-    return (
-      <span>
-        {getTranslation(label, i18n)}
-        {required && <span className="required">*</span>}
-      </span>
-    )
+    return (<span>
+      {getTranslation(label, i18n)}
+      {required && <span className="required">*</span>}
+    </span>);
   }
 
   return null
@@ -599,10 +593,10 @@ const CustomLabel: React.FC<Props> = (props) => {
 
 These are the props that will be passed to your custom Error.
 
-| Property        | Description                                                   |
-| --------------- | ------------------------------------------------------------- |
-| **`message`**   | The error message.                                            |
-| **`showError`** | A boolean value that represents if the error should be shown. |
+| Property         | Description                                                   |
+| ---------------- | ------------------------------------------------------------- |
+| **`message`**    | The error message.                                            |
+| **`showError`**  | A boolean value that represents if the error should be shown. |
 
 #### Example
 
@@ -618,8 +612,8 @@ const CustomError: React.FC<Props> = (props) => {
   const { message, showError } = props
 
   if (showError) {
-    return <p style={{ color: 'red' }}>{message}</p>
-  } else return null
+    return <p style={{color: 'red'}}>{message}</p>
+  } else return null;
 }
 ```
 
@@ -636,15 +630,7 @@ import { Field } from 'payload/types'
 import './style.scss'
 
 const ClearButton: React.FC = () => {
-  return (
-    <button
-      onClick={() => {
-        /* ... */
-      }}
-    >
-      X
-    </button>
-  )
+  return <button onClick={() => {/* ... */}}>X</button>
 }
 
 const titleField: Field = {
@@ -652,12 +638,12 @@ const titleField: Field = {
   type: 'text',
   admin: {
     components: {
-      afterInput: [ClearButton],
-    },
-  },
+      afterInput: [ClearButton]
+    }
+  }
 }
 
-export default titleField
+export default titleField;
 ```
 
 ## Custom providers
@@ -669,9 +655,9 @@ As your admin customizations gets more complex you may want to share state betwe
   component for the admin UI to show
 </Banner>
 
-## Styling Custom Components
+### Styling Custom Components
 
-Payload exports its SCSS variables and mixins for reuse in your own custom components. This is helpful in cases where you might want to style a custom input similarly to Payload's built-ini styling, so it blends more thoroughly into the existing admin UI.
+Payload exports its SCSS variables and mixins for reuse in your own custom components. This is helpful in cases where you might want to style a custom input similarly to Payload's built-in styling, so it blends more thoroughly into the existing admin UI.
 
 To make use of Payload SCSS variables / mixins to use directly in your own components, you can import them as follows:
 
@@ -679,23 +665,23 @@ To make use of Payload SCSS variables / mixins to use directly in your own compo
 @import '~payload/scss';
 ```
 
-## Getting the current language
+### Getting the current language
 
-When developing custom components you can support multiple languages to be consistent with Payload's i18n support. The best way to do this is to add your translation resources to the [i18n configuration](https://payloadcms.com/docs/configuration/i18n) and import `useTranslation` from `@payloadcms/ui/providers/Translation` in your components.
+When developing custom components you can support multiple languages to be consistent with Payload's i18n support. The best way to do this is to add your translation resources to the [i18n configuration](https://payloadcms.com/docs/configuration/i18n) and import `useTranslation` from `react-i18next` in your components.
 
 For example:
 
 ```tsx
-import { useTranslation } from '@payloadcms/ui/providers/Translation'
+import { useTranslation } from 'react-i18next'
 
 const CustomComponent: React.FC = () => {
   // highlight-start
-  const { t, i18n } = useTranslation()
+  const { t, i18n } = useTranslation('namespace1')
   // highlight-end
 
   return (
     <ul>
-      <li>{t('namespace1:key', { variable: 'value' })}</li>
+      <li>{t('key', { variable: 'value' })}</li>
       <li>{t('namespace2:key', { variable: 'value' })}</li>
       <li>{i18n.language}</li>
     </ul>
@@ -703,7 +689,7 @@ const CustomComponent: React.FC = () => {
 }
 ```
 
-## Getting the current locale
+### Getting the current locale
 
 In any custom component you can get the selected locale with `useLocale` hook. `useLocale` returns the full locale object, consisting of a `label`, `rtl`(right-to-left) property, and then `code`. Here is a simple example:
 

docs/admin/customizing-css.mdx

@@ -6,7 +6,7 @@ desc: Customize your Payload admin panel further by adding your own CSS or SCSS
 keywords: admin, css, scss, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-## Adding your own CSS / SCSS
+### Adding your own CSS / SCSS
 
 You can add your own CSS by providing your base Payload config with a path to your own CSS or SCSS. Customize the styling of any part of the Payload dashboard as necessary.
 
@@ -25,7 +25,7 @@ const config = buildConfig({
 })
 ```
 
-## Overriding built-in styles
+### Overriding built-in styles
 
 To make it as easy as possible for you to override our styles, Payload uses [BEM naming conventions](http://getbem.com/) for all CSS within the Admin UI. If you provide your own CSS, you can override any built-in styles easily.
 
@@ -41,7 +41,7 @@ You can find the built-in Payload CSS variables within [`./src/admin/scss/app.sc
 - Fonts
 - Horizontal gutter
 
-### Dark mode
+#### Dark mode
 
 <Banner type="warning">
   If you're overriding colors or theme elevations, make sure to consider how your changes will

docs/admin/excluding-server-code.mdx

@@ -10,7 +10,7 @@ It's common for your config to rely on server only modules to perform logic in a
 
 Any file that imports a server-only module such as `fs`, `stripe`, `authorizenet`, `nodemailer`, etc. **cannot** be included in the browser bundle.
 
-## Example Scenario
+#### Example Scenario
 
 Say we have a collection called `Subscriptions` that has a `beforeChange` hook that creates a Stripe subscription whenever a Subscription document is created in Payload.
 
@@ -79,7 +79,7 @@ export const createStripeSubscription = async ({ data, operation }) => {
 
 **As-is, this collection will prevent your Admin panel from bundling or loading correctly, because Stripe relies on some Node-only packages.**
 
-## How to exclude server-only code
+#### How to fix this
 
 You need to make sure that you use `alias`es to tell your bundler to import "safe" files vs. attempting to import any server-side code that you need to get rid of. Depending on your bundler (Webpack, Vite, etc.) the steps involved may be slightly different.
 
@@ -104,7 +104,6 @@ By default the browser bundle will now include all the code from that file and a
 To fix this, we need to alias the `createStripeSubscription` file to a different file that can safely be included in the browser bundle.
 
 First, we will create a mock file to replace the server-only file when bundling:
-
 ```js
 // mocks/modules.js
 
@@ -132,7 +131,7 @@ import { Subscriptions } from './collections/Subscriptions'
 const mockModulePath = path.resolve(__dirname, 'mocks/emptyObject.js')
 const fullFilePath = path.resolve(
   __dirname,
-  'collections/Subscriptions/hooks/createStripeSubscription',
+  'collections/Subscriptions/hooks/createStripeSubscription'
 )
 
 export default buildConfig({
@@ -174,23 +173,24 @@ export default buildConfig({
   admin: {
     bundler: viteBundler(),
     vite: (incomingViteConfig) => {
-      const existingAliases = incomingViteConfig?.resolve?.alias || {}
-      let aliasArray: { find: string | RegExp; replacement: string }[] = []
+      const existingAliases = incomingViteConfig?.resolve?.alias || {};
+      let aliasArray: { find: string | RegExp; replacement: string; }[] = [];
 
       // Pass the existing Vite aliases
       if (Array.isArray(existingAliases)) {
-        aliasArray = existingAliases
+        aliasArray = existingAliases;
       } else {
-        aliasArray = Object.values(existingAliases)
+        aliasArray = Object.values(existingAliases);
       }
 
+
       // highlight-start
       // Add your own aliases using the find and replacement keys
       // remember, vite aliases are exact-match only
       aliasArray.push({
         find: '../server-only-module',
-        replacement: path.resolve(__dirname, './path/to/browser-safe-module.js'),
-      })
+        replacement: path.resolve(__dirname, './path/to/browser-safe-module.js')
+      });
       // highlight-end
 
       return {
@@ -198,8 +198,8 @@ export default buildConfig({
         resolve: {
           ...(incomingViteConfig?.resolve || {}),
           alias: aliasArray,
-        },
-      }
+        }
+      };
     },
   },
 })

docs/admin/hooks.mdx

@@ -8,7 +8,7 @@ keywords: admin, components, custom, documentation, Content Management System, c
 
 Payload provides a variety of powerful hooks that can be used within your own React components. With them, you can interface with Payload itself and build just about any type of complex customization you can think of—directly in familiar React code.
 
-## useField
+### useField
 
 The `useField` hook is used internally within every applicable Payload field component, and it manages sending and receiving a field's state from its parent form.
 
@@ -52,7 +52,7 @@ const {
 // The rest of your component goes here
 ```
 
-## useFormFields
+### useFormFields
 
 There are times when a custom field component needs to have access to data from other fields, and you have a few options to do so. The `useFormFields` hook is a powerful and highly performant way to retrieve a form's field state, as well as to retrieve the `dispatchFields` method, which can be helpful for setting other fields' form states from anywhere within a form.
 
@@ -81,7 +81,7 @@ const MyComponent: React.FC = () => {
 }
 ```
 
-## useAllFormFields
+### useAllFormFields
 
 **To retrieve more than one field**, you can use the `useAllFormFields` hook. Your component will re-render when _any_ field changes, so use this hook only if you absolutely need to. Unlike the `useFormFields` hook, this hook does not accept a "selector", and it always returns an array with type of `[fields: Fields, dispatch: React.Dispatch<Action>]]`.
 
@@ -109,7 +109,7 @@ const ExampleComponent: React.FC = () => {
 };
 ```
 
-#### Updating other fields' values
+##### Updating other fields' values
 
 If you are building a custom component, then you should use `setValue` which is returned from the `useField` hook to programmatically set your field's value. But if you're looking to update _another_ field's value, you can use `dispatchFields` returned from `useFormFields`.
 
@@ -128,7 +128,7 @@ You can send the following actions to the `dispatchFields` function.
 
 To see types for each action supported within the `dispatchFields` hook, check out the Form types [here](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/components/forms/Form/types.ts).
 
-## useForm
+### useForm
 
 The `useForm` hook can be used to interact with the form itself, and sends back many methods that can be used to reactively fetch form state without causing rerenders within your components each time a field is changed. This is useful if you have action-based callbacks that your components fire, and need to interact with form state _based on a user action_.
 
@@ -635,16 +635,16 @@ export const CustomArrayManager = () => {
   ]}
 />
 
-## useCollapsible
+### useCollapsible
 
 The `useCollapsible` hook allows you to control parent collapsibles:
 
-| Property                  | Description                                                                                                  |
-| ------------------------- | ------------------------------------------------------------------------------------------------------------ | --- |
-| **`isCollapsed`**         | State of the collapsible. `true` if open, `false` if collapsed                                               |
-| **`isVisible`**           | If nested, determine if the nearest collapsible is visible. `true` if no parent is closed, `false` otherwise |
-| **`toggle`**              | Toggles the state of the nearest collapsible                                                                 |
-| **`isWithinCollapsible`** | Determine when you are within another collaspible                                                            |     |
+| Property                  | Description                                                                                                        |
+|---------------------------|--------------------------------------------------------------------------------------------------------------------|
+| **`collapsed`**          | State of the collapsible. `true` if open, `false` if collapsed                                                 |
+| **`isVisible`**              | If nested, determine if the nearest collapsible is visible. `true` if no parent is closed, `false` otherwise                                                        |
+| **`toggle`**                  | Toggles the state of the nearest collapsible                                                                |
+| **`withinCollapsible`**      | Determine when you are within another collaspible                                 |                                               |
 
 **Example:**
 
@@ -654,11 +654,10 @@ import React from 'react'
 import { useCollapsible } from 'payload/components/utilities'
 
 const CustomComponent: React.FC = () => {
-  const { isCollapsed, toggle } = useCollapsible()
-
+  const { collapsed, toggle } = useCollapsible()
   return (
     <div>
-      <p className="field-type">I am {isCollapsed ? 'closed' : 'open'}</p>
+      <p className="field-type">I am {collapsed ? 'closed' : 'open'}</p>
       <button onClick={toggle} type="button">
         Toggle
       </button>
@@ -667,12 +666,12 @@ const CustomComponent: React.FC = () => {
 }
 ```
 
-## useDocumentInfo
+### useDocumentInfo
 
 The `useDocumentInfo` hook provides lots of information about the document currently being edited, including the following:
 
 | Property                  | Description                                                                                                        |
-| ------------------------- | ------------------------------------------------------------------------------------------------------------------ |
+|---------------------------|--------------------------------------------------------------------------------------------------------------------|
 | **`collection`**          | If the doc is a collection, its collection config will be returned                                                 |
 | **`global`**              | If the doc is a global, its global config will be returned                                                         |
 | **`id`**                  | If the doc is a collection, its ID will be returned                                                                |
@@ -707,7 +706,7 @@ const LinkFromCategoryToPosts: React.FC = () => {
 }
 ```
 
-## useLocale
+### useLocale
 
 In any custom component you can get the selected locale object with the `useLocale` hook. `useLocale`gives you the full locale object, consisting of a `label`, `rtl`(right-to-left) property, and then `code`. Here is a simple example:
 
@@ -728,7 +727,7 @@ const Greeting: React.FC = () => {
 }
 ```
 
-## useAuth
+### useAuth
 
 Useful to retrieve info about the currently logged in user as well as methods for interacting with it. It sends back an object with the following properties:
 
@@ -755,7 +754,7 @@ const Greeting: React.FC = () => {
 }
 ```
 
-## useConfig
+### useConfig
 
 Used to easily fetch the full Payload config.
 
@@ -771,7 +770,7 @@ const MyComponent: React.FC = () => {
 }
 ```
 
-## useEditDepth
+### useEditDepth
 
 Sends back how many editing levels "deep" the current component is. Edit depth is relevant while adding new documents / editing documents in modal windows and other cases.
 
@@ -787,11 +786,11 @@ const MyComponent: React.FC = () => {
 }
 ```
 
-## usePreferences
+### usePreferences
 
 Returns methods to set and get user preferences. More info can be found [here](https://payloadcms.com/docs/admin/preferences).
 
-## useTheme
+### useTheme
 
 Returns the currently selected theme (`light`, `dark` or `auto`), a set function to update it and a boolean `autoMode`, used to determine if the theme value should be set automatically based on the user's device preferences.
 
@@ -805,21 +804,19 @@ const MyComponent: React.FC = () => {
 
   return (
     <>
-      <span>
-        The current theme is {theme} and autoMode is {autoMode}
-      </span>
+      <span>The current theme is {theme} and autoMode is {autoMode}</span>
       <button
         type="button"
-        onClick={() => setTheme((prev) => (prev === 'light' ? 'dark' : 'light'))}
+        onClick={() => setTheme(prev => prev === "light" ? "dark" : "light")}
       >
         Toggle theme
       </button>
     </>
-  )
+    )
 }
 ```
 
-## useTableColumns
+### useTableColumns
 
 Returns methods to manipulate table columns
 
@@ -836,21 +833,24 @@ const MyComponent: React.FC = () => {
   // highlight-end
 
   return (
-    <button type="button" onClick={resetColumns}>
+    <button
+      type="button"
+      onClick={resetColumns}
+    >
       Reset columns
     </button>
   )
 }
 ```
 
-## useDocumentEvents
+### useDocumentEvents
 
 The `useDocumentEvents` hook provides a way of subscribing to cross-document events, such as updates made to nested documents within a drawer. This hook will report document events that are outside the scope of the document currently being edited. This hook provides the following:
 
-| Property               | Description                                                                                                                             |
-| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| **`mostRecentUpdate`** | An object containing the most recently updated document. It contains the `entitySlug`, `id` (if collection), and `updatedAt` properties |
-| **`reportUpdate`**     | A method used to report updates to documents. It accepts the same arguments as the `mostRecentUpdate` property.                         |
+| Property                  | Description                                                                                                                               |
+|---------------------------|-------------------------------------------------------------------------------------------------------------------------------------------|
+| **`mostRecentUpdate`**    | An object containing the most recently updated document. It contains the `entitySlug`, `id` (if collection), and `updatedAt` properties   |
+| **`reportUpdate`**        | A method used to report updates to documents. It accepts the same arguments as the `mostRecentUpdate` property.                           |
 
 **Example:**
 
@@ -860,11 +860,14 @@ import { useDocumentEvents } from 'payload/components/hooks'
 const ListenForUpdates: React.FC = () => {
   const { mostRecentUpdate } = useDocumentEvents()
 
-  return <span>{JSON.stringify(mostRecentUpdate)}</span>
+  return (
+    <span>
+      {JSON.stringify(mostRecentUpdate)}
+    </span>
+  )
 }
 ```
 
 <Banner type="info">
-  Right now the `useDocumentEvents` hook only tracks recently updated documents, but in the future
-  it will track more document-related events as needed, such as document creation, deletion, etc.
+  Right now the `useDocumentEvents` hook only tracks recently updated documents, but in the future it will track more document-related events as needed, such as document creation, deletion, etc.
 </Banner>

docs/admin/overview.mdx

@@ -33,7 +33,7 @@ All options for the Admin panel are defined in your base Payload config file.
 | `bundler`         | The bundler that you would like to use to bundle the admin panel. Officially supported bundlers: [Webpack](/docs/admin/webpack) and [Vite](/docs/admin/vite).                                                                                                               |
 | `user`            | The `slug` of a Collection that you want be used to log in to the Admin dashboard. [More](/docs/admin/overview#the-admin-user-collection)                                                                                                                                   |
 | `buildPath`       | Specify an absolute path for where to store the built Admin panel bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                                                                                                                            |
-| `meta`            | Base meta data to use for the Admin panel. Included properties are `titleSuffix`, `icons`, and `openGraph`. Can be overridden on a per collection or per global basis.                                                                                                      |
+| `meta`            | Base meta data to use for the Admin panel. Included properties are `titleSuffix`, `ogImage`, and `favicon`.                                                                                                                                                                 |
 | `disable`         | If set to `true`, the entire Admin panel will be disabled.                                                                                                                                                                                                                  |
 | `indexHTML`       | Optionally replace the entirety of the `index.html` file used by the Admin panel. Reference the [base index.html file](https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/index.html) to ensure your replacement has the appropriate HTML elements. |
 | `css`             | Absolute path to a stylesheet that you can use to override / customize the Admin panel styling. [More](/docs/admin/customizing-css).                                                                                                                                        |
@@ -45,7 +45,8 @@ All options for the Admin panel are defined in your base Payload config file.
 | `components`      | Component overrides that affect the entirety of the Admin panel. [More](/docs/admin/components)                                                                                                                                                                             |
 | `webpack`         | Customize the Webpack config that's used to generate the Admin panel. [More](/docs/admin/webpack)                                                                                                                                                                           |
 | `vite`            | Customize the Vite config that's used to generate the Admin panel. [More](/docs/admin/vite)                                                                                                                                                                                 |
-| `routes`          | Replace built-in Admin Panel routes with your own custom routes. I.e. `{ logout: '/custom-logout', inactivity: 'custom-inactivity' }`                                                                                                                                       |
+| `logoutRoute`     | The route for the `logout` page.                                                                                                                                                                                                                                            |
+| `inactivityRoute` | The route for the `logout` inactivity page.                                                                                                                                                                                                                                 |
 
 ### The Admin User Collection
 

docs/admin/preferences.mdx

@@ -21,7 +21,7 @@ Out of the box, Payload handles the persistence of your users' preferences in a
   that is reading or setting a preference via all provided authentication methods.
 </Banner>
 
-## Use cases
+### Use cases
 
 This API is used significantly for internal operations of the Admin panel, as mentioned above. But, if you're building your own React components for use in the Admin panel, you can allow users to set their own preferences in correspondence to their usage of your components. For example:
 
@@ -30,7 +30,7 @@ This API is used significantly for internal operations of the Admin panel, as me
 - You might want to store `recentlyAccessed` documents to give admin editors an easy shortcut back to their recently accessed documents on the `Dashboard` or similar
 - Many other use cases exist. Invent your own! Give your editors an intelligent and persistent editing experience.
 
-## Database
+### Database
 
 Payload automatically creates an internally used `payload-preferences` collection that stores user preferences. Each document in the `payload-preferences` collection contains the following shape:
 
@@ -44,15 +44,15 @@ Payload automatically creates an internally used `payload-preferences` collectio
 | `createdAt`       | A timestamp of when the preference was created.                   |
 | `updatedAt`       | A timestamp set to the last time the preference was updated.      |
 
-## APIs
+### APIs
 
 Preferences are available to both [GraphQL](/docs/graphql/overview#preferences) and [REST](/docs/rest-api/overview#) APIs.
 
-## Adding or reading Preferences in your own components
+### Adding or reading Preferences in your own components
 
 The Payload admin panel offers a `usePreferences` hook. The hook is only meant for use within the admin panel itself. It provides you with two methods:
 
-#### `getPreference`
+##### `getPreference`
 
 This async method provides an easy way to retrieve a user's preferences by `key`. It will return a promise containing the resulting preference value.
 
@@ -60,7 +60,7 @@ This async method provides an easy way to retrieve a user's preferences by `key`
 
 - `key`: the `key` of your preference to retrieve.
 
-#### `setPreference`
+##### `setPreference`
 
 Also async, this method provides you with an easy way to set a user preference. It returns `void`.
 

docs/admin/vite.mdx

@@ -6,8 +6,7 @@ desc: NEEDS TO BE WRITTEN
 ---
 
 <Banner type="info">
-  The Vite bundler is currently in beta. If you would like to help us test this package, we'd love
-  to hear from you if you find any [bugs or issues](https://github.com/payloadcms/payload/issues/)!
+  The Vite bundler is currently in beta. If you would like to help us test this package, we'd love to hear from you if you find any [bugs or issues](https://github.com/payloadcms/payload/issues/)!
 </Banner>
 
 Payload has a Vite bundler that you can install and bundle the Admin Panel with. This is an alternative to the [Webpack](/docs/admin/webpack) bundler and might give some performance boosts to your development workflow.
@@ -28,7 +27,7 @@ export default buildConfig({
   collections: [],
   admin: {
     bundler: viteBundler(),
-  },
+  }
 })
 ```
 
@@ -37,8 +36,7 @@ Vite works fundamentally differently than Webpack. In development mode, it will
 It then uses Rollup to create production builds of your admin UI. With Vite, you should see a decent performance boost—especially after your first cold start. However, that first cold start might take a few more seconds.
 
 <Banner type="warning">
-  In most cases, Vite should work out of the box. But existing Payload plugins may need to make
-  compatibility changes to support Vite.
+  In most cases, Vite should work out of the box. But existing Payload plugins may need to make compatibility changes to support Vite.
 </Banner>
 
 This is because Vite aliases work fundamentally differently than Webpack aliases, and Payload relies on aliasing server-only code out of the Payload config to ensure that the bundled admin JS works within your browser.
@@ -116,7 +114,7 @@ That plugin should create an alias to support Vite as follows:
 
 This will effectively alias the entire plugin and work with Vite. If the plugin requires admin-specific code, then the `./my-admin-plugin.js` alias target file should reflect any changes necessary to the admin UI that the main server-side plugin performs.
 
-## Extending the Vite config
+### Extending the Vite config
 
 The Payload config supports a new property for plugins to be able to extend the Vite config specifically. That property exists on the main Payload config under `admin.vite`. You can check out the [Vite docs](https://vitejs.dev/config/shared-options.html) for more information on what you can do with the Vite config.
 

docs/admin/webpack.mdx

@@ -10,13 +10,13 @@ Payload has a Webpack (v5) bundler that you can build the Admin panel with. For
 
 Out of the box, the Webpack bundler supports common functionalities such as SCSS and Typescript, but there are many cases where you may need to add support for additional functionalities.
 
-## Installation
+#### Installation
 
 ```bash
 yarn add @payloadcms/bundler-webpack
 ```
 
-### Import the bundler
+#### Import the bundler
 
 ```ts
 // payload.config.ts
@@ -27,13 +27,13 @@ import { webpackBundler } from '@payloadcms/bundler-webpack'
 export default buildConfig({
   // highlight-start
   admin: {
-    bundler: webpackBundler(),
+    bundler: webpackBundler()
   },
   // highlight-end
 })
 ```
 
-## Extending Webpack
+### Extending Webpack
 
 If you need to extend the Webpack config, you can do so by passing a function to the `admin.webpack` property on your Payload config.
 The function will receive the Webpack config as an argument and should return the modified config.

docs/authentication/config.mdx

@@ -13,7 +13,7 @@ To enable Authentication on a collection, define an `auth` property and set it t
 ## Options
 
 | Option                     | Description                                                                                                                                                                                                                         |
-|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`useAPIKey`**            | Payload Authentication provides for API keys to be set on each user within an Authentication-enabled Collection. [More](/docs/authentication/config#api-keys)                                                                       |
 | **`tokenExpiration`**      | How long (in seconds) to keep the user logged in. JWTs and HTTP-only cookies will both expire at the same time.                                                                                                                     |
 | **`maxLoginAttempts`**     | Only allow a user to attempt logging in X amount of times. Automatically locks out a user from authenticating if this limit is passed. Set to `0` to disable.                                                                       |
@@ -49,8 +49,7 @@ To enable API keys on a collection, set the `useAPIKey` auth option to `true`. F
   <strong>Important:</strong>
   If you change your `PAYLOAD_SECRET`, you will need to regenerate your API keys.
   <br />
-  The secret key is used to encrypt the API keys, so if you change the secret, existing API keys will
-  no longer be valid.
+  The secret key is used to encrypt the API keys, so if you change the secret, existing API keys will no longer be valid.
 </Banner>
 
 #### Authenticating via API Key
@@ -217,7 +216,7 @@ Example:
 {
   slug: 'customers',
   auth: {
-    forgotPassword: {
+    verify: {
       // highlight-start
       generateEmailSubject: ({ req, user }) => {
         return `Hey ${user.email}, reset your password!`;

docs/authentication/operations.mdx

@@ -8,7 +8,7 @@ keywords: authentication, config, configuration, documentation, Content Manageme
 
 Enabling Authentication on a Collection automatically exposes additional auth-based operations in the Local, REST, and GraphQL APIs.
 
-## Access
+### Access
 
 The Access operation returns what a logged in user can and can't do with the collections and globals that are registered via your config. This data can be immensely helpful if your app needs to show and hide certain features based on access control, as the Payload Admin panel does.
 
@@ -69,7 +69,7 @@ query {
 
 Document access can also be queried on a collection/global basis. Access on a global can queried like `http://localhost:3000/api/global-slug/access`, Collection document access can be queried like `http://localhost:3000/api/collection-slug/access/:id`.
 
-## Me
+### Me
 
 Returns either a logged in user with token or null when there is no logged in user.
 
@@ -105,7 +105,7 @@ query {
 }
 ```
 
-## Login
+### Login
 
 Accepts an `email` and `password`. On success, it will return the logged in user as well as a token that can be used to authenticate. In the GraphQL and REST APIs, this operation also automatically sets an HTTP-only cookie including the user's token. If you pass an Express `res` to the Local API operation, Payload will set a cookie there as well.
 
@@ -166,7 +166,7 @@ const result = await payload.login({
 })
 ```
 
-## Logout
+### Logout
 
 As Payload sets HTTP-only cookies, logging out cannot be done by just removing a cookie in JavaScript, as HTTP-only cookies are inaccessible by JS within the browser. So, Payload exposes a `logout` operation to delete the token in a safe way.
 
@@ -189,7 +189,7 @@ mutation {
 }
 ```
 
-## Refresh
+### Refresh
 
 Allows for "refreshing" JWTs. If your user has a token that is about to expire, but the user is still active and using the app, you might want to use the `refresh` operation to receive a new token by sending the operation the token that is about to expire.
 
@@ -244,7 +244,7 @@ mutation {
   `token` arg.
 </Banner>
 
-## Verify by Email
+### Verify by Email
 
 If your collection supports email verification, the Verify operation will be exposed which accepts a verification token and sets the user's `_verified` property to `true`, thereby allowing the user to authenticate with the Payload API.
 
@@ -276,7 +276,7 @@ const result = await payload.verifyEmail({
 })
 ```
 
-## Unlock
+### Unlock
 
 If a user locks themselves out and you wish to deliberately unlock them, you can utilize the Unlock operation. The Admin panel features an Unlock control automatically for all collections that feature max login attempts, but you can programmatically unlock users as well by using the Unlock operation.
 
@@ -309,7 +309,7 @@ const result = await payload.unlock({
 })
 ```
 
-## Forgot Password
+### Forgot Password
 
 Payload comes with built-in forgot password functionality. Submitting an email address to the Forgot Password operation will generate an email and send it to the respective email address with a link to reset their password.
 
@@ -361,7 +361,7 @@ const token = await payload.forgotPassword({
   use the token to "reset" their password.
 </Banner>
 
-## Reset Password
+### Reset Password
 
 After a user has "forgotten" their password and a token is generated, that token can be used to send to the reset password operation along with a new password which will allow the user to reset their password securely.
 

docs/authentication/overview.mdx

@@ -30,7 +30,7 @@ _Admin panel screenshot depicting an Admins Collection with Auth enabled_
 
 By default, Payload provides you with a `User` collection that supports Authentication, which is used to access the Admin panel. But, you can add support to one or many Collections of your own. For more information on how to customize, override, or remove the default `User` collection, [click here](/docs/admin/overview#the-admin-user-collection).
 
-## Enabling Auth on a collection
+### Enabling Auth on a collection
 
 Every Payload Collection can opt-in to supporting Authentication by specifying the `auth` property on the Collection's config to either `true` or to an object containing `auth` options.
 
@@ -57,7 +57,12 @@ export const Admins: CollectionConfig = {
       name: 'role',
       type: 'select',
       required: true,
-      options: ['user', 'admin', 'editor', 'developer'],
+      options: [
+        'user',
+        'admin',
+        'editor',
+        'developer',
+      ],
     },
   ],
 }
@@ -71,11 +76,11 @@ export const Admins: CollectionConfig = {
 
 Once enabled, each document that is created within the Collection can be thought of as a `user` - who can make use of commonly required authentication functions such as logging in / out, resetting their password, and more.
 
-## Logging in / out, resetting password, etc.
+### Logging in / out, resetting password, etc.
 
 [Click here](/docs/authentication/operations) for a list of all automatically-enabled Auth operations, including `login`, `logout`, `refresh`, and others.
 
-## Token-based auth
+### Token-based auth
 
 Successfully logging in returns a `JWT` (JSON web token) which is how a user will identify themselves to Payload. By providing this JWT via either an HTTP-only cookie or an `Authorization: JWT` or `Authorization: Bearer` header, Payload will automatically identify the user and add its user JWT data to the Express `req`, which is available throughout Payload including within access control, hooks, and more.
 
@@ -89,15 +94,15 @@ You can specify what data gets encoded to the JWT token by setting `saveToJWT` t
   property.
 </Banner>
 
-## HTTP-only cookies
+### HTTP-only cookies
 
 Payload `login`, `logout`, and `refresh` operations make use of HTTP-only cookies for authentication purposes. HTTP-only cookies are a highly secure method of storing identifiable data on a user's device so that Payload can automatically recognize a returning user until their cookie expires. They are totally protected from common XSS attacks and cannot be read at all via JavaScript in the browser.
 
-#### Automatic browser inclusion
+##### Automatic browser inclusion
 
 Modern browsers automatically include `http-only` cookies when making requests directly to URLs—meaning that if you are running your API on http://example.com, and you have logged in and visit http://example.com/test-page, your browser will automatically include the Payload authentication cookie for you.
 
-#### Using Fetch or other HTTP APIs
+##### Using Fetch or other HTTP APIs
 
 However, if you use `fetch` or similar APIs to retrieve Payload resources from its REST or GraphQL API, you need to specify to include credentials (cookies).
 
@@ -121,7 +126,7 @@ For more about how to automatically include cookies in requests from your app to
   will still show HTTP-only cookies, even when JavaScript running on the page can't.
 </Banner>
 
-## CSRF Protection
+### CSRF Protection
 
 CSRF (cross-site request forgery) attacks are common and dangerous. By using an HTTP-only cookie, Payload removes many XSS vulnerabilities, however, CSRF attacks can still be possible.
 
@@ -159,7 +164,7 @@ const config = buildConfig({
 export default config
 ```
 
-## Identifying users via the Authorization Header
+### Identifying users via the Authorization Header
 
 In addition to authenticating via an HTTP-only cookie, you can also identify users via the `Authorization` header on an HTTP request.
 

docs/cloud/configuration.mdx

@@ -6,7 +6,7 @@ desc: Quickly configure and deploy your Payload Cloud project in a few simple st
 keywords: configuration, config, settings, project, cloud, payload cloud, deploy, deployment
 ---
 
-## Select your plan
+### Select your plan
 
 Once you have created a project, you will need to select your plan. This will determine the resources that are allocated to your project and the features that are available to you.
 
@@ -17,7 +17,7 @@ Once you have created a project, you will need to select your plan. This will de
   anytime.
 </Banner>
 
-## Project Details
+### Project Details
 
 | Option           | Description                                                                                                                                                                                                                                   |
 | ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -26,7 +26,7 @@ Once you have created a project, you will need to select your plan. This will de
 | **Project Slug** | Choose a unique slug to identify your project. This needs to be unique for your team and you can change it any time.                                                                                                                          |
 | **Team**         | Select the team you want to create the project under. If this is your first project, a personal team will be created for you automatically. You can modify your team settings and invite new members at any time from the Team Settings page. |
 
-## Build Settings
+### Build Settings
 
 If you are deploying a new project from a template, the following settings will be automatically configured for you. If you are using your own repository, you need to make sure your build settings are accurate for your project to deploy correctly.
 
@@ -39,7 +39,7 @@ If you are deploying a new project from a template, the following settings will
 | **Branch to Deploy** | Select the branch of your repository that you want to deploy from. This is the branch that will be used to build your project when you commit new changes.        |
 | **Default Domain**   | Set a default domain for your project. This must be unique and you will not able to change it. You can always add a custom domain later in your project settings. |
 
-## Environment Variables
+### Environment Variables
 
 Any of the features in Payload Cloud that require environment variables will automatically be provided to your application. If your app requires any custom environment variables, you can set them here.
 
@@ -49,7 +49,7 @@ Any of the features in Payload Cloud that require environment variables will aut
   [here](https://payloadcms.com/docs/admin/webpack#admin-environment-vars).
 </Banner>
 
-## Payment
+### Payment
 
 Payment methods can be set per project and can be updated any time. You can use team’s default payment method, or add a new one. Modify your payment methods in your Project settings / Team settings.
 

docs/cloud/projects.mdx

@@ -6,7 +6,7 @@ desc: Manage your Payload Cloud projects.
 keywords: cloud, payload cloud, projects, project, overview, database, file storage, build settings, environment variables, custom domains, email, developing locally
 ---
 
-## Overview
+### Overview
 
 <Banner>
   The overview tab shows your most recent deployment, along with build and deployment logs. From
@@ -18,19 +18,19 @@ keywords: cloud, payload cloud, projects, project, overview, database, file stor
 ![Payload Cloud Overview Page](https://payloadcms.com/images/docs/cloud/overview-page.jpg)
 _A screenshot of the Overview page for a Cloud project._
 
-## Database
+### Database
 
 Your Payload Cloud project comes with a MongoDB serverless Atlas DB instance or a Dedicated Atlas cluster, depending on your plan. To interact with your cloud database, you will be provided with a MongoDB connection string. This can be found under the **Database** tab of your project.
 
 `mongodb+srv://your_connection_string`
 
-## File Storage
+### File Storage
 
 Payload Cloud gives you S3 file storage backed by Cloudflare as a CDN, and this plugin extends Payload so that all of your media will be stored in S3 rather than locally.
 
 AWS Cognito is used for authentication to your S3 bucket. The [Payload Cloud Plugin](https://github.com/payloadcms/plugin-cloud) will automatically pick up these values. These values are only if you'd like to access your files directly, outside of Payload Cloud.
 
-### Accessing Files Outside of Payload Cloud
+#### Accessing Files Outside of Payload Cloud
 
 If you'd like to access your files outside of Payload Cloud, you'll need to retrieve some values from your project's settings and put them into your environment variables. In Payload Cloud, navigate to the File Storage tab and copy the values using the copy button. Put these values in your .env file. Also copy the Cognito Password value separately and put into your .env file as well.
 
@@ -50,11 +50,11 @@ PAYLOAD_CLOUD_COGNITO_PASSWORD=
 
 The plugin will pick up these values and use them to access your files.
 
-## Build Settings
+### Build Settings
 
 You can update settings from your Project’s Settings tab. Changes to your build settings will trigger a redeployment of your project.
 
-## Environment Variables
+### Environment Variables
 
 From the Environment Variables page of the Settings tab, you can add, update and delete variables for use in your project. Like build settings, these changes will trigger a redeployment of your project.
 
@@ -64,7 +64,7 @@ From the Environment Variables page of the Settings tab, you can add, update and
   [here](https://payloadcms.com/docs/admin/webpack#admin-environment-vars).
 </Banner>
 
-## Custom Domains
+### Custom Domains
 
 With Payload Cloud, you can add custom domain names to your project. To do so, first go to the Domains page of the Settings tab of your project. Here you can see your default domain. To add a new domain, type in the domain name you wish to use.
 
@@ -84,19 +84,19 @@ export default buildConfig({
 })
 ```
 
-## Email
+### Email
 
 Powered by [Resend](https://resend.com), Payload Cloud comes with integrated email support out of the box. No configuration is needed, and you can use `payload.sendEmail()` to send email right from your Payload app. To learn more about sending email with Payload, checkout the [Email Configuration](https://payloadcms.com/docs/email/overview) overview.
 
 If you are on the Pro or Enterprise plan, you can add your own custom Email domain name. From the Email page of your project’s Settings, add the domain you wish to use for email delivery. This will generate a set of DNS records. Add these records to your DNS provider and click verify to check that your records are resolving properly. Once verified, your emails will now be sent from your custom domain name.
 
-## Developing Locally
+### Developing Locally
 
 To make changes to your project, you will need to clone the repository defined in your project settings to your local machine. In order to run your project locally, you will need configure your local environment first. Refer to your repository’s `README.md` file to see the steps needed for your specific template.
 
 From there, you are ready to make updates to your project. When you are ready to make your changes live, commit your changes to the branch you specified in your Project settings, and your application will automatically trigger a redeploy and build from your latest commit.
 
-## Cloud Plugin
+### Cloud Plugin
 
 Projects generated from a template will come pre-configured with the official Cloud Plugin, but if you are using your own repository you will need to add this into your project. To do so, add the plugin to your Payload config:
 
@@ -117,7 +117,7 @@ export default buildConfig({
   over Payload Cloud's email service.
 </Banner>
 
-#### **Optional configuration**
+##### **Optional configuration**
 
 If you wish to opt-out of any Payload cloud features, the plugin also accepts options to do so.
 

docs/cloud/teams.mdx

@@ -14,22 +14,22 @@ keywords: team, teams, billing, subscription, payment, plan, plans, cloud, paylo
 ![Payload Cloud Team Settings](https://payloadcms.com/images/docs/cloud/team-settings.jpg)
 _A screenshot of the Team Settings page._
 
-## Members
+### Members
 
 Each team has members that can interact with your projects. You can invite multiple people to your team and each individual can belong to more than one team. You can assign them either `owner` or `user` permissions. Owners are able to make admin-only changes, such as deleting projects, and editing billing information.
 
-## Adding Members
+### Adding Members
 
 To add a new member to your team, visit your Team’s Settings page, and click “Invite Teammate”. You can then add their email address, and assign their role. Press “Save” to send the invitations, which will send an email to the invited team member where they can create a new account.
 
-## Billing
+### Billing
 
 Users can update billing settings and subscriptions for any teams where they are designated as an `owner`. To make updates to the team’s payment methods, visit the Billing page under the Team Settings tab. You can add new cards, delete cards, and set a payment method as a default. The default payment method will be used in the event that another payment method fails.
 
-## Subscriptions
+### Subscriptions
 
 From the Subscriptions page, a team owner can see all current plans for their team. From here, you can see the price of each plan, if there is an active trial, and when you will be billed next.
 
-## Invoices
+### Invoices
 
 The Invoices page will you show you the invoices for your account, as well as the status on their payment.

docs/configuration/collections.mdx

@@ -13,29 +13,28 @@ It's often best practice to write your Collections in separate files and then im
 
 ## Options
 
-| Option                 | Description                                                                                                                                                                                                              |
-|------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`slug`** \*          | Unique, URL-friendly string that will act as an identifier for this Collection.                                                                                                                                          |
-| **`fields`** \*        | Array of field types that will determine the structure and functionality of the data stored within this Collection. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
-| **`labels`**           | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined.                                                                                           |
-| **`admin`**            | Admin-specific configuration. See below for [more detail](#admin-options).                                                                                                                                               |
-| **`hooks`**            | Entry points to "tie in" to Collection actions at specific points. [More](/docs/hooks/overview#collection-hooks)                                                                                                         |
-| **`access`**           | Provide access control functions to define exactly who should be able to do what with Documents in this Collection. [More](/docs/access-control/overview/#collections)                                                   |
-| **`auth`**             | Specify options if you would like this Collection to feature authentication. For more, consult the [Authentication](/docs/authentication/config) documentation.                                                          |
-| **`upload`**           | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](/docs/upload/overview) documentation.                                                                         |
-| **`timestamps`**       | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps.                                                                                                                       |
-| **`versions`**         | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#collection-config)                                                                                            |
-| **`endpoints`**        | Add custom routes to the REST API. Set to `false` to disable routes. [More](/docs/rest-api/overview#custom-endpoints)                                                                                                    |
-| **`graphQL`**          | An object with `singularName` and `pluralName` strings used in schema generation. Auto-generated from slug if not defined. Set to `false` to disable GraphQL.                                                            |
-| **`typescript`**       | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                      |
-| **`disableDuplicate`** | When true, do not show the "Duplicate" button while editing documents within this collection and prevent `duplicate` from all APIs.                                                                                      |
-| **`defaultSort`**      | Pass a top-level field to sort by default in the collection List view. Prefix the name of the field with a minus symbol ("-") to sort in descending order.                                                               |
+| Option            | Description                                                                                                                                                                                                              |
+|-------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`slug`** \*     | Unique, URL-friendly string that will act as an identifier for this Collection.                                                                                                                                          |
+| **`fields`** \*   | Array of field types that will determine the structure and functionality of the data stored within this Collection. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
+| **`labels`**      | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined.                                                                                           |
+| **`admin`**       | Admin-specific configuration. See below for [more detail](#admin-options).                                                                                                                                               |
+| **`hooks`**       | Entry points to "tie in" to Collection actions at specific points. [More](/docs/hooks/overview#collection-hooks)                                                                                                         |
+| **`access`**      | Provide access control functions to define exactly who should be able to do what with Documents in this Collection. [More](/docs/access-control/overview/#collections)                                                   |
+| **`auth`**        | Specify options if you would like this Collection to feature authentication. For more, consult the [Authentication](/docs/authentication/config) documentation.                                                          |
+| **`upload`**      | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](/docs/upload/overview) documentation.                                                                         |
+| **`timestamps`**  | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps.                                                                                                                       |
+| **`versions`**    | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#collection-config)                                                                                            |
+| **`endpoints`**   | Add custom routes to the REST API. Set to `false` to disable routes. [More](/docs/rest-api/overview#custom-endpoints)                                                                                                    |
+| **`graphQL`**     | An object with `singularName` and `pluralName` strings used in schema generation. Auto-generated from slug if not defined. Set to `false` to disable GraphQL.                                                            |
+| **`typescript`**  | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                      |
+| **`defaultSort`** | Pass a top-level field to sort by default in the collection List view. Prefix the name of the field with a minus symbol ("-") to sort in descending order.                                                               |
+| **`custom`**      | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                |
 | **`dbName`**      | Custom table or collection name depending on the database adapter. Auto-generated from slug if not defined.
-| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                                |
 
 _\* An asterisk denotes that a property is required._
 
-### Simple collection example
+#### Simple collection example
 
 ```ts
 import { CollectionConfig } from 'payload/types'
@@ -58,36 +57,37 @@ export const Orders: CollectionConfig = {
 }
 ```
 
-### More collection config examples
+#### More collection config examples
 
 You can find an assortment
-of [example collection configs](https://github.com/payloadcms/public-demo/tree/master/src/payload/collections) in the Public
+of [example collection configs](https://github.com/payloadcms/public-demo/tree/master/src/payload/collections) in the
+Public
 Demo source code on GitHub.
 
-## Admin options
+### Admin options
 
 You can customize the way that the Admin panel behaves on a collection-by-collection basis by defining the `admin`
 property on a collection's config.
 
 | Option                       | Description                                                                                                                                                                                           |
-| ---------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `group`                      | Text used as a label for grouping collection and global links together in the navigation.                                                                                                             |
 | `hidden`                     | Set to true or a function, called with the current user, returning true to exclude this collection from navigation and admin routing.                                                                 |
 | `hooks`                      | Admin-specific hooks for this collection. [More](#admin-hooks)                                                                                                                                        |
 | `useAsTitle`                 | Specify a top-level field to use for a document title throughout the Admin panel. If no field is defined, the ID of the document is used as the title.                                                |
 | `description`                | Text or React component to display below the Collection label in the List view to give editors more information.                                                                                      |
 | `defaultColumns`             | Array of field names that correspond to which columns to show by default in this collection's List view.                                                                                              |
+| `disableDuplicate `          | Disables the "Duplicate" button while editing documents within this collection.                                                                                                                       |
 | `hideAPIURL`                 | Hides the "API URL" meta field while editing documents within this collection.                                                                                                                        |
 | `enableRichTextLink`         | The [Rich Text](/docs/fields/rich-text) field features a `Link` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default.         |
 | `enableRichTextRelationship` | The [Rich Text](/docs/fields/rich-text) field features a `Relationship` element which allows for users to automatically reference related documents within their rich text. Set to `true` by default. |
-| `meta`                       | Metadata overrides to apply to the [Admin panel](../admin/overview). Included properties are `description` and `openGraph`.                                                                           |
 | `preview`                    | Function to generate preview URLS within the Admin panel that can point to your app. [More](#preview).                                                                                                |
 | `livePreview`                | Enable real-time editing for instant visual feedback of your front-end application. [More](/docs/live-preview/overview).                                                                              |
 | `components`                 | Swap in your own React components to be used within this collection. [More](/docs/admin/components#collections)                                                                                       |
 | `listSearchableFields`       | Specify which fields should be searched in the List search view. [More](#list-searchable-fields)                                                                                                      |
 | **`pagination`**             | Set pagination-specific options for this collection. [More](#pagination)                                                                                                                              |
 
-## Preview
+### Preview
 
 Collection `admin` options can accept a `preview` function that will be used to generate a link pointing to the frontend
 of your app to preview data.
@@ -126,32 +126,32 @@ export const Posts: CollectionConfig = {
 }
 ```
 
-## Pagination
+### Pagination
 
 Here are a few options that you can specify options for pagination on a collection-by-collection basis:
 
 | Option         | Description                                                                                         |
-| -------------- | --------------------------------------------------------------------------------------------------- |
+|----------------|-----------------------------------------------------------------------------------------------------|
 | `defaultLimit` | Integer that specifies the default per-page limit that should be used. Defaults to 10.              |
 | `limits`       | Provide an array of integers to use as per-page options for admins to choose from in the List view. |
 
-## Access control
+### Access control
 
 You can specify extremely granular access control (what users can do with documents in a collection) on a collection by
 collection basis. To learn more, go to the [Access Control](/docs/access-control/overview) docs.
 
-## Hooks
+### Hooks
 
 Hooks are a powerful way to extend collection functionality and execute your own logic, and can be defined on a
 collection by collection basis. To learn more, go to the [Hooks](/docs/hooks/overview) documentation.
 
-## Field types
+### Field types
 
 Collections support all field types that Payload has to offer—including simple fields like text and checkboxes all the
 way to more complicated layout-building field groups like Blocks. [Click here](/docs/fields/overview) to learn more
 about field types.
 
-## List Searchable Fields
+### List Searchable Fields
 
 In the List view, there is a "search" box that allows you to quickly find a document with a search. By default, it
 searches on the ID field. If you have `admin.useAsTitle` defined, the list search will use that field. However, you can
@@ -169,7 +169,54 @@ those three fields plus the ID field.
   so your admin queries can remain performant.
 </Banner>
 
-## TypeScript
+### Admin Hooks
+
+In addition to collection hooks themselves, Payload provides for admin UI-specific hooks that you can leverage.
+
+**`beforeDuplicate`**
+
+The `beforeDuplicate` hook is an async function that accepts an object containing the data to duplicate, as well as the
+locale of the doc to duplicate. Within this hook, you can modify the data to be duplicated, which is useful in cases
+where you have unique fields that need to be incremented or similar, as well as if you want to automatically modify a
+document's `title`.
+
+Example:
+
+```ts
+import { BeforeDuplicate, CollectionConfig } from 'payload/types'
+// Your auto-generated Page type
+import { Page } from '../payload-types.ts'
+
+const beforeDuplicate: BeforeDuplicate<Page> = ({ data }) => {
+  return {
+    ...data,
+    title: `${data.title} Copy`,
+    uniqueField: data.uniqueField ? `${data.uniqueField}-copy` : '',
+  }
+}
+
+export const Page: CollectionConfig = {
+  slug: 'pages',
+  admin: {
+    hooks: {
+      beforeDuplicate,
+    },
+  },
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+    },
+    {
+      name: 'uniqueField',
+      type: 'text',
+      unique: true,
+    },
+  ],
+}
+```
+
+### TypeScript
 
 You can import collection types as follows:
 

docs/configuration/express.mdx

@@ -8,7 +8,7 @@ keywords: config, configuration, documentation, Content Management System, cms,
 
 Payload utilizes a few Express-specific middleware packages within its own routers. You can customize how they work by passing in configuration options to the main Payload config's `express` property.
 
-## Custom Middleware
+### Custom Middleware
 
 Payload allows you to pass in custom Express middleware to be used on all of the routes it opens. This is useful for adding logging or any other custom functionality to your endpoints.
 
@@ -42,7 +42,7 @@ const requestLoggerMiddleware = (req, res, next) => {
 }
 ```
 
-## JSON
+### JSON
 
 `express.json()` is used to parse JSON body content into JavaScript objects accessible on the Express `req`. Payload allows you to customize all of the `json` method's options. Common examples of customization use-cases are increasing the max allowed JSON body size which defaults to `2MB`.
 
@@ -60,7 +60,7 @@ const requestLoggerMiddleware = (req, res, next) => {
 
 You can find a list of all available options that are able to be passed to `express.json()` [here](https://expressjs.com/en/api.html).
 
-## Compression
+### Compression
 
 Payload uses the `compression` package to optimize transfer size for all of the routes it opens, and you can pass customization options through the Payload config.
 

docs/configuration/globals.mdx

@@ -6,14 +6,18 @@ desc: Set up your Global config for your needs by defining fields, adding slugs
 keywords: globals, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-Global configs are in many ways similar to [Collections](/docs/configuration/collections). The big difference is that Collections will potentially contain _many_ documents, while a Global is a "one-off". Globals are perfect for things like header nav, site-wide banner alerts, app-wide localized strings, and other "global" data that your site or app might rely on.
+Global configs are in many ways similar to [Collections](/docs/configuration/collections). The big difference is that
+Collections will potentially contain _many_ documents, while a Global is a "one-off". Globals are perfect for things
+like header nav, site-wide banner alerts, app-wide localized strings, and other "global" data that your site or app
+might rely on.
 
-As with Collection configs, it's often best practice to write your Globals in separate files and then import them into the main Payload config.
+As with Collection configs, it's often best practice to write your Globals in separate files and then import them into
+the main Payload config.
 
 ## Options
 
 | Option             | Description                                                                                                                                                                                                          |
-| ------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **`slug`** \*      | Unique, URL-friendly string that will act as an identifier for this Global.                                                                                                                                          |
 | **`fields`** \*    | Array of field types that will determine the structure and functionality of the data stored within this Global. [Click here](/docs/fields/overview) for a full list of field types as well as how to configure them. |
 | **`label`**        | Text for the name in the Admin panel or an object with keys for each language. Auto-generated from slug if not defined.                                                                                              |
@@ -30,7 +34,7 @@ As with Collection configs, it's often best practice to write your Globals in se
 
 _\* An asterisk denotes that a property is required._
 
-### Simple Global example
+#### Simple Global example
 
 ```ts
 import { GlobalConfig } from 'payload/types'
@@ -58,29 +62,32 @@ const Nav: GlobalConfig = {
 export default Nav
 ```
 
-### Global config example
+#### Global config example
 
-You can find a few [example Global configs](https://github.com/payloadcms/public-demo/tree/master/src/payload/globals) in the Public Demo source code on GitHub.
+You can find a few [example Global configs](https://github.com/payloadcms/public-demo/tree/master/src/payload/globals)
+in the Public Demo source code on GitHub.
 
-## Admin options
+### Admin options
 
-You can customize the way that the Admin panel behaves on a Global-by-Global basis by defining the `admin` property on a Global's config.
+You can customize the way that the Admin panel behaves on a Global-by-Global basis by defining the `admin` property on a
+Global's config.
 
 | Option        | Description                                                                                                                       |
-| ------------- | --------------------------------------------------------------------------------------------------------------------------------- |
+|---------------|-----------------------------------------------------------------------------------------------------------------------------------|
 | `group`       | Text used as a label for grouping collection and global links together in the navigation.                                         |
 | `hidden`      | Set to true or a function, called with the current user, returning true to exclude this global from navigation and admin routing. |
 | `components`  | Swap in your own React components to be used within this Global. [More](/docs/admin/components#globals)                           |
 | `preview`     | Function to generate a preview URL within the Admin panel for this global that can point to your app. [More](#preview).           |
 | `livePreview` | Enable real-time editing for instant visual feedback of your front-end application. [More](/docs/live-preview/overview).          |
 | `hideAPIURL`  | Hides the "API URL" meta field while editing documents within this collection.                                                    |
-| `meta`        | Metadata overrides to apply to the [Admin panel](../admin/overview). Included properties are `description` and `openGraph`.       |
 
-## Preview
+### Preview
 
-Global `admin` options can accept a `preview` function that will be used to generate a link pointing to the frontend of your app to preview data.
+Global `admin` options can accept a `preview` function that will be used to generate a link pointing to the frontend of
+your app to preview data.
 
-If the function is specified, a Preview button will automatically appear in the corresponding global's Edit view. Clicking the Preview button will link to the URL that is generated by the function.
+If the function is specified, a Preview button will automatically appear in the corresponding global's Edit view.
+Clicking the Preview button will link to the URL that is generated by the function.
 
 **The preview function accepts two arguments:**
 
@@ -113,19 +120,24 @@ export const MyGlobal: GlobalConfig = {
 }
 ```
 
-## Access control
+### Access control
 
-As with Collections, you can specify extremely granular access control (what users can do with this Global) on a Global-by-Global basis. However, Globals only have `update` and `read` access control due to their nature of only having one document. To learn more, go to the [Access Control](/docs/access-control/overview) docs.
+As with Collections, you can specify extremely granular access control (what users can do with this Global) on a
+Global-by-Global basis. However, Globals only have `update` and `read` access control due to their nature of only having
+one document. To learn more, go to the [Access Control](/docs/access-control/overview) docs.
 
-## Hooks
+### Hooks
 
-Globals also fully support a smaller subset of Hooks. To learn more, go to the [Hooks](/docs/hooks/overview) documentation.
+Globals also fully support a smaller subset of Hooks. To learn more, go to the [Hooks](/docs/hooks/overview)
+documentation.
 
-## Field types
+### Field types
 
-Globals support all field types that Payload has to offer—including simple fields like text and checkboxes all the way to more complicated layout-building field groups like Blocks. [Click here](/docs/fields/overview) to learn more about field types.
+Globals support all field types that Payload has to offer—including simple fields like text and checkboxes all the way
+to more complicated layout-building field groups like Blocks. [Click here](/docs/fields/overview) to learn more about
+field types.
 
-## TypeScript
+### TypeScript
 
 You can import global types as follows:
 

docs/configuration/i18n.mdx

@@ -6,7 +6,7 @@ desc: Manage and customize internationalization support in your CMS editor exper
 keywords: internationalization, i18n, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-Not only does Payload support managing localized content, it also has internationalization support so that admin users can work in their preferred language. It comes included by default and can be extended in your config.
+Not only does Payload support managing localized content, it also has internationalization support so that admin users can work in their preferred language. Payload's i18n support is built on top of [i18next](https://www.i18next.com). It comes included by default and can be extended in your config.
 
 While Payload's built-in features come translated, you may want to also translate parts of your project's configuration too. This is possible in places like collections and globals labels and groups, field labels, descriptions and input placeholder text. The admin UI will display all the correct translations you provide based on the user's language.
 
@@ -56,7 +56,7 @@ export const Articles: CollectionConfig = {
 }
 ```
 
-## Admin UI
+### Admin UI
 
 The Payload admin panel reads the language settings of a user's browser and display all text in that language, or will fall back to English if the user's language is not yet supported.
 After a user logs in, they can change their language selection in the `/account` view.
@@ -68,13 +68,15 @@ After a user logs in, they can change their language selection in the `/account`
   [contributions](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md).
 </Banner>
 
-## Node Express
+### Node Express
 
 Payload's backend uses express middleware to set the language on incoming requests before they are handled. This allows backend validation to return error messages in the user's own language or system generated emails to be sent using the correct translation. You can make HTTP requests with the `accept-language` header and Payload will use that language.
 
-Anywhere in your Payload app that you have access to the `req` object, you can access payload's extensive internationalization features assigned to `req.i18n`. To access text translations you can use `req.t('namespace:key')`.
+Anywhere in your Payload app that you have access to the `req` object, you can access i18next's extensive internationalization features assigned to `req.i18n`. To access text translations you can use `req.t('namespace:key')`.
 
-## Configuration Options
+Read the i18next [API documentation](https://www.i18next.com/overview/api) to learn more.
+
+### Configuration Options
 
 In your Payload config, you can add translations and customize the settings in `i18n`. Payload will use your custom options and merge it with the default, allowing you to override the settings Payload provides.
 
@@ -86,8 +88,9 @@ import { buildConfig } from 'payload/config'
 export default buildConfig({
   //...
   i18n: {
-    fallbackLanguage: 'en', // default
-    translations: {
+    fallbackLng: 'en', // default
+    debug: false, // default
+    resources: {
       en: {
         custom: {
           // namespace can be anything you want
@@ -104,63 +107,4 @@ export default buildConfig({
 })
 ```
 
-## Types for custom translations
-
-In order to use custom translations in your project, you need to provide the types for the translations. Here is an example of how you can define the types for the custom translations in a custom react component:
-
-```ts
-'use client'
-import type { NestedKeysStripped } from '@payloadcms/translations'
-import type React from 'react'
-
-import { useTranslation } from '@payloadcms/ui/providers/Translation'
-
-const customTranslations = {
-  en: {
-    general: {
-      test: 'Custom Translation',
-    },
-  },
-}
-
-type CustomTranslationObject = typeof customTranslations.en
-type CustomTranslationKeys = NestedKeysStripped<CustomTranslationObject>
-
-export const MyComponent: React.FC = () => {
-  const { i18n, t } = useTranslation<CustomTranslationObject, CustomTranslationKeys>() // These generics merge your custom translations with the default client translations
-
-  return t('general:test')
-}
-
-```
-
-Additionally, payload exposes the `t` function in various places, for example in labels. Here is how you would type those:
-
-```ts
-import type {
-  DefaultTranslationKeys,
-  NestedKeysStripped,
-  TFunction,
-} from '@payloadcms/translations'
-import type { Field } from 'payload/types'
-
-const customTranslations = {
-  en: {
-    general: {
-      test: 'Custom Translation',
-    },
-  },
-}
-
-type CustomTranslationObject = typeof customTranslations.en
-type CustomTranslationKeys = NestedKeysStripped<CustomTranslationObject>
-
-const field: Field = {
-  name: 'myField',
-  type: 'text',
-  label: (
-    { t }: { t: TFunction<CustomTranslationKeys | DefaultTranslationKeys> }, // The generic passed to TFunction does not automatically merge the custom translations with the default translations. We need to merge them ourselves here
-  ) => t('fields:addLabel'),
-}
-```
-
+See the i18next [configuration options](https://www.i18next.com/overview/configuration-options) to learn more.

docs/configuration/localization.mdx

@@ -9,7 +9,7 @@ keywords: localization, internationalization, i18n, config, configuration, docum
 Payload features deep field-based localization support. Maintaining as many locales as you need is easy. All
 localization support is opt-in by default. To do so, follow the two steps below.
 
-## Enabling in the Payload config
+### Enabling in the Payload config
 
 Add the `localization` property to your Payload config to enable localization project-wide. You'll need to provide a
 list of all locales that you'd like to support as well as set a few other options.
@@ -103,10 +103,10 @@ right-to-left), and `fallbackLocale` property. The locale codes do not need to b
 to define how to represent your locales. Common patterns are to use two-letter ISO 639 language codes or four-letter
 language and country codes (ISO 3166‑1) such as `en-US`, `en-UK`, `es-MX`, etc.
 
-## Locale Object Properties
+### Locale Properties:
 
 | Option               | Description                                                                                                                    |
-| -------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
+|----------------------|--------------------------------------------------------------------------------------------------------------------------------|
 | **`code`** \*        | Unique code to identify the language throughout the APIs for `locale` and `fallbackLocale`                                     |
 | **`label`**          | A string to use for the selector when choosing a language, or an object keyed on the i18n keys for different languages in use. |
 | **`rtl`**            | A boolean that when true will make the admin UI display in Right-To-Left.                                                      |
@@ -125,7 +125,7 @@ Boolean enabling "fallback" locale functionality. If a document is requested in
 localized value corresponding to the requested locale, then if this property is enabled, the document will automatically
 fall back to the fallback locale value. If this property is not enabled, the value will not be populated.
 
-## Field by field localization
+### Field by field localization
 
 Payload localization works on a **field** level—not a document level. In addition to configuring the base Payload config
 to support localization, you need to specify each field that you would like to localize.
@@ -166,12 +166,12 @@ and `block`s.
   strategy.
 </Banner>
 
-## Retrieving localized docs
+### Retrieving localized docs
 
 When retrieving documents, you can specify which locale you'd like to receive as well as which fallback locale should be
 used.
 
-#### REST API
+##### REST API
 
 REST API locale functionality relies on URL query parameters.
 
@@ -190,7 +190,7 @@ valid locale as provided to your base Payload config, or `'null'`, `'false'`, or
 fetch('https://localhost:3000/api/pages?locale=es&fallback-locale=none');
 ```
 
-#### GraphQL API
+##### GraphQL API
 
 In the GraphQL API, you can specify `locale` and `fallbackLocale` args to all relevant queries and mutations.
 
@@ -204,11 +204,11 @@ The `fallbackLocale` arg will accept valid locales as well as `none` to disable
 
 ```graphql
 query {
-  Posts(locale: de, fallbackLocale: none) {
-    docs {
-      title
+    Posts(locale: de, fallbackLocale: none) {
+        docs {
+            title
+        }
     }
-  }
 }
 ```
 
@@ -218,7 +218,7 @@ query {
   arguments in nested related document queries.
 </Banner>
 
-#### Local API
+##### Local API
 
 You can specify `locale` as well as `fallbackLocale` within the Local API as well as properties on the `options`
 argument. The `locale` property will accept any valid locale, and the `fallbackLocale` property will accept any valid

docs/configuration/overview.mdx

@@ -19,37 +19,37 @@ Payload is a _config-based_, code-first CMS and application framework. The Paylo
 
 ## Options
 
-| Option                | Description                                                                                                                                                                        |
-| --------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `admin` \*            | Base Payload admin configuration. Specify bundler\*, custom components, control metadata, set the Admin user collection, and [more](/docs/admin/overview#admin-options). Required. |
-| `editor` \*           | Rich Text Editor which will be used by richText fields. Required.                                                                                                                  |
-| `db` \*               | Database Adapter which will be used by Payload. Read more [here](/docs/database/overview). Required.                                                                               |
-| `serverURL`           | A string used to define the absolute URL of your app including the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port      |
-| `collections`         | An array of all Collections that Payload will manage. To read more about how to define your collection configs, [click here](/docs/configuration/collections).                     |
-| `globals`             | An array of all Globals that Payload will manage. For more on Globals and their configs, [click here](/docs/configuration/globals).                                                |
-| `cors`                | Either a whitelist array of URLS to allow CORS requests from, or a wildcard string (`'*'`) to accept incoming requests from any domain.                                            |
-| `localization`        | Opt-in and control how Payload handles the translation of your content into multiple locales. [More](/docs/configuration/localization)                                             |
-| `graphQL`             | Manage GraphQL-specific functionality here. Define your own queries and mutations, manage query complexity limits, and [more](/docs/graphql/overview#graphql-options).             |
-| `cookiePrefix`        | A string that will be prefixed to all cookies that Payload sets.                                                                                                                   |
-| `csrf`                | A whitelist array of URLs to allow Payload cookies to be accepted from as a form of CSRF protection. [More](/docs/authentication/overview#csrf-protection)                         |
-| `defaultDepth`        | If a user does not specify `depth` while requesting a resource, this depth will be used. [More](/docs/getting-started/concepts#depth)                                              |
-| `maxDepth`            | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`.                                                |
-| `indexSortableFields` | Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar.                         |
-| `upload`              | Base Payload upload configuration. [More](/docs/upload/overview#payload-wide-upload-options).                                                                                      |
-| `routes`              | Control the routing structure that Payload binds itself to. Specify `admin`, `api`, `graphQL`, and `graphQLPlayground`.                                                            |
-| `email`               | Base email settings to allow Payload to generate email such as Forgot Password requests and other requirements. [More](/docs/email/overview#configuration)                         |
-| `express`             | Express-specific middleware options such as compression and JSON parsing. [More](/docs/configuration/express)                                                                      |
-| `debug`               | Enable to expose more detailed error information.                                                                                                                                  |
-| `telemetry`           | Disable Payload telemetry by passing `false`. [More](/docs/configuration/overview#telemetry)                                                                                       |
-| `rateLimit`           | Control IP-based rate limiting for all Payload resources. Used to prevent DDoS attacks and [more](/docs/production/preventing-abuse#rate-limiting-requests).                       |
-| `hooks`               | Tap into Payload-wide hooks. [More](/docs/hooks/overview)                                                                                                                          |
-| `plugins`             | An array of Payload plugins. [More](/docs/plugins/overview)                                                                                                                        |
-| `endpoints`           | An array of custom API endpoints added to the Payload router. [More](/docs/rest-api/overview#custom-endpoints)                                                                     |
-| `custom`              | Extension point for adding custom data (e.g. for plugins)                                                                                                                          |
+| Option                | Description                                                                                                                                                                       |
+| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `admin` \*            | Base Payload admin configuration. Specify bundler*, custom components, control metadata, set the Admin user collection, and [more](/docs/admin/overview#admin-options). Required. |
+| `editor` \*           | Rich Text Editor which will be used by richText fields. Required.                                                                                                                 |
+| `db` \*               | Database Adapter which will be used by Payload. Read more [here](/docs/database/overview). Required.                                                                              |
+| `serverURL`           | A string used to define the absolute URL of your app including the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port     |
+| `collections`         | An array of all Collections that Payload will manage. To read more about how to define your collection configs, [click here](/docs/configuration/collections).                    |
+| `globals`             | An array of all Globals that Payload will manage. For more on Globals and their configs, [click here](/docs/configuration/globals).                                               |
+| `cors`                | Either a whitelist array of URLS to allow CORS requests from, or a wildcard string (`'*'`) to accept incoming requests from any domain.                                           |
+| `localization`        | Opt-in and control how Payload handles the translation of your content into multiple locales. [More](/docs/configuration/localization)                                            |
+| `graphQL`             | Manage GraphQL-specific functionality here. Define your own queries and mutations, manage query complexity limits, and [more](/docs/graphql/overview#graphql-options).            |
+| `cookiePrefix`        | A string that will be prefixed to all cookies that Payload sets.                                                                                                                  |
+| `csrf`                | A whitelist array of URLs to allow Payload cookies to be accepted from as a form of CSRF protection. [More](/docs/authentication/overview#csrf-protection)                        |
+| `defaultDepth`        | If a user does not specify `depth` while requesting a resource, this depth will be used. [More](/docs/getting-started/concepts#depth)                                             |
+| `maxDepth`            | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`.                                               |
+| `indexSortableFields` | Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar.                        |
+| `upload`              | Base Payload upload configuration. [More](/docs/upload/overview#payload-wide-upload-options).                                                                                     |
+| `routes`              | Control the routing structure that Payload binds itself to. Specify `admin`, `api`, `graphQL`, and `graphQLPlayground`.                                                           |
+| `email`               | Base email settings to allow Payload to generate email such as Forgot Password requests and other requirements. [More](/docs/email/overview#configuration)                        |
+| `express`             | Express-specific middleware options such as compression and JSON parsing. [More](/docs/configuration/express)                                                                     |
+| `debug`               | Enable to expose more detailed error information.                                                                                                                                 |
+| `telemetry`           | Disable Payload telemetry by passing `false`. [More](/docs/configuration/overview#telemetry)                                                                                      |
+| `rateLimit`           | Control IP-based rate limiting for all Payload resources. Used to prevent DDoS attacks and [more](/docs/production/preventing-abuse#rate-limiting-requests).                      |
+| `hooks`               | Tap into Payload-wide hooks. [More](/docs/hooks/overview)                                                                                                                         |
+| `plugins`             | An array of Payload plugins. [More](/docs/plugins/overview)                                                                                                                       |
+| `endpoints`           | An array of custom API endpoints added to the Payload router. [More](/docs/rest-api/overview#custom-endpoints)                                                                    |
+| `custom`              | Extension point for adding custom data (e.g. for plugins)                                                                                                                         |
 
 _\* An asterisk denotes that a property is required._
 
-### Simple example
+#### Simple example
 
 ```ts
 import { buildConfig } from 'payload/config'
@@ -106,11 +106,11 @@ export default buildConfig({
 })
 ```
 
-### Full example config
+#### Full example config
 
 You can see a full [example config](https://github.com/payloadcms/public-demo/blob/master/src/payload/payload.config.ts) in the Public Demo source code on GitHub.
 
-## Using environment variables in your config
+### Using environment variables in your config
 
 We suggest using the `dotenv` package to handle environment variables alongside of Payload. All that's necessary to do is to require the package as high up in your application as possible (for example, at the top of your `server.js` file), and ensure that it can find an `.env` file that you create.
 
@@ -142,7 +142,7 @@ project-name
   can access it. [Click here](/docs/admin/webpack#admin-environment-vars) for more info.
 </Banner>
 
-## Customizing & Automating Config Location Detection
+### Customizing & Automating Config Location Detection
 
 Payload is designed to automatically locate your configuration file. By default, it will first look in the root of your current working directory for a file named `payload.config.js` or `payload.config.ts` if you're using TypeScript.
 
@@ -152,7 +152,7 @@ In production mode, Payload will first attempt to find the config file in the ou
 
 Please ensure your `tsconfig.json` is properly configured if you want Payload to accurately auto-detect your configuration file location. If `tsconfig.json` does not exist or doesn't specify `rootDir` or `outDir`, Payload will default to the current working directory.
 
-### Overriding the Config Location
+#### Overriding the Config Location
 
 In addition to the above automated detection, you can specify your own location for the Payload config file. This is done by using the environment variable `PAYLOAD_CONFIG_PATH`. The path you provide via this environment variable can either be absolute or relative to your current working directory. This can be useful in situations where your Payload config is not in a standard location, or you wish to switch between multiple configurations.
 
@@ -168,11 +168,11 @@ In addition to the above automated detection, you can specify your own location
 
 When `PAYLOAD_CONFIG_PATH` is set, Payload will use this path to load the configuration, bypassing all automated detection.
 
-## Developing within the Config
+### Developing within the Config
 
 Payload comes with `isomorphic-fetch` installed which means that even in Node, you can use the `fetch` API just as you would within the browser. No need to import `axios` or similar, unless you want to!
 
-## TypeScript
+### TypeScript
 
 You can import config types as follows:
 
@@ -190,7 +190,7 @@ import { SanitizedConfig } from 'payload/config'
 // Generally, this is only used internally by Payload.
 ```
 
-## Telemetry
+### Telemetry
 
 Payload collects **completely anonymous** telemetry data about general usage. This data is super important to us and helps us accurately understand how we're growing and what we can do to build the software into everything that it can possibly be. The telemetry that we collect also help us demonstrate our growth in an accurate manner, which helps us as we seek investment to build and scale our team. If we can accurately demonstrate our growth, we can more effectively continue to support Payload as free and open-source software. To opt out of telemetry, you can pass `telemetry: false` within your Payload config.
 

docs/database/migrations.mdx

@@ -20,11 +20,10 @@ Ensure you have an npm script called "payload" in your `package.json` file.
 ```
 
 <Banner>
-  Note that you need to run Payload migrations through the package manager that you are using,
-  because Payload should not be globally installed on your system.
+  Note that you need to run Payload migrations through the package manager that you are using, because Payload should not be globally installed on your system.
 </Banner>
 
-## Migration file contents
+### Migration file contents
 
 Payload stores all created migrations in a folder that you can specify. By default, migrations are stored
 in `./src/migrations`.
@@ -42,18 +41,18 @@ Here is an example migration file:
 ```ts
 import { MigrateUpArgs, MigrateDownArgs } from '@payloadcms/your-db-adapter'
 
-export async function up({ payload, req }: MigrateUpArgs): Promise<void> {
+export async function up ({ payload, req }: MigrateUpArgs): Promise<void> {
   // Perform changes to your database here.
   // You have access to `payload` as an argument, and
   // everything is done in TypeScript.
-}
+};
 
-export async function down({ payload, req }: MigrateDownArgs): Promise<void> {
+export async function down ({ payload, req }: MigrateDownArgs): Promise<void> {
   // Do whatever you need to revert changes if the `up` function fails
-}
+};
 ```
 
-## Migrations Directory
+### Migrations Directory
 
 Each DB adapter has an optional property `migrationDir` where you can override where you want your migrations to be
 stored/read. If this is not specified, Payload will check the default and possibly make a best effort to find your

docs/database/mongodb.mdx

@@ -28,17 +28,17 @@ export default buildConfig({
 })
 ```
 
-## Options
+### Options
 
 | Option               | Description                                                                                                                                                                                                                                                                                   |
-| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
+|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | `autoPluralization`  | Tell Mongoose to auto-pluralize any collection names if it encounters any singular words used as collection `slug`s.                                                                                                                                                                          |
 | `connectOptions`     | Customize MongoDB connection options. Payload will connect to your MongoDB database using default options which you can override and extend to include all the [options](https://mongoosejs.com/docs/connections.html#options) available to mongoose.                                         |
 | `disableIndexHints`  | Set to true to disable hinting to MongoDB to use 'id' as index. This is currently done when counting documents for pagination, as it increases the speed of the count function used in that query. Disabling this optimization might fix some problems with AWS DocumentDB. Defaults to false |
 | `migrationDir`       | Customize the directory that migrations are stored.                                                                                                                                                                                                                                           |
-| `transactionOptions` | An object with configuration properties used in [transactions](https://www.mongodb.com/docs/manual/core/transactions/) or `false` which will disable the use of transactions.                                                                                                                 |     |
+| `transactionOptions` | An object with configuration properties used in [transactions](https://www.mongodb.com/docs/manual/core/transactions/) or `false` which will disable the use of transactions.                                                                                                                 |                                                                                                                                                                                                                                                                     |
 
-## Access to Mongoose models
+### Access to Mongoose models
 
 After Payload is initialized, this adapter exposes all of your Mongoose models and they are available for you to work
 with directly.

docs/database/overview.mdx

@@ -19,7 +19,7 @@ To use a specific database adapter, you need to install it and configure it acco
 
 There are several factors to consider when choosing which database technology and hosting option is right for your project and workload. Payload can theoretically support any database, but it's up to you to decide which database to use.
 
-### When to use MongoDB
+#### When to use MongoDB
 
 If your project has a lot of dynamic fields, and you are comfortable with allowing Payload to enforce data integrity across your documents, MongoDB is a great choice. With it, your Payload documents are stored as _one_ document in your database—no matter if you have localization enabled, how many block or array fields you have, etc. This means that the shape of your data in your database will very closely reflect your field schema, and there is minimal complexity involved in storing or retrieving your data.
 
@@ -30,7 +30,7 @@ You should prefer MongoDB if:
 - Most (or everything) in your project is localized
 - You leverage a lot of array fields, block fields, or `hasMany` select fields and similar
 
-### When to use a relational DB
+#### When to use a relational DB
 
 Many projects might call for more rigid database architecture where the shape of your data is strongly enforced at the database level. For example, if you know the shape of your data and it's relatively "flat", and you don't anticipate it to change often, your workload might suit relational databases like Postgres very well.
 
@@ -40,17 +40,17 @@ You should prefer a relational DB like Postgres if:
 - You require enforced data consistency at the database level
 - You have a lot of relationships between collections and require relationships to be enforced
 
-### Differences in Payload features
+#### Differences in Payload features
 
-It's important to note that almost everything Payload does is available in all of our officially supported database adapters, including localization, arrays, blocks, etc.
+It's important to note that almost everything Payload does is available in all of our officially supported database adapters, including localization, arrays, blocks, etc. 
 
-The only thing that is not supported in Postgres yet is the [Point field](/docs/fields/point), but that should be added soon.
+The only thing that is not supported in Postgres yet is the [Point field](/docs/fields/point), but that should be added soon. 
 
 It's up to you to choose which database you would like to use.
 
 ## Configuration
 
-To configure the database for your Payload application, an adapter can be assigned to `config.db`. This property is required within your Payload config.
+To configure the database for your Payload application, an adapter can be assigned to `config.db`. This property is required within your Payload config. 
 
 Here's an example:
 
@@ -67,7 +67,7 @@ export default buildConfig({
   db: postgresAdapter({
     pool: {
       connectionString: process.env.DATABASE_URI,
-    },
+    }
   }),
 })
-```
+```

docs/database/postgres.mdx

@@ -9,8 +9,7 @@ keywords: Postgres, documentation, typescript, Content Management System, cms, h
 To use Payload with Postgres, install the package `@payloadcms/db-postgres`. It leverages Drizzle ORM and `node-postgres` to interact with a Postgres database that you provide.
 
 <Banner>
-  The Postgres database adapter is currently in beta. If you would like to help us test this
-  package, we'd love to hear if you find any bugs or issues!
+  The Postgres database adapter is currently in beta. If you would like to help us test this package, we'd love to hear if you find any bugs or issues!
 </Banner>
 
 It automatically manages changes to your database for you in development mode, and exposes a full suite of migration controls for you to leverage in order to keep other database environments in sync with your schema. DDL transformations are automatically generated.
@@ -31,12 +30,12 @@ export default buildConfig({
     // `pool` is required.
     pool: {
       connectionString: process.env.DATABASE_URI,
-    },
+    }
   }),
 })
 ```
 
-## Options
+### Options
 
 | Option                | Description                                                                                                                                                                                           |
 |-----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
@@ -51,7 +50,7 @@ export default buildConfig({
 
 
 
-## Access to Drizzle
+### Access to Drizzle
 
 After Payload is initialized, this adapter will expose the full power of Drizzle to you for use if you need it.
 
@@ -61,7 +60,7 @@ You can access Drizzle as follows:
 payload.db.drizzle
 ```
 
-## Tables, relations, and enums
+### Tables, relations, and enums
 
 In addition to exposing Drizzle directly, all of the tables, Drizzle relations, and enum configs are exposed for you via the `payload.db` property as well.
 
@@ -69,7 +68,7 @@ In addition to exposing Drizzle directly, all of the tables, Drizzle relations,
 - Enums - `payload.db.enums`
 - Relations - `payload.db.relations`
 
-## Prototyping in development mode
+### Prototyping in development mode
 
 Drizzle exposes two ways to work locally in development mode.
 
@@ -79,7 +78,7 @@ You will be warned if any changes that you make will entail data loss while in d
 
 Alternatively, you can disable `push` and rely solely on migrations to keep your local database in sync with your Payload config.
 
-## Migration workflows
+### Migration workflows
 
 Migrations are extremely powerful thanks to the seamless way that Payload and Drizzle work together. Let's take the following scenario:
 
@@ -91,7 +90,5 @@ Migrations are extremely powerful thanks to the seamless way that Payload and Dr
 1. Now your production database is in sync with your Payload config!
 
 <Banner type="warning">
-  Warning: do not mix "push" and migrations with your local development database. If you use "push"
-  locally, and then try to migrate, Payload will throw a warning, telling you that these two methods
-  are not meant to be used interchangeably.
+  Warning: do not mix "push" and migrations with your local development database. If you use "push" locally, and then try to migrate, Payload will throw a warning, telling you that these two methods are not meant to be used interchangeably.
 </Banner>

docs/database/transactions.mdx

@@ -32,7 +32,7 @@ const afterChange: CollectionAfterChangeHook = async ({ req }) => {
 }
 ```
 
-## Async Hooks with Transactions
+### Async Hooks with Transactions
 
 Since Payload hooks can be async and be written to not await the result, it is possible to have an incorrect success response returned on a request that is rolled back. If you have a hook where you do not `await` the result, then you should **not** pass the `req.transactionID`.
 
@@ -59,12 +59,46 @@ const afterChange: CollectionAfterChangeHook = async ({ req }) => {
 }
 ```
 
-## Direct Transaction Access
+### Direct Transaction Access
 
-When writing your own scripts or custom endpoints, you may wish to have direct control over transactions. This is useful for interacting with your database outside of Payload's local API.
+When writing your own scripts or custom endpoints, you may wish to have direct control over transactions. This is useful for interacting with your database in something like a background job, outside the normal request-response flow.
 
 The following functions can be used for managing transactions:
 
-`payload.db.beginTransaction` - Starts a new session and returns a transaction ID for use in other Payload Local API calls.
-`payload.db.commitTransaction` - Takes the identifier for the transaction, finalizes any changes.
+`payload.db.beginTransaction` - Starts a new session and returns a transaction ID for use in other Payload Local API calls. Note that if your database does not support transactions, this will return `null`.\
+`payload.db.commitTransaction` - Takes the identifier for the transaction, finalizes any changes.\
 `payload.db.rollbackTransaction` - Takes the identifier for the transaction, discards any changes.
+
+You can then use the transaction ID with Payload's local API by passing it inside the `PayloadRequest` object.
+
+Here is an example for a "background job" function, which utilizes the direct transaction API to make sure it either succeeds completely or gets rolled back in case of an error.
+
+```ts
+async function allOrNothingJob() {
+    const req = {} as PayloadRequest;
+    req.transactionID = await payload.db.beginTransaction();
+    try {
+      await payload.create({
+        req, // use our manual transaction
+        collection: 'my-slug',
+        data: {
+          some: 'data'
+        }
+      });
+
+      await payload.create({
+        req, // use our manual transaction
+        collection: 'something-else',
+        data: {
+          some: 'data'
+        }
+      });
+      console.log('Everything done.');
+      if (req.transactionID) await payload.db.commitTransaction(req.transactionID);
+    } catch (e) {
+      console.error('Oh no, something went wrong!');
+      if (req.transactionID) await payload.db.rollbackTransaction(req.transactionID);
+    }
+
+}
+```

docs/email/overview.mdx

@@ -2,165 +2,166 @@
 title: Email Functionality
 label: Overview
 order: 10
-desc: Payload uses an adapter pattern to enable email functionality. Set up email functions such as password resets, order confirmations and more.
+desc: Payload uses NodeMailer to allow you to send emails smoothly from your app. Set up email functions such as password resets, order confirmations and more.
 keywords: email, overview, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-## Introduction
+### Introduction
 
-Payload has a few email adapters that can be imported to enable email functionality. The [@payloadcms/email-nodemailer](https://www.npmjs.com/package/@payloadcms/email-nodemailer) package will be the package most will want to install. This package provides an easy way to use [Nodemailer](https://nodemailer.com) for email and won't get in your way for those already familiar.
+Payload comes ready to send your application's email. Whether you simply need built-in password reset
+email to work or you want customers to get an order confirmation email, you're almost there. Payload makes use of
+[NodeMailer](https://nodemailer.com) for email and won't get in your way for those already familiar.
 
-The email adapter should be passed into the `email` property of the Payload config. This will allow Payload to send emails for things like password resets, new user verification, and any other email sending needs you may have.
+For email to send from your Payload server, some configuration is required. The settings you provide will be set
+in the `email` property object of your payload init call. Payload will make use of the transport that you have configured for it for things like reset password or verifying new user accounts and email send methods are available to you as well on your payload instance.
 
-## Configuration
+### Configuration
 
-### Default Configuration
+**Three ways to set it up**
 
-When email is not needed or desired, Payload will log a warning on startup notifying that email is not configured. A  warning message will also be logged on any attempt to send an email.
+1. **Default**: When email is not needed, a mock email handler will be created and used when nothing is provided. This is ideal for development environments and can be changed later when ready to [go to production](/docs/production/deployment).
+1. **Recommended**: Set the `transportOptions` and Payload will do the set up for you.
+1. **Advanced**: The `transport` object can be assigned a nodemailer transport object set up in your server scripts and given for Payload to use.
 
-### Email Adapter
+The following options are configurable in the `email` property object as part of the options object when calling payload.init().
 
-An email adapter will require at least the following fields:
+| Option                   | Description                                                                                                                                                                                  |
+| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`fromName`** \*        | The name part of the From field that will be seen on the delivered email                                                                                                                     |
+| **`fromAddress`** \*     | The email address part of the From field that will be used when delivering email                                                                                                             |
+| **`transport`**          | The NodeMailer transport object for when you want to do it yourself, not needed when transportOptions is set                                                                                 |
+| **`transportOptions`**   | An object that configures the transporter that Payload will create. For all the available options see the [NodeMailer documentation](https://nodemailer.com) or see the examples below |
+| **`logMockCredentials`** | If set to true and no transport/transportOptions, ethereal credentials will be logged to console on startup                                                                                  |
 
-| Option                      | Description                                                                      |
-| --------------------------- | -------------------------------------------------------------------------------- |
-| **`defaultFromName`** \*    | The name part of the From field that will be seen on the delivered email         |
-| **`defaultFromAddress`** \* | The email address part of the From field that will be used when delivering email |
+_\* An asterisk denotes that a property is required._
 
+### Use SMTP
 
-### Official Email Adapters
-
-| Name       | Package                                                                                    | Description                                                                                                                                                                                     |
-| ---------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Nodemailer | [@payloadcms/email-nodemailer](https://www.npmjs.com/package/@payloadcms/email-nodemailer) | Use any [Nodemailer transport](https://nodemailer.com/transports), including SMTP, Resend, SendGrid, and more. This was provided by default in Payload 2.x. This is the easiest migration path. |
-| Resend     | [@payloadcms/email-resend](https://www.npmjs.com/package/@payloadcms/email-resend)         | Resend email via their REST API. This is preferred for serverless platforms such as Vercel because it is much more lightweight than the nodemailer adapter.                                     |
-
-## Nodemailer Configuration
-
-| Option                 | Description                                                                                                                                                                            |
-| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`transport`**        | The Nodemailer transport object for when you want to do it yourself, not needed when transportOptions is set                                                                           |
-| **`transportOptions`** | An object that configures the transporter that Payload will create. For all the available options see the [Nodemailer documentation](https://nodemailer.com) or see the examples below |
-
-## Use SMTP
-
-Simple Mail Transfer Protocol (SMTP) options can be passed in using the `transportOptions` object on the `email` options. See the [Nodemailer SMTP documentation](https://nodemailer.com/smtp/) for more information, including details on when `secure` should and should not be set to `true`.
+Simple Mail Transfer Protocol (SMTP) options can be passed in using the `transportOptions` object on the `email` options. See the [NodeMailer SMTP documentation](https://nodemailer.com/smtp/) for more information, including details on when `secure` should and should not be set to `true`.
 
 **Example email options using SMTP:**
 
 ```ts
-import { buildConfig } from 'payload/config'
-import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
-
-export default buildConfig({
-  email: nodemailerAdapter({
-    defaultFromAddress: 'info@payloadcms.com',
-    defaultFromName: 'Payload',
-    // Nodemailer transportOptions
+payload.init({
+  email: {
     transportOptions: {
       host: process.env.SMTP_HOST,
-      port: 587,
       auth: {
         user: process.env.SMTP_USER,
         pass: process.env.SMTP_PASS,
       },
+      port: Number(process.env.SMTP_HOST),
+      secure: Number(process.env.SMTP_PORT) === 465, // true for port 465, false (the default) for 587 and others
+      requireTLS: true,
     },
-  }),
+    fromName: 'hello',
+    fromAddress: 'hello@example.com',
+  },
+  // ...
 })
 ```
 
-**Example email options using nodemailer.createTransport:**
+<Banner type="warning">
+  It is best practice to avoid saving credentials or API keys directly in your code, use
+  [environment variables](/docs/configuration/overview#using-environment-variables-in-your-config).
+</Banner>
+
+### Use an email service
+
+Many third party mail providers are available and offer benefits beyond basic SMTP. As an example, your payload init could look like this if you wanted to use SendGrid.com, though the same approach would work for any other [NodeMailer transports](https://nodemailer.com/transports/) shown here or provided by another third party.
 
 ```ts
-import { buildConfig } from 'payload/config'
-import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
-import nodemailer from 'nodemailer'
-
-export default buildConfig({
-  email: nodemailerAdapter({
-    defaultFromAddress: 'info@payloadcms.com',
-    defaultFromName: 'Payload',
-    // Any Nodemailer transport can be used
-    transport: nodemailer.createTransport({
-      host: process.env.SMTP_HOST,
-      port: 587,
-      auth: {
-        user: process.env.SMTP_USER,
-        pass: process.env.SMTP_PASS,
-      },
-    }),
-  }),
-})
-```
-
-**Custom Transport:**
-
-You also have the ability to bring your own nodemailer transport. This is an example of using the SendGrid nodemailer transport.
-
-
-```ts
-import { buildConfig } from 'payload/config'
-import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
+import payload from 'payload'
 import nodemailerSendgrid from 'nodemailer-sendgrid'
 
+const sendGridAPIKey = process.env.SENDGRID_API_KEY
 
-export default buildConfig({
-  email: nodemailerAdapter({
-    defaultFromAddress: 'info@payloadcms.com',
-    defaultFromName: 'Payload',
-    transportOptions: nodemailerSendgrid({
-      apiKey: process.env.SENDGRID_API_KEY,
-    }),
-  }),
+payload.init({
+  ...(sendGridAPIKey
+    ? {
+        email: {
+          transportOptions: nodemailerSendgrid({
+            apiKey: sendGridAPIKey,
+          }),
+          fromName: 'Admin',
+          fromAddress: 'admin@example.com',
+        },
+      }
+    : {}),
 })
 ```
 
-During development, if you pass nothing to `nodemailerAdapter`, it will use the [ethereal.email](https://ethereal.email) service.
+### Use a custom NodeMailer transport
 
-This will log the ethereal.email details to console on startup.
+To take full control of the mail transport you may wish to use `nodemailer.createTransport()` on your server and provide it to Payload init.
 
 ```ts
-import { nodemailerAdapter } from '@payloadcms/email-nodemailer'
+import payload from 'payload'
+import nodemailer from 'nodemailer'
 
-export default buildConfig({
-  email: nodemailerAdapter(),
+const payload = require('payload')
+const nodemailer = require('nodemailer')
+
+const transport = await nodemailer.createTransport({
+  host: process.env.SMTP_HOST,
+  port: 587,
+  auth: {
+    user: process.env.SMTP_USER,
+    pass: process.env.SMTP_PASS,
+  },
+})
+
+payload.init({
+  email: {
+    fromName: 'Admin',
+    fromAddress: 'admin@example.com',
+    transport,
+  },
+  // ...
 })
 ```
 
-## Resend Configuration
+### Sending Mail
 
-The Resend adapter requires an API key to be passed in the options. This can be found in the Resend dashboard. This is the preferred package if you are deploying on Vercel because this is much more lightweight than the Nodemailer adapter.
+With a working transport you can call it anywhere you have access to payload by calling `payload.sendEmail(message)`. The `message` will contain the `to`, `subject` and `email` or `text` for the email being sent. To see all available message configuration options see [NodeMailer](https://nodemailer.com/message).
 
-| Option | Description                         |
-| ------ | ----------------------------------- |
-| apiKey | The API key for the Resend service. |
+### Mock transport
+
+By default, Payload uses a mock implementation that only sends mail to the [ethereal](https://ethereal.email) capture service that will never reach a user's inbox. While in development you may wish to make use of the captured messages which is why the payload output during server output helpfully logs this out on the server console.
+
+To see ethereal credentials, add `logMockCredentials: true` to the email options. This will cause them to be logged to console on startup.
 
 ```ts
-import { buildConfig } from 'payload/config'
-import { resendAdapter } from '@payloadcms/email-resend'
-
-export default buildConfig({
-  email: resendAdapter({
-    defaultFromAddress: 'dev@payloadcms.com',
-    defaultFromName: 'Payload CMS',
-    apiKey: process.env.RESEND_API_KEY || '',
-  }),
+payload.init({
+  email: {
+    fromName: 'Admin',
+    fromAddress: 'admin@example.com',
+    logMockCredentials: true, // Optional
+  },
+  // ...
 })
 ```
 
-## Sending Mail
+**Console output when starting payload with a mock email instance and logMockCredentials: true**
 
-With a working transport you can call it anywhere you have access to payload by calling `payload.sendEmail(message)`. The `message` will contain the `to`, `subject` and `html` or `text` for the email being sent. Other options are also available and can be seen in the sendEmail args. Support for these will depend on the adapter being used.
-
-```ts
-// Example of sending an email
-const email = await payload.sendEmail({
-  to: 'test@example.com',
-  subject: 'This is a test email',
-  text: 'This is my message body',
-})
+```
+[06:37:21] INFO  (payload): Starting Payload...
+[06:37:22] INFO  (payload): Payload Demo Initialized
+[06:37:22] INFO  (payload): listening on 3000...
+[06:37:22] INFO  (payload): Connected to MongoDB server successfully!
+[06:37:23] INFO  (payload): E-mail configured with mock configuration
+[06:37:23] INFO  (payload): Log into mock email provider at https://ethereal.email
+[06:37:23] INFO  (payload): Mock email account username: hhav5jw7doo4euev@ethereal.email
+[06:37:23] INFO  (payload): Mock email account password: VNdGcvDZeyEhtuPBqf
 ```
 
-## Using multiple mail providers
+The mock email handler is used when payload is started with neither `transport` or `transportOptions` to know how to deliver email.
+
+<Banner type="warning">
+  The randomly generated email account username and password will be different each time the Payload
+  server starts.
+</Banner>
+
+### Using multiple mail providers
 
 Payload supports the use of a single transporter of email, but there is nothing stopping you from having more. Consider a use case where sending bulk email is handled differently than transactional email and could be done using a [hook](/docs/hooks/overview).

docs/examples/overview.mdx

@@ -0,0 +1,39 @@
+---
+title: Examples
+label: Overview
+order: 10
+desc:
+keywords: example, examples, starter, boilerplate, template, templates
+---
+
+Payload provides a vast array of examples to help you get started with your project no matter what you are working on. These examples are designed to be easy to get up and running, and to be easy to understand. They showcase nothing more than the specific features being demonstrated, so you can easily decipher what is going on.
+
+Examples are changing every day, so be sure to check back often to see what new examples have been added. If you have a specific example you would like to see, please feel free to start a new [Discussion](https://github.com/payloadcms/payload/discussions) or open a new [PR](https://github.com/payloadcms/payload/pulls) to add it yourself.
+
+- [Auth](https://github.com/payloadcms/payload/tree/main/examples/auth)
+- [Custom Server](https://github.com/payloadcms/payload/tree/main/examples/custom-server)
+- [Draft Preview](https://github.com/payloadcms/payload/tree/main/examples/draft-preview)
+- [Email](https://github.com/payloadcms/payload/tree/main/examples/email)
+- [Form Builder](https://github.com/payloadcms/payload/tree/main/examples/form-builder)
+- [Hierarchy](https://github.com/payloadcms/payload/tree/main/examples/hierarchy)
+- [Live Preview](https://github.com/payloadcms/payload/tree/main/examples/live-preview)
+- [Multi-tenant](https://github.com/payloadcms/payload/tree/main/examples/multi-tenant)
+- [Nested Docs](https://github.com/payloadcms/payload/tree/main/examples/nested-docs)
+- [Redirects](https://github.com/payloadcms/payload/tree/main/examples/redirects)
+- [Tests](https://github.com/payloadcms/payload/tree/main/examples/testing)
+- [Virtual Fields](https://github.com/payloadcms/payload/tree/main/examples/virtual-fields)
+- [White-label Admin UI](https://github.com/payloadcms/payload/tree/main/examples/whitelabel)
+
+Where necessary, some examples include a front-end. Examples that require a front-end share this folder structure:
+
+```plaintext
+example/
+├── payload/
+├── next-app/
+├── next-pages/
+├── react-router/
+├── vue/
+├── svelte/
+```
+
+Where `payload` is your Payload project, and the other directories are dedicated to their respective front-end framework. We are adding new examples every day, so if your framework of choice is not yet supported in any particular example, please feel free to start a new [Discussion](https://github.com/payloadcms/payload/discussions) or open a new [PR](https://github.com/payloadcms/payload/pulls) to add it yourself.

docs/fields/array.mdx

@@ -12,22 +12,24 @@ keywords: array, fields, config, configuration, documentation, Content Managemen
 </Banner>
 
 <LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/array.png"
-  srcDark="https://payloadcms.com/images/docs/fields/array-dark.png"
-  alt="Array field with two Rows in Payload admin panel"
-  caption="Admin panel screenshot of an Array field with two Rows"
+srcLight="https://payloadcms.com/images/docs/fields/array.png"
+srcDark="https://payloadcms.com/images/docs/fields/array-dark.png"
+alt="Array field with two Rows in Payload admin panel"
+caption="Admin panel screenshot of an Array field with two Rows"
 />
 
 **Example uses:**
 
 - A "slider" with an image ([upload field](/docs/fields/upload)) and a caption ([text field](/docs/fields/text))
-- Navigational structures where editors can specify nav items containing pages ([relationship field](/docs/fields/relationship)), an "open in new tab" [checkbox field](/docs/fields/checkbox)
-- Event agenda "timeslots" where you need to specify start & end time ([date field](/docs/fields/date)), label ([text field](/docs/fields/text)), and Learn More page [relationship](/docs/fields/relationship)
+- Navigational structures where editors can specify nav items containing
+  pages ([relationship field](/docs/fields/relationship)), an "open in new tab" [checkbox field](/docs/fields/checkbox)
+- Event agenda "timeslots" where you need to specify start & end time ([date field](/docs/fields/date)),
+  label ([text field](/docs/fields/text)), and Learn More page [relationship](/docs/fields/relationship)
 
-## Config
+### Config
 
 | Option              | Description                                                                                                                                                                                                                                                                        |
-| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **`name`** \*       | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
 | **`label`**         | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                     |
 | **`fields`** \*     | Array of field types to correspond to each row of the Array.                                                                                                                                                                                                                       |
@@ -49,22 +51,24 @@ keywords: array, fields, config, configuration, documentation, Content Managemen
 
 _\* An asterisk denotes that a property is required._
 
-## Admin Config
+### Admin Config
 
-In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
+In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following
+properties:
 
 | Option                    | Description                                                                                                          |
-| ------------------------- | -------------------------------------------------------------------------------------------------------------------- |
+|---------------------------|----------------------------------------------------------------------------------------------------------------------|
 | **`initCollapsed`**       | Set the initial collapsed state                                                                                      |
+| **`isSortable`**          | Disable array order sorting by setting this value to `false`                                                               |
 | **`components.RowLabel`** | Function or React component to be rendered as the label on the array row. Receives `({ data, index, path })` as args |
-| **`isSortable`**          | Disable order sorting by setting this value to `false`                                                               |
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 
 ```ts
 import { CollectionConfig } from 'payload/types'
+import { RowLabelArgs } from 'payload/dist/admin/components/forms/RowLabel/types'
 
 export const ExampleCollection: CollectionConfig = {
   slug: 'example-collection',
@@ -99,7 +103,7 @@ export const ExampleCollection: CollectionConfig = {
       ],
       admin: {
         components: {
-          RowLabel: ({ data, index }) => {
+          RowLabel: ({ data, index }: RowLabelArgs) => {
             return data?.title || `Slide ${String(index).padStart(2, '0')}`
           },
         },

docs/fields/blocks.mdx

@@ -14,22 +14,23 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme
 </Banner>
 
 <LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/blocks.png"
-  srcDark="https://payloadcms.com/images/docs/fields/blocks-dark.png"
-  alt="Admin panel screenshot of add Blocks drawer view"
-  caption="Admin panel screenshot of add Blocks drawer view"
+srcLight="https://payloadcms.com/images/docs/fields/blocks.png"
+srcDark="https://payloadcms.com/images/docs/fields/blocks-dark.png"
+alt="Admin panel screenshot of add Blocks drawer view"
+caption="Admin panel screenshot of add Blocks drawer view"
 />
 
 **Example uses:**
 
-- A layout builder tool that grants editors to design highly customizable page or post layouts. Blocks could include configs such as `Quote`, `CallToAction`, `Slider`, `Content`, `Gallery`, or others.
+- A layout builder tool that grants editors to design highly customizable page or post layouts. Blocks could include
+  configs such as `Quote`, `CallToAction`, `Slider`, `Content`, `Gallery`, or others.
 - A form builder tool where available block configs might be `Text`, `Select`, or `Checkbox`.
 - Virtual event agenda "timeslots" where a timeslot could either be a `Break`, a `Presentation`, or a `BreakoutSession`.
 
-## Field config
+### Field config
 
 | Option             | Description                                                                                                                                                                                                                                                                        |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|--------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                                                                                             |
 | **`label`**        | Text used as the heading in the Admin panel or an object with keys for each language. Auto-generated from name if not defined.                                                                                                                                                     |
 | **`blocks`** \*    | Array of [block configs](/docs/fields/blocks#block-configs) to be made available to this field.                                                                                                                                                                                    |
@@ -49,16 +50,17 @@ keywords: blocks, fields, config, configuration, documentation, Content Manageme
 
 _\* An asterisk denotes that a property is required._
 
-## Admin Config
+### Admin Config
 
-In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
+In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following
+properties:
 
-| Option              | Description                        |
-| ------------------- | ---------------------------------- |
-| **`initCollapsed`**    | Set the initial collapsed state |
-| **`isSortable`**       | Disable order sorting by setting this value to `false` |
+| Option              | Description                     |
+|---------------------|---------------------------------|
+| **`initCollapsed`** | Set the initial collapsed state |
+| **`isSortable`** | Disable block order sorting by setting this value to `false` |
 
-## Block configs
+### Block configs
 
 Blocks are defined as separate configs of their own.
 
@@ -73,7 +75,7 @@ Blocks are defined as separate configs of their own.
 </Banner>
 
 | Option                     | Description                                                                                                                                                                         |
-| -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **`slug`** \*              | Identifier for this block type. Will be saved on each block as the `blockType` property.                                                                                            |
 | **`fields`** \*            | Array of fields to be stored in this block.                                                                                                                                         |
 | **`labels`**               | Customize the block labels that appear in the Admin dashboard. Auto-generated from slug if not defined.                                                                             |
@@ -84,7 +86,7 @@ Blocks are defined as separate configs of their own.
 | **`dbName`**               | Custom table name for this block type when using SQL database adapter ([Postgres](/docs/database/postgres)). Auto-generated from slug if not defined.
 | **`custom`**               | Extension point for adding custom data (e.g. for plugins)                                                                                                                           |
 
-### Auto-generated data per block
+#### Auto-generated data per block
 
 In addition to the field data that you define on each block, Payload will store two additional properties on each block:
 
@@ -94,9 +96,10 @@ The `blockType` is saved as the slug of the block that has been selected.
 
 **`blockName`**
 
-The Admin panel provides each block with a `blockName` field which optionally allows editors to label their blocks for better editability and readability.
+The Admin panel provides each block with a `blockName` field which optionally allows editors to label their blocks for
+better editability and readability.
 
-## Example
+### Example
 
 `collections/ExampleCollection.js`
 
@@ -139,9 +142,10 @@ export const ExampleCollection: CollectionConfig = {
 }
 ```
 
-## TypeScript
+### TypeScript
 
-As you build your own Block configs, you might want to store them in separate files but retain typing accordingly. To do so, you can import and use Payload's `Block` type:
+As you build your own Block configs, you might want to store them in separate files but retain typing accordingly. To do
+so, you can import and use Payload's `Block` type:
 
 ```ts
 import type { Block } from 'payload/types'

docs/fields/checkbox.mdx

@@ -15,27 +15,27 @@ keywords: checkbox, fields, config, configuration, documentation, Content Manage
   caption="Admin panel screenshot of Checkbox field with Text field below"
 />
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                 |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
+| Option             | Description                                                                                                                                                                                         |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
 | **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`** | Provide data to be used for this field's default value, will default to false if field is also `required`. [More](/docs/fields/overview#default-values)                     |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**     | Require this field to have a value.                                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                    |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`** | Provide data to be used for this field's default value, will default to false if field is also `required`. [More](/docs/fields/overview#default-values)                                             |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**        | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                                            |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
 _\* An asterisk denotes that a property is required._
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/code.mdx

@@ -21,30 +21,30 @@ keywords: code, fields, config, configuration, documentation, Content Management
 
 This field uses the `monaco-react` editor syntax highlighting.
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                 |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
+| Option             | Description                                                                                                                                                                                         |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
+| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                        |
 | **`index`**        | Build an [index](/docs/database#overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`minLength`**    | Used by the default validation function to ensure values are of a minimum character length.                                                                                 |
-| **`maxLength`**    | Used by the default validation function to ensure values are of a maximum character length.                                                                                 |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**     | Require this field to have a value.                                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                   |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`minLength`**    | Used by the default validation function to ensure values are of a minimum character length.                                                                                                         |
+| **`maxLength`**    | Used by the default validation function to ensure values are of a maximum character length.                                                                                                         |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
 _\* An asterisk denotes that a property is required._
 
-## Admin Config
+### Admin Config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
 
@@ -53,7 +53,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 | **`language`**      | This property can be set to any language listed [here](https://github.com/microsoft/monaco-editor/tree/main/src/basic-languages).                                               |
 | **`editorOptions`** | Options that can be passed to the monaco editor, [view the full list](https://microsoft.github.io/monaco-editor/typedoc/interfaces/editor.IDiffEditorConstructionOptions.html). |
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts
 

docs/fields/collapsible.mdx

@@ -18,7 +18,7 @@ keywords: row, fields, config, configuration, documentation, Content Management
   caption="Admin panel screenshot of a Collapsible field"
 />
 
-## Config
+### Config
 
 | Option          | Description                                                                                                                                                                  |
 | --------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -29,7 +29,7 @@ keywords: row, fields, config, configuration, documentation, Content Management
 
 _\* An asterisk denotes that a property is required._
 
-## Admin Config
+### Admin Config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
 
@@ -37,7 +37,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 | ------------------- | ------------------------------- |
 | **`initCollapsed`** | Set the initial collapsed state |
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/date.mdx

@@ -20,48 +20,48 @@ keywords: date, fields, config, configuration, documentation, Content Management
 
 This field uses [`react-datepicker`](https://www.npmjs.com/package/react-datepicker) for the Admin panel component.
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                 |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
+| Option             | Description                                                                                                                                                                                         |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
 | **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**     | Require this field to have a value.                                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                   |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
 _\* An asterisk denotes that a property is required._
 
-## Admin Config
+### Admin Config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), you can customize the following fields that will adjust how the component displays in the admin panel via the `date` property.
 
-| Property                       | Description                                                                                                                            |
-| ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------- |
-| **`placeholder`**              | Placeholder text for the field.                                                                                                        |
-| **`date`**                     | Pass options to customize date field appearance.                                                                                       |
-| **`date.displayFormat`**       | Format date to be shown in field **cell**.                                                                                             |
-| **`date.pickerAppearance`** \* | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`.                                            |
-| **`date.monthsToShow`** \*     | Number of months to display max is 2. Defaults to 1.                                                                                   |
-| **`date.minDate`** \*          | Min date value to allow.                                                                                                               |
-| **`date.maxDate`** \*          | Max date value to allow.                                                                                                               |
-| **`date.minTime`** \*          | Min time value to allow.                                                                                                               |
-| **`date.maxTime`** \*          | Max date value to allow.                                                                                                               |
-| **`date.overrides`** \*        | Pass any valid props directly to the [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md) |
-| **`date.timeIntervals`** \*    | Time intervals to display. Defaults to 30 minutes.                                                                                     |
-| **`date.timeFormat`** \*       | Determines time format. Defaults to `'h:mm aa'`.                                                                                       |
+| Property                       | Description                                                                                 |
+| ------------------------------ | ------------------------------------------------------------------------------------------- |
+| **`placeholder`**              | Placeholder text for the field.                                                             |
+| **`date`**                     | Pass options to customize date field appearance.                                            |
+| **`date.displayFormat`**       | Format date to be shown in field **cell**.                                                  |
+| **`date.pickerAppearance`** \* | Determines the appearance of the datepicker: `dayAndTime` `timeOnly` `dayOnly` `monthOnly`. |
+| **`date.monthsToShow`** \*     | Number of months to display max is 2. Defaults to 1.                                        |
+| **`date.minDate`** \*          | Min date value to allow.                                                                    |
+| **`date.maxDate`** \*          | Max date value to allow.                                                                    |
+| **`date.minTime`** \*          | Min time value to allow.                                                                    |
+| **`date.maxTime`** \*          | Max date value to allow.                                                                    |
+| **`date.overrides`** \*        | Pass any valid props directly to the [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md)     |
+| **`date.timeIntervals`** \*    | Time intervals to display. Defaults to 30 minutes.                                          |
+| **`date.timeFormat`** \*       | Determines time format. Defaults to `'h:mm aa'`.                                            |
 
 _\* This property is passed directly to [react-datepicker](https://github.com/Hacker0x01/react-datepicker/blob/master/docs/datepicker.md). ._
 
-### Display Format and Picker Appearance
+#### Display Format and Picker Appearance
 
 These properties only affect how the date is displayed in the UI. The full date is always stored in the format `YYYY-MM-DDTHH:mm:ss.SSSZ` (e.g. `1999-01-01T8:00:00.000+05:00`).
 
@@ -71,7 +71,7 @@ These properties only affect how the date is displayed in the UI. The full date
 
 When only `pickerAppearance` is set, an equivalent format will be rendered in the date field cell. To overwrite this format, set `displayFormat`.
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/email.mdx

@@ -15,28 +15,28 @@ keywords: email, fields, config, configuration, documentation, Content Managemen
   caption="Admin panel screenshot of an Email field"
 />
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                 |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
+| Option             | Description                                                                                                                                                                                         |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
+| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                        |
 | **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**     | Require this field to have a value.                                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                   |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
 _\* An asterisk denotes that a property is required._
 
-## Admin config
+### Admin config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), this field type allows for the following `admin` properties:
 
@@ -48,7 +48,7 @@ Set this property to define a placeholder string for the field.
 
 Set this property to a string that will be used for browser autocomplete.
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/group.mdx

@@ -18,7 +18,7 @@ keywords: group, fields, config, configuration, documentation, Content Managemen
   caption="Admin panel screenshot of a Group field"
 />
 
-## Config
+### Config
 
 | Option              | Description                                                                                                                                                                                                                                                                        |
 | ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -38,7 +38,7 @@ keywords: group, fields, config, configuration, documentation, Content Managemen
 
 _\* An asterisk denotes that a property is required._
 
-## Admin config
+### Admin config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), the Group allows for the following admin property:
 
@@ -46,7 +46,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 
 Set this property to `true` to hide this field's gutter within the admin panel. The field gutter is rendered as a vertical line and padding, but often if this field is nested within a Group, Block, or Array, you may want to hide the gutter.
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/json.mdx

@@ -21,37 +21,37 @@ keywords: json, jsonSchema, schema, validation, fields, config, configuration, d
 
 This field uses the `monaco-react` editor syntax highlighting.
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                 |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
+| Option             | Description                                                                                                                                                                                         |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
+| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                        |
 | **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
-| **`jsonSchema`**   | Provide a JSON schema that will be used for validation. [JSON schemas](https://json-schema.org/learn/getting-started-step-by-step)
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**     | Require this field to have a value.                                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                   |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
+| **`jsonSchema`**   | Provide a JSON schema that will be used for validation. [JSON schemas](https://json-schema.org/learn/getting-started-step-by-step)                                                                  |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
 _\* An asterisk denotes that a property is required._
 
-## Admin Config
+### Admin Config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), you can adjust the following properties:
 
-| Option              | Description                                                                                                                                                   |
-| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Option              | Description                                                                                                                                                                        |
+| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | **`editorOptions`** | Options that can be passed to the monaco editor, [view the full list](https://microsoft.github.io/monaco-editor/typedoc/variables/editor.EditorOptions.html). |
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 
@@ -69,14 +69,15 @@ export const ExampleCollection: CollectionConfig = {
   ],
 }
 ```
-## JSON Schema Validation
+
+### JSON Schema Validation
 
 Payload JSON fields fully support the [JSON schema](https://json-schema.org/) standard. By providing a schema in your field config, the editor will be guided in the admin UI, getting typeahead for properties and their formats automatically. When the document is saved, the default validation will prevent saving any invalid data in the field according to the schema in your config.
 
 If you only provide a URL to a schema, Payload will fetch the desired schema if it is publicly available. If not, it is recommended to add the schema directly to your config or import it from another file so that it can be implemented consistently in your project.
 
 
-### Local JSON Schema
+#### Local JSON Schema
 
 `collections/ExampleCollection.ts`
 
@@ -109,7 +110,7 @@ export const ExampleCollection: CollectionConfig = {
 // Attempting to create {"foo": "not-bar"} will throw an error
 ```
 
-### Remote JSON Schema
+#### Remote JSON Schema
 
 `collections/ExampleCollection.ts`
 

docs/fields/number.mdx

@@ -18,33 +18,33 @@ keywords: number, fields, config, configuration, documentation, Content Manageme
   caption="Admin panel screenshot of a Number field"
 />
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                          |
-|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                               |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                              |
-| **`min`**          | Minimum value accepted. Used in the default `validation` function.                                                                                                                   |
-| **`max`**          | Maximum value accepted. Used in the default `validation` function.                                                                                                                   |
-| **`hasMany`**      | Makes this field an ordered array of numbers instead of just a single number.                                                                                                        |
-| **`minRows`**      | Minimum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                         |
-| **`maxRows`**      | Maximum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                         |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                         |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often.          |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                         |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                        |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                           |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                              |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                     |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                 |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                      |
-| **`required`**     | Require this field to have a value.                                                                                                                                                  |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                            |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                            |
+| Option             | Description                                                                                                                                                                                         |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
+| **`min`**          | Minimum value accepted. Used in the default `validation` function.                                                                                                                                  |
+| **`max`**          | Maximum value accepted. Used in the default `validation` function.                                                                                                                                  |
+| **`hasMany`**      | Makes this field an ordered array of numbers instead of just a single number.                                                                                                                       |
+| **`minRows`**      | Minimum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                                        |
+| **`maxRows`**      | Maximum number of numbers in the numbers array, if `hasMany` is set to true.                                                                                                                        |
+| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                        |
+| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
 _\* An asterisk denotes that a property is required._
 
-## Admin config
+### Admin config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), this field type allows for the following `admin` properties:
 
@@ -60,7 +60,7 @@ Set this property to define a placeholder string for the field.
 
 Set this property to a string that will be used for browser autocomplete.
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/overview.mdx

@@ -36,7 +36,7 @@ export const Page: CollectionConfig = {
 }
 ```
 
-## Field types
+### Field types
 
 - [Array](/docs/fields/array) - for repeating content, supports nested fields
 - [Blocks](/docs/fields/blocks) - block-based fields, allowing powerful layout creation
@@ -60,19 +60,19 @@ export const Page: CollectionConfig = {
 - [Upload](/docs/fields/upload) - allows local file and image upload
 - [UI](/docs/fields/ui) - inject your own custom components and do whatever you need
 
-## Field-level hooks
+### Field-level hooks
 
 One of the most powerful parts about Payload is its ability for you to define field-level hooks that can control the logic of your fields to a fine-grained level. for more information about how to define field hooks, [click here](/docs/hooks/overview#field-hooks).
 
-## Field-level access control
+### Field-level access control
 
 In addition to being able to define access control on a document-level, you can define extremely granular permissions on a field by field level. For more information about field-level access control, [click here](/docs/access-control/overview#fields).
 
-## Field names
+### Field names
 
 Some fields use their `name` property as a unique identifier to store and retrieve from the database. `__v`, `salt`, and `hash` are all reserved field names which are sanitized from Payload's config and cannot be used.
 
-## Validation
+### Validation
 
 Field validation is enforced automatically based on the field type and other properties such as `required` or `min` and `max` value constraints on certain field types. This default behavior can be replaced by providing your own validate function for any field. It will be used on both the frontend and the backend, so it should not rely on any Node-specific packages. The validation function can be either synchronous or asynchronous and expects to return either `true` or a string error message to display in both API responses and within the Admin panel.
 
@@ -83,15 +83,15 @@ There are two arguments available to custom validation functions.
 
 | Property      | Description                                                                                                              |
 | ------------- | ------------------------------------------------------------------------------------------------------------------------ |
-| `data`        | An object containing the full collection or global document currently being edited                                       |
-| `siblingData` | An object containing document data that is scoped to only fields within the same parent of this field                    |
-| `operation`   | Will be `create` or `update` depending on the UI action or API call                                                      |
-| `id`          | The `id` of the current document being edited. `id` is `undefined` during the `create` operation                         |
-| `t`           | The function for translating text, [more](/docs/configuration/i18n)                                                      |
-| `user`        | An object containing the currently authenticated user                                                                    |
+| `data`        | An object of the full collection or global document.                                                                     |
+| `siblingData` | An object of the document data limited to fields within the same parent to the field.                                    |
+| `operation`   | Will be "create" or "update" depending on the UI action or API call.                                                     |
+| `id`          | The value of the collection `id`, will be `undefined` on create request.                                                 |
+| `t`           | The function for translating text, [more](/docs/configuration/i18n).                                                     |
+| `user`        | The currently authenticated user object.                                                                                 |
 | `payload`     | If the `validate` function is being executed on the server, Payload will be exposed for easily running local operations. |
 
-## Example
+Example:
 
 ```ts
 import { CollectionConfig } from 'payload/types'
@@ -140,7 +140,7 @@ const field: Field = {
 }
 ```
 
-## Customizable ID
+### Customizable ID
 
 Collections ID fields are generated automatically by default. An explicit `id` field can be declared in the `fields` array to override this behavior.
 Users are then required to provide a custom ID value when creating a record through the Admin UI or API.
@@ -159,7 +159,7 @@ Example:
 }
 ```
 
-## Admin config
+### Admin config
 
 In addition to each field's base configuration, you can define specific traits and properties for fields that only have effect on how they are rendered in the Admin panel. The following properties are available for all fields within the `admin` property:
 
@@ -179,11 +179,11 @@ In addition to each field's base configuration, you can define specific traits a
 | `disableListFilter` | Set `disableListFilter` to `true` to prevent fields from appearing in the list view filter options.                                                                                                                              |
 | `hidden`            | Setting a field's `hidden` property on its `admin` config will transform it into a `hidden` input type. Its value will still submit with the Admin panel's requests, but the field itself will not be visible to editors.        |
 
-## Custom components
+### Custom components
 
 All Payload fields support the ability to swap in your own React components with ease. For more information, including examples, [click here](/docs/admin/components#fields).
 
-## Conditional logic
+### Conditional logic
 
 You can show and hide fields based on what other fields are doing by utilizing conditional logic on a field by field basis. The `condition` property on a field's admin config accepts a function which takes three arguments:
 
@@ -222,7 +222,7 @@ The `condition` function should return a boolean that will control if the field
 }
 ```
 
-## Default values
+### Default values
 
 Fields can be prefilled with starting values using the `defaultValue` property. This is used in the admin UI and also on the backend as API requests will be populated with missing or undefined field values. You can assign the defaultValue directly in the field configuration or supply a function for dynamic behavior. Values assigned during a create request on the server are added before validation occurs.
 
@@ -252,7 +252,7 @@ const field = {
   You can use async defaultValue functions to fill fields with data from API requests.
 </Banner>
 
-## Description
+### Description
 
 A description can be configured in three ways.
 
@@ -314,7 +314,7 @@ This example will display the number of characters allowed as the user types.
 
 This component will count the number of characters entered, as well as display the path of the field.
 
-## TypeScript
+### TypeScript
 
 You can import the internal Payload `Field` type as well as other common field types as follows:
 

docs/fields/point.mdx

@@ -25,24 +25,24 @@ keywords: point, geolocation, geospatial, geojson, 2dsphere, config, configurati
 
 The data structure in the database matches the GeoJSON structure to represent point. The Payload APIs simplifies the object data to only the [longitude, latitude] location.
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                               |
-| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                    |
-| **`label`**        | Used as a field label in the Admin panel and to name the generated GraphQL type.                                                                                                          |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                              |
+| Option             | Description                                                                                                                                                                                                       |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                                            |
+| **`label`**        | Used as a field label in the Admin panel and to name the generated GraphQL type.                                                                                                                                  |
+| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                                      |
 | **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. To support location queries, point index defaults to `2dsphere`, to disable the index set to `false`. |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                              |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                             |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                   |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                          |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                      |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                           |
-| **`required`**     | Require this field to have a value.                                                                                                                                                       |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                 |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                 |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                                      |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                                     |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                                        |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                                           |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                                  |
+| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                              |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                                   |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                               |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                                         |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                         |
 
 _\* An asterisk denotes that a property is required._
 
@@ -50,7 +50,7 @@ _\* An asterisk denotes that a property is required._
   <strong>Note:</strong> The Point field type is currently only supported in MongoDB.
 </Banner>
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 
@@ -69,6 +69,6 @@ export const ExampleCollection: CollectionConfig = {
 }
 ```
 
-## Querying
+### Querying
 
 In order to do query based on the distance to another point, you can use the `near` operator. When querying using the near operator, the returned documents will be sorted by nearest first.

docs/fields/radio.mdx

@@ -18,24 +18,24 @@ keywords: radio, fields, config, configuration, documentation, Content Managemen
   caption="Admin panel screenshot of a Radio field"
 />
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                 |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`options`** \*   | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing an `label` string and a `value` string.                  |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
+| Option             | Description                                                                                                                                                                                         |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`options`** \*   | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing an `label` string and a `value` string.                                          |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
 | **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`** | Provide data to be used for this field's default value. The default value must exist within provided values in `options`. [More](/docs/fields/overview#default-values)      |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**     | Require this field to have a value.                                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                   |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`** | Provide data to be used for this field's default value. The default value must exist within provided values in `options`. [More](/docs/fields/overview#default-values)                              |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 | **`enumName`**     | Custom enum name for this field when using SQL database adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined.
 
 _\* An asterisk denotes that a property is required._
@@ -49,7 +49,7 @@ _\* An asterisk denotes that a property is required._
   being used as a GraphQL enum.
 </Banner>
 
-## Admin config
+### Admin config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), the Radio Group field type allows for the specification of the following `admin` properties:
 
@@ -57,7 +57,7 @@ In addition to the default [field admin config](/docs/fields/overview#admin-conf
 
 The `layout` property allows for the radio group to be styled as a horizonally or vertically distributed list. The default value is `horizontal`.
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/relationship.mdx

@@ -12,10 +12,10 @@ keywords: relationship, fields, config, configuration, documentation, Content Ma
 </Banner>
 
 <LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/relationship.png"
-  srcDark="https://payloadcms.com/images/docs/fields/relationship-dark.png"
-  alt="Shows a relationship field in the Payload admin panel"
-  caption="Admin panel screenshot of a Relationship field"
+srcLight="https://payloadcms.com/images/docs/fields/relationship.png"
+srcDark="https://payloadcms.com/images/docs/fields/relationship-dark.png"
+alt="Shows a relationship field in the Payload admin panel"
+caption="Admin panel screenshot of a Relationship field"
 />
 
 **Example uses:**
@@ -24,30 +24,30 @@ keywords: relationship, fields, config, configuration, documentation, Content Ma
 - To allow for an `Order` to feature a `placedBy` relationship to either an `Organization` or `User` collection
 - To assign `Category` documents to `Post` documents
 
-## Config
+### Config
 
-| Option              | Description                                                                                                                                                                    |
-|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`name`** \*       | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                         |
-| **`relationTo`** \* | Provide one or many collection `slug`s to be able to assign relationships to.                                                                                                  |
-| **`filterOptions`** | A query to filter which options appear in the UI and validate against. [More](#filtering-relationship-options).                                                                |
-| **`hasMany`**       | Boolean when, if set to `true`, allows this field to have many relations instead of only one.                                                                                  |
-| **`minRows`**       | A number for the fewest allowed items during validation when a value is present. Used with `hasMany`.                                                                          |
-| **`maxRows`**       | A number for the most allowed items during validation when a value is present. Used with `hasMany`.                                                                            |
-| **`maxDepth`**      | Sets a maximum population depth for this field, regardless of the remaining depth when this field is reached. [Max Depth](/docs/getting-started/concepts#field-level-max-depth) |
-| **`label`**         | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                        |
-| **`unique`**        | Enforce that each entry in the Collection has a unique value for this field.                                                                                                   |
-| **`validate`**      | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                   |
-| **`index`**         | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often.    |
-| **`saveToJWT`**     | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                  |
-| **`hooks`**         | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                     |
-| **`access`**        | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                        |
-| **`hidden`**        | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                               |
-| **`defaultValue`**  | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                           |
-| **`localized`**     | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                |
-| **`required`**      | Require this field to have a value.                                                                                                                                            |
-| **`admin`**         | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                       |
-| **`custom`**        | Extension point for adding custom data (e.g. for plugins)                                                                                                                      |
+| Option              | Description                                                                                                                                                                   |
+|---------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`name`** \*       | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                        |
+| **`relationTo`** \* | Provide one or many collection `slug`s to be able to assign relationships to.                                                                                                 |
+| **`filterOptions`** | A query to filter which options appear in the UI and validate against. [More](#filtering-relationship-options).                                                               |
+| **`hasMany`**       | Boolean when, if set to `true`, allows this field to have many relations instead of only one.                                                                                 |
+| **`minRows`**       | A number for the fewest allowed items during validation when a value is present. Used with `hasMany`.                                                                         |
+| **`maxRows`**       | A number for the most allowed items during validation when a value is present. Used with `hasMany`.                                                                           |
+| **`maxDepth`**      | Sets a number limit on iterations of related documents to populate when queried. [Depth](/docs/getting-started/concepts#depth)                                                |
+| **`label`**         | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                       |
+| **`unique`**        | Enforce that each entry in the Collection has a unique value for this field.                                                                                                  |
+| **`validate`**      | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                  |
+| **`index`**         | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
+| **`saveToJWT`**     | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                 |
+| **`hooks`**         | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                    |
+| **`access`**        | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                       |
+| **`hidden`**        | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                              |
+| **`defaultValue`**  | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                          |
+| **`localized`**     | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                               |
+| **`required`**      | Require this field to have a value.                                                                                                                                           |
+| **`admin`**         | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                      |
+| **`custom`**        | Extension point for adding custom data (e.g. for plugins)                                                                                                                     |
 
 _\* An asterisk denotes that a property is required._
 
@@ -58,7 +58,7 @@ _\* An asterisk denotes that a property is required._
   related documents that are returned by the API.
 </Banner>
 
-## Admin config
+### Admin config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), the Relationship field type also
 allows for the following admin-specific properties:
@@ -122,7 +122,7 @@ In this configuration:
 
 Note: If `sortOptions` is not defined, the default sorting behavior of the Relationship field dropdown will be used.
 
-## Filtering relationship options
+### Filtering relationship options
 
 Options can be dynamically limited by supplying a [query constraint](/docs/queries/overview), which will be used both
 for validating input and filtering available relationships in the UI.
@@ -131,15 +131,15 @@ The `filterOptions` property can either be a `Where` query, or a function return
 prevent all, or a `Where` query. When using a function, it will be
 called with an argument object with the following properties:
 
-| Property      | Description                                                                                           |
-| ------------- | ----------------------------------------------------------------------------------------------------- |
-| `relationTo`  | The collection `slug` to filter against, limited to this field's `relationTo` property                |
-| `data`        | An object containing the full collection or global document currently being edited                    |
-| `siblingData` | An object containing document data that is scoped to only fields within the same parent of this field |
-| `id`          | The `id` of the current document being edited. `id` is `undefined` during the `create` operation      |
-| `user`        | An object containing the currently authenticated user                                                 |
+| Property      | Description                                                                          |
+|---------------|--------------------------------------------------------------------------------------|
+| `relationTo`  | The `relationTo` to filter against (as defined on the field)                         |
+| `data`        | An object of the full collection or global document currently being edited           |
+| `siblingData` | An object of the document data limited to fields within the same parent to the field |
+| `id`          | The value of the collection `id`, will be `undefined` on create request              |
+| `user`        | The currently authenticated user object                                              |
 
-## Example
+### Example
 
 ```ts
 import { CollectionConfig } from 'payload/types'
@@ -181,13 +181,13 @@ You can learn more about writing queries [here](/docs/queries/overview).
   <strong>payload/fields/validations</strong> in your validate function.
 </Banner>
 
-## How the data is saved
+### How the data is saved
 
 Given the variety of options possible within the `relationship` field type, the shape of the data needed for creating
 and updating these fields can vary. The following sections will describe the variety of data shapes that can arise from
 this field.
 
-### Has One
+#### Has One
 
 The most simple pattern of a relationship is to use `hasMany: false` with a `relationTo` that allows for only one type
 of collection.
@@ -221,7 +221,7 @@ When querying documents in this collection via REST API, you could query as foll
 
 `?where[owner][equals]=6031ac9e1289176380734024`.
 
-### Has One - Polymorphic
+#### Has One - Polymorphic
 
 Also known as **dynamic references**, in this configuration, the `relationTo` field is an array of Collection slugs that
 tells Payload which Collections are valid to reference.
@@ -263,7 +263,7 @@ You can also query for documents where a field has a relationship to a specific
 
 This query would return only documents that have an owner relationship to organizations.
 
-### Has Many
+#### Has Many
 
 The `hasMany` tells Payload that there may be more than one collection saved to the field.
 
@@ -287,7 +287,10 @@ To save the to `hasMany` relationship field we need to send an array of IDs:
 
 ```json
 {
-  "owners": ["6031ac9e1289176380734024", "602c3c327b811235943ee12b"]
+  "owners": [
+    "6031ac9e1289176380734024",
+    "602c3c327b811235943ee12b"
+  ]
 }
 ```
 
@@ -295,7 +298,7 @@ When querying documents, the format does not change for arrays:
 
 `?where[owners][equals]=6031ac9e1289176380734024`.
 
-### Has Many - Polymorphic
+#### Has Many - Polymorphic
 
 ```ts
 {
@@ -336,7 +339,7 @@ Querying is done in the same way as the earlier Polymorphic example:
 
 `?where[owners.value][equals]=6031ac9e1289176380734024`.
 
-### Querying and Filtering Polymorphic Relationships
+#### Querying and Filtering Polymorphic Relationships
 
 Polymorphic and non-polymorphic relationships must be queried differently because of how the related data is stored and
 may be inconsistent across different collections. Because of this, filtering polymorphic relationship fields from the
@@ -359,6 +362,5 @@ Since we are referencing multiple collections, the field you are querying on may
 <Banner type="warning">
   <strong>Note:</strong>
   <br />
-  You <strong>cannot</strong> query on a field within a polymorphic relationship as you would with a
-  non-polymorphic relationship.
+  You <strong>cannot</strong> query on a field within a polymorphic relationship as you would with a non-polymorphic relationship.
 </Banner>

docs/fields/rich-text.mdx

@@ -18,7 +18,7 @@ keywords: rich text, fields, config, configuration, documentation, Content Manag
   caption="Admin panel screenshot of a Rich Text field"
 />
 
-Payload's rich text field is built on an "adapter pattern" which lets you specify which rich text editor you'd like to use.
+Payload's rich text field is built on an "adapter pattern" which lets you specify which rich text editor you'd like to use. 
 
 Right now, Payload is officially supporting two rich text editors:
 
@@ -26,17 +26,10 @@ Right now, Payload is officially supporting two rich text editors:
 2. [Lexical](/docs/rich-text/lexical) - beta, where things will be moving
 
 <Banner type="success">
-  <strong>
-    Consistent with Payload's goal of making you learn as little of Payload as possible, customizing
-    and using the Rich Text Editor does not involve learning how to develop for a <em>Payload</em>{' '}
-    rich text editor.
-  </strong>
-
-  Instead, you can invest your time and effort into learning the underlying open-source tools that
-  will allow you to apply your learnings elsewhere as well.
+  <strong>Consistent with Payload's goal of making you learn as little of Payload as possible, customizing and using the Rich Text Editor does not involve learning how to develop for a <em>Payload</em> rich text editor.</strong> Instead, you can invest your time and effort into learning the underlying open-source tools that will allow you to apply your learnings elsewhere as well.
 </Banner>
 
-## Config
+### Config
 
 | Option             | Description                                                                                                                                             |
 | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -56,7 +49,7 @@ Right now, Payload is officially supporting two rich text editors:
 
 _\* An asterisk denotes that a property is required._
 
-## Admin config
+### Admin config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), the Rich Text editor allows for the following admin properties:
 
@@ -72,6 +65,6 @@ Set this property to `true` to hide this field's gutter within the admin panel.
 
 Override the default text direction of the Admin panel for this field. Set to `true` to force right-to-left text direction.
 
-## Editor-specific options
+### Editor-specific options
 
-For a ton more editor-specific options, including how to build custom rich text elements directly into your editor, take a look at either the [Slate docs](/docs/rich-text/slate) or the [Lexical docs](/docs/rich-text/lexical) depending on which editor you're using.
+For a ton more editor-specific options, including how to build custom rich text elements directly into your editor, take a look at either the [Slate docs](/docs/rich-text/slate) or the [Lexical docs](/docs/rich-text/lexical) depending on which editor you're using.

docs/fields/row.mdx

@@ -18,7 +18,7 @@ keywords: row, fields, config, configuration, documentation, Content Management
   caption="Admin panel screenshot of a Row field"
 />
 
-## Config
+### Config
 
 | Option          | Description                                                                                                                                                                |
 | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -28,7 +28,7 @@ keywords: row, fields, config, configuration, documentation, Content Management
 
 _\* An asterisk denotes that a property is required._
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/select.mdx

@@ -12,32 +12,32 @@ keywords: select, multi-select, fields, config, configuration, documentation, Co
 </Banner>
 
 <LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/select.png"
-  srcDark="https://payloadcms.com/images/docs/fields/select-dark.png"
-  alt="Shows a Select field in the Payload admin panel"
-  caption="Admin panel screenshot of a Select field"
+srcLight="https://payloadcms.com/images/docs/fields/select.png"
+srcDark="https://payloadcms.com/images/docs/fields/select-dark.png"
+alt="Shows a Select field in the Payload admin panel"
+caption="Admin panel screenshot of a Select field"
 />
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                 |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`options`** \*   | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing a `label` string and a `value` string.                   |
-| **`hasMany`**      | Boolean when, if set to `true`, allows this field to have many selections instead of only one.                                                                              |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
-| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**     | Require this field to have a value.                                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                    |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| Option             | Description                                                                                                                                                                   |
+|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                        |
+| **`options`** \*   | Array of options to allow the field to store. Can either be an array of strings, or an array of objects containing a `label` string and a `value` string.                     |
+| **`hasMany`**      | Boolean when, if set to `true`, allows this field to have many selections instead of only one.                                                                                |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                       |
+| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                  |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                  |
+| **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often.   |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                 |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                    |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                       |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                              |
+| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                          |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                               |
+| **`required`**     | Require this field to have a value.                                                                                                                                           |
+| **`admin`**        | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details.                                                      |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                     |
 | **`enumName`**     | Custom enum name for this field when using SQL database adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined.                               |
 | **`dbName`**       | Custom table name (if `hasMany` set to `true`) for this field when using SQL database adapter ([Postgres](/docs/database/postgres)). Auto-generated from name if not defined. |
 
@@ -52,9 +52,10 @@ _\* An asterisk denotes that a property is required._
   being used as a GraphQL enum.
 </Banner>
 
-## Admin config
+### Admin config
 
-In addition to the default [field admin config](/docs/fields/overview#admin-config), the Select field type also allows for the following admin-specific properties:
+In addition to the default [field admin config](/docs/fields/overview#admin-config), the Select field type also allows
+for the following admin-specific properties:
 
 **`isClearable`**
 
@@ -62,9 +63,10 @@ Set to `true` if you'd like this field to be clearable within the Admin UI.
 
 **`isSortable`**
 
-Set to `true` if you'd like this field to be sortable within the Admin UI using drag and drop. (Only works when `hasMany` is set to `true`)
+Set to `true` if you'd like this field to be sortable within the Admin UI using drag and drop. (Only works
+when `hasMany` is set to `true`)
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 
@@ -101,9 +103,10 @@ export const ExampleCollection: CollectionConfig = {
 }
 ```
 
-## Customization
+### Customization
 
-The Select field UI component can be customized by providing a custom React component to the `components` object in the Base config.
+The Select field UI component can be customized by providing a custom React component to the `components` object in the
+Base config.
 
 ```ts
 export const CustomSelectField: Field = {
@@ -124,7 +127,7 @@ export const CustomSelectField: Field = {
         ],
       }),
     },
-  },
+  }
 }
 ```
 
@@ -158,27 +161,33 @@ export const CustomSelectComponent: React.FC<CustomSelectProps> = ({ path, optio
 
   return (
     <div>
-      <label className="field-label">
-        Custom Select
-      </label>
-      <SelectInput
-        path={path}
-        name={path}
-        options={adjustedOptions}
-        value={value}
-        onChange={(e) => setValue(e.value)}
-      />
-    </div>
-  )
+      <label className = "field-label" >
+      Custom
+  Select
+  < /label>
+  < SelectInput
+  path = { path }
+  name = { path }
+  options = { adjustedOptions }
+  value = { value }
+  onChange = {(e)
+=>
+  setValue(e.value)
+}
+  />
+  < /div>
+)
 }
 ```
 
-If you are looking to create a dynamic select field, the following tutorial will walk you through the process of creating a custom select field that fetches its options from an external API.
+If you are looking to create a dynamic select field, the following tutorial will walk you through the process of
+creating a custom select field that fetches its options from an external API.
 
 <VideoDrawer
-  id="Efn9OxSjA6Y"
-  label="How to Create a Custom Select Field"
-  drawerTitle="How to Create a Custom Select Field: A Step-by-Step Guide"
+id='Efn9OxSjA6Y'
+label='How to Create a Custom Select Field'
+drawerTitle='How to Create a Custom Select Field: A Step-by-Step Guide'
 />
 
-If you want to learn more about custom components check out the [Admin > Custom Component](/docs/admin/components#field-component) docs.
+If you want to learn more about custom components check out
+the [Admin > Custom Component](/docs/admin/components#field-component) docs.

docs/fields/tabs.mdx

@@ -19,7 +19,7 @@ keywords: tabs, fields, config, configuration, documentation, Content Management
   caption="Tabs field type used to separate Hero fields from Page Layout"
 />
 
-## Config
+### Config
 
 | Option        | Description                                                                                                              |
 | ------------- | ------------------------------------------------------------------------------------------------------------------------ |
@@ -27,7 +27,7 @@ keywords: tabs, fields, config, configuration, documentation, Content Management
 | **`admin`**   | Admin-specific configuration. See the [default field admin config](/docs/fields/overview#admin-config) for more details. |
 | **`custom`**  | Extension point for adding custom data (e.g. for plugins)                                                                |
 
-### Tab-specific Config
+#### Tab-specific Config
 
 Each tab must have either a `name` or `label` and the required `fields` array. You can also optionally pass a `description` to render within each individual tab.
 
@@ -41,7 +41,7 @@ Each tab must have either a `name` or `label` and the required `fields` array. Y
 
 _\* An asterisk denotes that a property is required._
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/text.mdx

@@ -18,33 +18,32 @@ keywords: text, fields, config, configuration, documentation, Content Management
   caption="Admin panel screenshot of a Text field and read-only Text field"
 />
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                 |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
-| **`minLength`**    | Used by the default validation function to ensure values are of a minimum character length.                                                                                 |
-| **`maxLength`**    | Used by the default validation function to ensure values are of a maximum character length.                                                                                 |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
+| Option             | Description                                                                                                                                                                                         |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
+| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                        |
+| **`minLength`**    | Used by the default validation function to ensure values are of a minimum character length.                                                                                                         |
+| **`maxLength`**    | Used by the default validation function to ensure values are of a maximum character length.                                                                                                         |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
 | **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**     | Require this field to have a value.                                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                   |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
-| **`hasMany`**      | Makes this field an ordered array of text instead of just a single text.                                                                                                    |
-| **`minRows`**      | Minimum number of texts in the array, if `hasMany` is set to true.                                                                                                          |
-| **`maxRows`**      | Maximum number of texts in the array, if `hasMany` is set to true.                                                                                                          |
-
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
+| **`hasMany`**      | Makes this field an ordered array of text instead of just a single text.                                                                                                                       |
+| **`minRows`**      | Minimum number of texts in the array, if `hasMany` is set to true.                                                                                                                        |
+| **`maxRows`**      | Maximum number of texts in the array, if `hasMany` is set to true.                                                                                                                        |
 _\* An asterisk denotes that a property is required._
 
-## Admin config
+### Admin config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), the Text field type allows for the following `admin` properties:
 
@@ -60,7 +59,7 @@ Set this property to a string that will be used for browser autocomplete.
 
 Override the default text direction of the Admin panel for this field. Set to `true` to force right-to-left text direction.
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/textarea.mdx

@@ -18,30 +18,30 @@ keywords: textarea, fields, config, configuration, documentation, Content Manage
   caption="Admin panel screenshot of a Textarea field and read-only Textarea field"
 />
 
-## Config
+### Config
 
-| Option             | Description                                                                                                                                                                 |
-| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
-| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                     |
-| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                |
-| **`minLength`**    | Used by the default validation function to ensure values are of a minimum character length.                                                                                 |
-| **`maxLength`**    | Used by the default validation function to ensure values are of a maximum character length.                                                                                 |
-| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                |
+| Option             | Description                                                                                                                                                                                         |
+| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **`name`** \*      | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                                              |
+| **`label`**        | Text used as a field label in the Admin panel or an object with keys for each language.                                                                                                             |
+| **`unique`**       | Enforce that each entry in the Collection has a unique value for this field.                                                                                                                        |
+| **`minLength`**    | Used by the default validation function to ensure values are of a minimum character length.                                                                                                         |
+| **`maxLength`**    | Used by the default validation function to ensure values are of a maximum character length.                                                                                                         |
+| **`validate`**     | Provide a custom validation function that will be executed on both the Admin panel and the backend. [More](/docs/fields/overview#validation)                                                        |
 | **`index`**        | Build an [index](/docs/database/overview) for this field to produce faster queries. Set this field to `true` if your users will perform queries on this field's data often. |
-| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                               |
-| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                  |
-| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                     |
-| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                            |
-| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                        |
-| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                             |
-| **`required`**     | Require this field to have a value.                                                                                                                                         |
-| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                   |
-| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                   |
+| **`saveToJWT`**    | If this field is top-level and nested in a config supporting [Authentication](/docs/authentication/config), include its data in the user JWT.                                                       |
+| **`hooks`**        | Provide field-based hooks to control logic for this field. [More](/docs/fields/overview#field-level-hooks)                                                                                          |
+| **`access`**       | Provide field-based access control to denote what users can see and do with this field's data. [More](/docs/fields/overview#field-level-access-control)                                             |
+| **`hidden`**       | Restrict this field's visibility from all APIs entirely. Will still be saved to the database, but will not appear in any API or the Admin panel.                                                    |
+| **`defaultValue`** | Provide data to be used for this field's default value. [More](/docs/fields/overview#default-values)                                                                                                |
+| **`localized`**    | Enable localization for this field. Requires [localization to be enabled](/docs/configuration/localization) in the Base config.                                                                     |
+| **`required`**     | Require this field to have a value.                                                                                                                                                                 |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](#admin-config).                                                                                                                           |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                           |
 
 _\* An asterisk denotes that a property is required._
 
-## Admin config
+### Admin config
 
 In addition to the default [field admin config](/docs/fields/overview#admin-config), the Textarea field type allows for the following `admin` properties:
 
@@ -57,7 +57,7 @@ Set this property to a string that will be used for browser autocomplete.
 
 Override the default text direction of the Admin panel for this field. Set to `true` to force right-to-left text direction.
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/ui.mdx

@@ -23,7 +23,7 @@ With this field, you can also inject custom `Cell` components that appear as add
 - Add a "view page" button into a Pages List view to give editors a shortcut to view a page on the frontend of the site
 - Build a "clear cache" button or similar mechanism to manually clear caches of specific documents
 
-## Config
+### Config
 
 | Option                          | Description                                                                                                            |
 | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
@@ -31,12 +31,11 @@ With this field, you can also inject custom `Cell` components that appear as add
 | **`label`**                     | Human-readable label for this UI field.                                                                                |
 | **`admin.components.Field`** \* | React component to be rendered for this field within the Edit view. [More](/docs/admin/components/#field-component)    |
 | **`admin.components.Cell`**     | React component to be rendered as a Cell within collection List views. [More](/docs/admin/components/#field-component) |
-| **`admin.disableListColumn`**   | Set `disableListColumn` to `true` to prevent the UI field from appearing in the list view column selector.             |
 | **`custom`**                    | Extension point for adding custom data (e.g. for plugins)                                                              |
 
 _\* An asterisk denotes that a property is required._
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 

docs/fields/upload.mdx

@@ -20,10 +20,10 @@ keywords: upload, images media, fields, config, configuration, documentation, Co
 </Banner>
 
 <LightDarkImage
-  srcLight="https://payloadcms.com/images/docs/fields/upload.png"
-  srcDark="https://payloadcms.com/images/docs/fields/upload-dark.png"
-  alt="Shows an upload field in the Payload admin panel"
-  caption="Admin panel screenshot of an Upload field"
+srcLight="https://payloadcms.com/images/docs/fields/upload.png"
+srcDark="https://payloadcms.com/images/docs/fields/upload-dark.png"
+alt="Shows an upload field in the Payload admin panel"
+caption="Admin panel screenshot of an Upload field"
 />
 
 **Example uses:**
@@ -32,10 +32,10 @@ keywords: upload, images media, fields, config, configuration, documentation, Co
 - To allow for a `Product` to deliver a downloadable asset like PDF or MP3
 - To give a layout building block the ability to feature a background image
 
-## Config
+### Config
 
 | Option               | Description                                                                                                                                                                 |
-| -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|----------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **`name`** \*        | To be used as the property name when stored and retrieved from the database. [More](/docs/fields/overview#field-names)                                                      |
 | **`*relationTo`** \* | Provide a single collection `slug` to allow this field to accept a relation to. <strong>Note: the related collection must be configured to support Uploads.</strong>        |
 | **`filterOptions`**  | A query to filter which options appear in the UI and validate against. [More](#filtering-upload-options).                                                                   |
@@ -56,7 +56,7 @@ keywords: upload, images media, fields, config, configuration, documentation, Co
 
 _\* An asterisk denotes that a property is required._
 
-## Example
+### Example
 
 `collections/ExampleCollection.ts`
 
@@ -76,7 +76,7 @@ export const ExampleCollection: CollectionConfig = {
 }
 ```
 
-## Filtering upload options
+### Filtering upload options
 
 Options can be dynamically limited by supplying a [query constraint](/docs/queries/overview), which will be used both
 for validating input and filtering available uploads in the UI.
@@ -85,15 +85,15 @@ The `filterOptions` property can either be a `Where` query, or a function return
 prevent all, or a `Where` query. When using a function, it will be
 called with an argument object with the following properties:
 
-| Property      | Description                                                                                           |
-| ------------- | ----------------------------------------------------------------------------------------------------- |
-| `relationTo`  | The collection `slug` to filter against, limited to this field's `relationTo` property                |
-| `data`        | An object containing the full collection or global document currently being edited                    |
-| `siblingData` | An object containing document data that is scoped to only fields within the same parent of this field |
-| `id`          | The `id` of the current document being edited. `id` is `undefined` during the `create` operation      |
-| `user`        | An object containing the currently authenticated user                                                 |
+| Property      | Description                                                                          |
+|---------------|--------------------------------------------------------------------------------------|
+| `relationTo`  | The `relationTo` to filter against (as defined on the field)                         |
+| `data`        | An object of the full collection or global document currently being edited           |
+| `siblingData` | An object of the document data limited to fields within the same parent to the field |
+| `id`          | The value of the collection `id`, will be `undefined` on create request              |
+| `user`        | The currently authenticated user object                                              |
 
-## Example
+**Example:**
 
 ```ts
 const uploadField = {

docs/getting-started/concepts.mdx

@@ -8,13 +8,13 @@ keywords: documentation, getting started, guide, Content Management System, cms,
 
 Payload is based around a small and intuitive set of concepts. Before starting to work with Payload, it's a good idea to familiarize yourself with the following:
 
-## Config
+### Config
 
 <Banner type="info">The Payload config is where you configure everything that Payload does.</Banner>
 
 By default, the Payload config lives in the root folder of your code and is named `payload.config.js` (`payload.config.ts` if you're using TypeScript), but you can customize its name and where you store it. You can write full functions and even full React components right into your config.
 
-## Collections
+### Collections
 
 <Banner type="info">
   A Collection represents a type of content that Payload will store and can contain many documents.
@@ -24,7 +24,7 @@ Collections define the shape of your data as well as all functionalities attache
 
 They can represent anything you can store in a database - for example - pages, posts, users, people, orders, categories, events, customers, transactions, and anything else your app needs.
 
-## Globals
+### Globals
 
 <Banner type="info">
   A Global is a "one-off" piece of content that is perfect for storing navigational structures,
@@ -33,7 +33,7 @@ They can represent anything you can store in a database - for example - pages, p
 
 Globals are in many ways similar to Collections, but there is only ever **one** instance of a Global, whereas Collections can contain many documents.
 
-## Fields
+### Fields
 
 <Banner type="info">
   Fields are the building blocks of Payload. Collections and Globals both use Fields to define the
@@ -42,7 +42,7 @@ Globals are in many ways similar to Collections, but there is only ever **one**
 
 Payload comes with [many different field types](../fields/overview) that give you a ton of flexibility while designing your API. Each Field type has its own potential properties that allow you to customize how they work.
 
-## Hooks
+### Hooks
 
 <Banner type="info">
   Hooks are where you can "tie in" to existing Payload actions to perform your own additional logic
@@ -53,7 +53,7 @@ Hooks are an extremely powerful concept and are central to extending and customi
 
 There are many more potential reasons to use Hooks. For more, visit the [Hooks documentation](/docs/hooks/overview).
 
-## Access Control
+### Access Control
 
 <Banner type="info">
   Access Control refers to Payload's system of defining who can do what to your API.
@@ -63,7 +63,7 @@ Access Control is extremely powerful but easy and intuitive to manage. You can e
 
 For more, visit the [Access Control documentation](/docs/access-control/overview).
 
-## Depth
+### Depth
 
 <Banner type="info">
   "Depth" gives you control over how many levels down related documents should be automatically
@@ -156,28 +156,6 @@ To populate `user.author.department` in it's entirety you could specify `?depth=
 }
 ```
 
-### Field-level max depth
-
-Fields like relationships or uploads can have a `maxDepth` property that limits the depth of the population for that field. Here are some examples:
-
-Depth: 10
-Current depth when field is accessed: 1
-`maxDepth`: undefined
-
-In this case, the field would be populated to 9 levels of population.
-
-Depth: 10
-Current depth when field is accessed: 0
-`maxDepth`: 2
-
-In this case, the field would be populated to 2 levels of population, despite there being a remaining depth of 8.
-
-Depth: 10
-Current depth when field is accessed: 2
-`maxDepth`: 1
-
-In this case, the field would not be populated, as the current depth (2) has exceeded the `maxDepth` for this field (1).
-
 <Banner type="warning">
   <strong>Note:</strong>
   <br />

docs/getting-started/installation.mdx

@@ -6,12 +6,12 @@ desc: To quickly get started with Payload, simply run npx create-payload-app or
 keywords: documentation, getting started, guide, Content Management System, cms, headless, javascript, node, react, express
 ---
 
-## Software Requirements
+#### Software Requirements
 
 Payload requires the following software:
 
 - Any JavaScript package manager (Yarn, NPM, or pnpm)
-- Node.js version 18+
+- Node.js version 16+
 - Any [compatible database](/docs/database/overview) (MongoDB or Postgres)
 
 <Banner type="warning">
@@ -48,7 +48,7 @@ Write the above code into your newly created config file. This baseline config w
 
 Although this is just the bare minimum config, there are _many_ more options that you can control here. To reference the full config and all of its options, [click here](/docs/configuration/overview).
 
-## Server
+### Server
 
 Now that you've got a baseline Payload config, it's time to initialize Payload. It requires an Express server that you provide, so if you're not familiar with how to set up a baseline Express server, please read up on exactly what Express is and why to use it. Express' own [Documentation](https://expressjs.com/en/starter/hello-world.html) is a good place to start. Otherwise, follow along below for how to build your own Express server to use with Payload.
 
@@ -62,7 +62,9 @@ import express from 'express'
 const app = express()
 
 app.listen(3000, async () => {
-  console.log('Express is now listening for incoming connections on port 3000.')
+  console.log(
+    "Express is now listening for incoming connections on port 3000."
+  )
 })
 ```
 
@@ -84,7 +86,9 @@ const start = async () => {
   })
 
   app.listen(3000, async () => {
-    console.log('Express is now listening for incoming connections on port 3000.')
+    console.log(
+      "Express is now listening for incoming connections on port 3000."
+    )
   })
 }
 
@@ -100,54 +104,52 @@ PAYLOAD_SECRET=your-payload-secret
 
 Here is a list of all properties available to pass through `payload.init`:
 
-#### secret
-
+##### secret
 **Required**. This is a secure string that will be used to authenticate with Payload. It can be random but should be at least 14 characters and be very difficult to guess.
 
 Payload uses this secret key to generate secure user tokens (JWT). Behind the scenes, we do not use your secret key to encrypt directly - instead, we first take the secret key and create an encrypted string using the SHA-256 hash function. Then, we reduce the encrypted string to its first 32 characters. This final value is what Payload uses for encryption.
 
-#### config
+##### config
 
 Allows you to pass your config directly to the onInit function. The config passed here should match the payload.config file.
 
-#### disableOnInit
+##### disableOnInit
 
 A boolean that disables running your `onInit` function when Payload starts up.
 
-#### disableDBConnect
+##### disableDBConnect
 
 A boolean that disables the database connection when Payload starts up.
 
-#### email
+##### email
 
 An object used to configure SMTP. [Read more](/docs/email/overview).
 
-#### express
-
+##### express
 This is your Express app as shown above. Payload will tie into your existing `app` and scope all of its functionalities to sub-routers. By default, Payload will add an `/admin` router and an `/api` router, but you can customize these paths.
 
-#### local
+##### local
 
 A boolean that when set to `true` tells Payload to start in local-only mode which will bypass setting up API routes. When set to `true`, `express` is not required. This is useful when running scripts that need to use Payload's [local-api](/docs/local-api/overview).
 
-#### loggerDestination
+##### loggerDestination
 
 Specify destination stream for the built-in Pino logger that Payload uses for internal logging. See [Pino Docs](https://getpino.io/#/docs/api?id=pino-destination) for more info on what is available.
 
-#### loggerOptions
+##### loggerOptions
 
 Specify options for the built-in Pino logger that Payload uses for internal logging. See [Pino Docs](https://getpino.io/#/docs/api?id=options) for more info on what is available.
 
-#### onInit
+##### onInit
 
 A function that is called immediately following startup that receives the Payload instance as it's only argument.
 
-## Test it out
+### Test it out
 
 After you've gotten this far, it's time to boot up Payload. Start your project in your application's folder to get going.
 
 After it starts, you can go to `http://localhost:3000/admin` to create your first Payload user!
 
-## Docker
+### Docker
 
 Looking to deploy Payload with Docker? New projects with `create-payload-app` come with a Dockerfile and docker-compose.yml file ready to go. Examples of these files can be seen in our [Deployment docs](/docs/production/deployment#docker).

docs/getting-started/what-is-payload.mdx

@@ -17,8 +17,7 @@ development process, but importantly, stay out of your way as your apps get more
 <Banner type="success">
   <strong>Payload 2.0 has been released!</strong>
   <br />
-  Includes Postgres support, Live Preview, Lexical Editor, and more.{' '}
-  <a href="/blog/payload-2-0">Read the announcement</a>.
+  Includes Postgres support, Live Preview, Lexical Editor, and more. <a href="/blog/payload-2-0">Read the announcement</a>.
 </Banner>
 
 Out of the box, Payload gives you a lot of the things that you often need when developing a new website, web app, or native app:
@@ -38,7 +37,7 @@ In this way, the CMS can ensure that its content editing experience is highly po
 
 At this point this concept is [widely](https://en.wikipedia.org/wiki/Headless_content_management_system) [discussed](https://css-tricks.com/what-is-a-headless-cms/) online, and for good reason. The web has become more complicated and with complexity comes the demand for developers to better structure their code. The rise of interface libraries like React and Vue are now the de-facto standard for building modern applications and traditional content management systems are often not designed to make use of them.
 
-## Why Payload?
+### Why Payload?
 
 The team behind Payload has been building websites and apps with existing content management systems and application frameworks for over a decade. We know what works and what doesn't about each of the existing solutions, and to this day have found no silver bullet solution.
 

docs/graphql/extending.mdx

@@ -25,11 +25,11 @@ This is Payload's GraphQL dependency. You should not install your own copy of Gr
 
 This is a copy of the currently running Payload instance, which provides you with existing GraphQL types for all of your Collections and Globals - among other things.
 
-## Return value
+##### Return value
 
 Both `graphQL.queries` and `graphQL.mutations` functions should return an object with properties equal to your newly written GraphQL queries and mutations.
 
-## Example
+### Example
 
 `payload.config.js`:
 
@@ -68,7 +68,7 @@ export default buildConfig({
 })
 ```
 
-## Resolver function
+### Resolver function
 
 In your resolver, make sure you set `depth: 0` if you're returning data directly from the local API so that GraphQL can correctly resolve queries to nested values such as relationship data.
 
@@ -96,7 +96,7 @@ An object containing the `req` and `res` objects that will provide you with the
 
 Contextual information about the currently running GraphQL operation. You can get schema information from this as well as contextual information about where this resolver function is being run.
 
-## Types
+### Types
 
 We've exposed a few types and utilities to help you extend the API further. Payload uses the GraphQL.js package for which you can view the full list of available types in the [official documentation](https://graphql.org/graphql-js/type/).
 
@@ -138,7 +138,7 @@ graphQL?: {
 }
 ```
 
-## Best practices
+### Best practices
 
 There are a few ways to structure your code, we recommend using a dedicated `graphql` directory so you can keep all of your logic in one place. You have total freedom of how you want to structure this but a common pattern is to group functions by type and with their resolver.
 

docs/graphql/graphql-schema.mdx

@@ -8,7 +8,7 @@ keywords: headless cms, typescript, documentation, Content Management System, cm
 
 When working with GraphQL it is useful to have the schema for development of other projects that need to call on your GraphQL endpoint. In Payload the schema is controlled by your collections and globals and is made available to the developer or third parties, it is not necessary for developers using Payload to write schema types manually.
 
-## Schema generation script
+### Schema generation script
 
 Run the following command in a Payload project to generate your project's GraphQL schema from Payload:
 
@@ -16,7 +16,20 @@ Run the following command in a Payload project to generate your project's GraphQ
 payload generate:graphQLSchema
 ```
 
-## Custom Field Schemas
+You can run this command whenever you need to regenerate your GraphQL schema and output it to a file, and then you can use the schema for writing your own GraphQL elsewhere in other projects.
+
+### Custom output file path
+
+```js
+{
+  // the remainder of your config
+	graphQL: {
+		schemaOutputFile: path.resolve(__dirname, './graphql/schema.graphql'),
+	},
+}
+```
+
+### Custom Field Schemas
 
 For `array`, `block`, `group` and named `tab` fields, you can generate top level reusable interfaces. The following group field config:
 
@@ -56,7 +69,7 @@ type Collection1 {
 
 The above example outputs all your definitions to a file relative from your payload config as `./graphql/schema.graphql`. By default, the file will be output to your current working directory as `schema.graphql`.
 
-### Adding an NPM script
+#### Adding an NPM script
 
 <Banner type="warning">
   <strong>Important</strong>

docs/graphql/overview.mdx

@@ -16,13 +16,14 @@ The labels you provide for your Collections and Globals are used to name the Gra
 
 At the top of your Payload config you can define all the options to manage GraphQL.
 
-| Option                          | Description                                                                                                                     |
-| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `mutations`                     | Any custom Mutations to be added in addition to what Payload provides. [More](/docs/graphql/extending)                          |
-| `queries`                       | Any custom Queries to be added in addition to what Payload provides. [More](/docs/graphql/extending)                            |
-| `maxComplexity`                 | A number used to set the maximum allowed complexity allowed by requests [More](/docs/graphql/overview#query-complexity-limits)  |
-| `disablePlaygroundInProduction` | A boolean that if false will enable the GraphQL playground, defaults to true. [More](/docs/graphql/overview#graphql-playground) |
-| `disable`                       | A boolean that if true will disable the GraphQL entirely, defaults to false.                                                    |
+| Option                          | Description                                                                                                                                                   |
+| ------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `mutations`                     | Any custom Mutations to be added in addition to what Payload provides. [More](/docs/graphql/extending)                                                        |
+| `queries`                       | Any custom Queries to be added in addition to what Payload provides. [More](/docs/graphql/extending)                                                          |
+| `maxComplexity`                 | A number used to set the maximum allowed complexity allowed by requests [More](/docs/graphql/overview#query-complexity-limits)                                |
+| `disablePlaygroundInProduction` | A boolean that if false will enable the GraphQL playground, defaults to true. [More](/docs/graphql/overview#graphql-playground)                               |
+| `disable`                       | A boolean that if true will disable the GraphQL entirely, defaults to false.                                                                                  |
+| `schemaOutputFile`              | A string for the file path used by the generate schema command. Defaults to `graphql.schema` next to `payload.config.ts` [More](/docs/graphql/graphql-schema) |
 
 ## Collections
 

docs/hooks/collections.mdx

@@ -294,7 +294,7 @@ import { CollectionAfterForgotPasswordHook } from 'payload/types'
 
 const afterForgotPasswordHook: CollectionAfterForgotPasswordHook = async ({
   args, // arguments passed into the operation
-  context,
+  context, 
   collection, // The collection which this hook is being run on
 }) => {...}
 ```

docs/hooks/fields.mdx

@@ -21,7 +21,6 @@ functionalities to be easily reusable across your projects.
 
 - [beforeValidate](#beforevalidate)
 - [beforeChange](#beforechange)
-- beforeDuplicate(#beforeduplicate)
 - [afterChange](#afterchange)
 - [afterRead](#afterread)
 
@@ -39,7 +38,6 @@ const ExampleField: Field = {
   hooks: {
     beforeValidate: [(args) => {...}],
     beforeChange: [(args) => {...}],
-    beforeDuplicate: [(args) => {...}],
     afterChange: [(args) => {...}],
     afterRead: [(args) => {...}],
   }
@@ -66,7 +64,7 @@ which field hook you are utilizing.
 Field Hooks receive one `args` argument that contains the following properties:
 
 | Option                   | Description                                                                                                                                                                                                           |
-| ------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+|--------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | **`data`**               | The data passed to update the document within `create` and `update` operations, and the full document itself in the `afterRead` hook.                                                                                 |
 | **`siblingData`**        | The sibling data passed to a field that the hook is running against.                                                                                                                                                  |
 | **`findMany`**           | Boolean to denote if this hook is running against finding one, or finding many within the `afterRead` hook.                                                                                                           |
@@ -113,13 +111,11 @@ const usernameField: Field = {
   name: 'username',
   type: 'text',
   hooks: {
-    beforeValidate: [
-      ({ value }) => {
-        // Trim whitespace and convert to lowercase
-        return value.trim().toLowerCase()
-      },
-    ],
-  },
+    beforeValidate: [({ value }) => {
+      // Trim whitespace and convert to lowercase
+      return value.trim().toLowerCase()
+    }],
+  }
 }
 ```
 
@@ -140,15 +136,13 @@ const emailField: Field = {
   name: 'email',
   type: 'email',
   hooks: {
-    beforeChange: [
-      ({ value, operation }) => {
-        if (operation === 'create') {
-          // Perform additional validation or transformation for 'create' operation
-        }
-        return value
-      },
-    ],
-  },
+    beforeChange: [({ value, operation }) => {
+      if (operation === 'create') {
+        // Perform additional validation or transformation for 'create' operation
+      }
+      return value
+    }],
+  }
 }
 ```
 
@@ -170,21 +164,17 @@ const membershipStatusField: Field = {
   options: [
     { label: 'Standard', value: 'standard' },
     { label: 'Premium', value: 'premium' },
-    { label: 'VIP', value: 'vip' },
+    { label: 'VIP', value: 'vip' }
   ],
   hooks: {
-    afterChange: [
-      ({ value, previousValue, req }) => {
-        if (value !== previousValue) {
-          // Log or perform an action when the membership status changes
-          console.log(
-            `User ID ${req.user.id} changed their membership status from ${previousValue} to ${value}.`,
-          )
-          // Here, you can implement actions that could track conversions from one tier to another
-        }
-      },
-    ],
-  },
+    afterChange: [({ value, previousValue, req }) => {
+      if (value !== previousValue) {
+        // Log or perform an action when the membership status changes
+        console.log(`User ID ${req.user.id} changed their membership status from ${previousValue} to ${value}.`)
+        // Here, you can implement actions that could track conversions from one tier to another
+      }
+    }],
+  }
 }
 ```
 
@@ -205,13 +195,11 @@ const dateField: Field = {
   name: 'createdAt',
   type: 'date',
   hooks: {
-    afterRead: [
-      ({ value }) => {
-        // Format date for display
-        return new Date(value).toLocaleDateString()
-      },
-    ],
-  },
+    afterRead: [({ value }) => {
+      // Format date for display
+      return new Date(value).toLocaleDateString()
+    }],
+  }
 }
 ```
 
@@ -219,31 +207,6 @@ Here, the `afterRead` hook for the `dateField` is used to format the date into a
 using `toLocaleDateString()`. This hook modifies the way the date is presented to the user, making it more
 user-friendly.
 
-### beforeDuplicate
-
-The `beforeDuplicate` field hook is called on each locale (when using localization), when duplicating a document. It may be used when documents having the
-exact same properties may cause issue. This gives you a way to avoid duplicate names on `unique`, `required` fields or when external systems expect non-repeating values on documents.
-
-This hook gets called after `beforeChange` hooks are called and before the document is saved to the database.
-
-By Default, unique and required text fields Payload will append "- Copy" to the original document value. The default is not added if your field has its own, you must return non-unique values from your beforeDuplicate hook to avoid errors or enable the `disableDuplicate` option on the collection.
-Here is an example of a number field with a hook that increments the number to avoid unique constraint errors when duplicating a document:
-
-```ts
-import { Field } from 'payload/types'
-
-const numberField: Field = {
-  name: 'number',
-  type: 'number',
-  hooks: {
-    // increment existing value by 1
-    beforeDuplicate: [({ value }) => {
-      return (value ?? 0) + 1
-    }],
-  }
-}
-```
-
 ## TypeScript
 
 Payload exports a type for field hooks which can be accessed and used as follows:

docs/hooks/globals.mdx

@@ -79,7 +79,7 @@ import { GlobalAfterChangeHook } from 'payload/types'
 
 const afterChangeHook: GlobalAfterChangeHook = async ({
   doc, // full document data
-  previousDoc, // document data before updating the collection
+  previousDoc, // document data before updating the global
   req, // full express request
 }) => {
   return data

docs/hooks/overview.mdx

@@ -28,15 +28,15 @@ Example uses:
 
 There are many more use cases for Hooks and the sky is the limit.
 
-## Async vs. synchronous
+#### Async vs. synchronous
 
 All hooks can be written as either synchronous or asynchronous functions. If the Hook should modify data before a document is updated or created, and it relies on asynchronous actions such as fetching data from a third party, it might make sense to define your Hook as an asynchronous function, so you can be sure that your Hook completes before the operation's lifecycle continues. Async hooks are run in series - so if you have two async hooks defined, the second hook will wait for the first to complete before it starts.
 
 If your Hook simply performs a side-effect, such as updating a CRM, it might be okay to define it synchronously, so the Payload operation does not have to wait for your hook to complete.
 
-## Server-only execution
+#### Server-only execution
 
-Payload Hooks are only triggered on the server. You can safely [remove your hooks](/docs/admin/webpack#aliasing-server-only-modules) from your Admin panel's client-side code by customizing the Webpack config, which not only keeps your Admin bundles' filesize small but also ensures that any server-side only code does not cause problems within browser environments.
+Payload Hooks are only triggered on the server. You can safely [remove your hooks](/docs/admin/excluding-server-code#aliasing-server-only-modules) from your Admin panel's client-side code by customizing the Webpack config, which not only keeps your Admin bundles' filesize small but also ensures that any server-side only code does not cause problems within browser environments.
 
 ## Hook Types
 

docs/integrations/vercel-content-link.mdx

@@ -1,103 +0,0 @@
----
-title: Vercel Content Link
-label: Vercel Content Link
-order: 10
-desc: Payload + Vercel Content Link allows yours editors to navigate directly from the content rendered on your front-end to the fields in Payload that control it.
-keywords: vercel, vercel content link, visual editing, content source maps, Content Management System, cms, headless, javascript, node, react, express
----
-
-[Vercel Content Link](https://vercel.com/docs/workflow-collaboration/edit-mode#content-link) will allow your editors to navigate directly from the content rendered on your front-end to the fields in Payload that control it. This requires no changes to your front-end code and very few changes to your Payload config.
-
-![Versions](/images/docs/vercel-visual-editing.jpg)
-
-<Banner type="warning">
-  Vercel Content Link is an enterprise-only feature and only available for deployments hosted on
-  Vercel. If you are an existing enterprise customer, [contact our sales
-  team](https://payloadcms.com/for-enterprise) for help with your integration.
-</Banner>
-
-## How it works
-
-To power Vercel Content Link, Payload embeds Content Source Maps into its API responses. Content Source Maps are invisible, encoded JSON values that include a link back to the field in the CMS that generated the content. When rendered on the page, Vercel detects and decodes these values to display the Content Link interface.
-
-For full details on how the encoding and decoding algorithm works, check out [`@vercel/stega`](https://www.npmjs.com/package/@vercel/stega).
-
-## Getting Started
-
-Setting up Payload with Vercel Content Link is easy. First, install the `@payloadcms/plugin-csm` plugin into your project. This plugin requires an API key to install, [contact our sales team](https://payloadcms.com/for-enterprise) if you don't already have one.
-
-```bash
-npm i @payloadcms/plugin-csm
-```
-
-Then in the `plugins` array of your Payload config, call the plugin and enable any collections that require Content Source Maps.
-
-```ts
-import { buildConfig } from "payload/config"
-import contentSourceMaps from "@payloadcms/plugin-csm"
-
-const config = buildConfig({
-  collections: [
-    {
-      slug: "pages",
-      fields: [
-        {
-          name: 'slug',
-          type: 'text',
-        },
-        {
-          name: 'title,'
-          type: 'text',
-        },
-      ],
-    },
-  ],
-  plugins: [
-    contentSourceMaps({
-      collections: ["pages"],
-    }),
-  ],
-})
-
-export default config
-```
-
-Now in your Next.js app, include the `?encodeSourceMaps=true` parameter in any of your API requests. For performance reasons, this should only be done when in draft mode or on preview deployments.
-
-```ts
-if (isDraftMode || process.env.VERCEL_ENV === 'preview') {
-  const res = await fetch(
-    `${process.env.NEXT_PUBLIC_PAYLOAD_CMS_URL}/api/pages?where[slug][equals]=${slug}&encodeSourceMaps=true`,
-  )
-}
-```
-
-And that's it! You are now ready to enter Edit Mode and begin visually editing your content.
-
-#### Edit Mode
-
-To see Content Link on your site, you first need to visit any preview deployment on Vercel and login using the Vercel Toolbar. When Content Source Maps are detected on the page, a pencil icon will appear in the toolbar. Clicking this icon will enable Edit Mode, highlighting all editable fields on the page in blue.
-
-![Versions](/images/docs/vercel-toolbar.jpg)
-
-## Troubleshooting
-
-### Date Fields
-
-The plugin does not encode `date` fields by default, but for some cases like text that uses negative CSS letter-spacing, it may be necessary to split the encoded data out from the rendered text. This way you can safely use the cleaned data as expected.
-
-```ts
-import { vercelStegaSplit } from '@vercel/stega'
-const { cleaned, encoded } = vercelStegaSplit(text)
-```
-
-### Block fields
-
-All `blocks` fields by definition do not have plain text strings to encode. For this reason, blocks are given an additional `encodedSourceMap` key, which you can use to enable Content Link on entire sections of your site. You can then specify the editing container by adding the `data-vercel-edit-target` HTML attribute to any top-level element of your block.
-
-```ts
-<div data-vercel-edit-target>
-  <span style={{ display: "none" }}>{encodedSourceMap}</span>
-  {children}
-</div>
-```

docs/integrations/vercel-visual-editing.mdx

@@ -0,0 +1,103 @@
+---
+title: Vercel Visual Editing
+label: Vercel Visual Editing
+order: 10
+desc: Payload + Vercel Visual Editing allows yours editors to navigate directly from the content rendered on your front-end to the fields in Payload that control it.
+keywords: vercel, vercel visual editing, visual editing, content source maps, Content Management System, cms, headless, javascript, node, react, express
+---
+
+[Vercel Visual Editing](https://vercel.com/docs/workflow-collaboration/visual-editing) will allow your editors to navigate directly from the content rendered on your front-end to the fields in Payload that control it. This requires no changes to your front-end code and very few changes to your Payload config.
+
+![Versions](/images/docs/vercel-visual-editing.jpg)
+
+<Banner type="warning">
+  Vercel Visual Editing is an enterprise-only feature and only available for deployments hosted on
+  Vercel. If you are an existing enterprise customer, [contact our sales
+  team](https://payloadcms.com/for-enterprise) for help with your integration.
+</Banner>
+
+### How it works
+
+To power Vercel Visual Editing, Payload embeds Content Source Maps into its API responses. Content Source Maps are invisible, encoded JSON values that include a link back to the field in the CMS that generated the content. When rendered on the page, Vercel detects and decodes these values to display the Visual Editing interface.
+
+For full details on how the encoding and decoding algorithm works, check out [`@vercel/stega`](https://www.npmjs.com/package/@vercel/stega).
+
+### Getting Started
+
+Setting up Payload with Vercel Visual Editing is easy. First, install the `@payloadcms/plugin-csm` plugin into your project. This plugin requires an API key to install, [contact our sales team](https://payloadcms.com/for-enterprise) if you don't already have one.
+
+```bash
+npm i @payloadcms/plugin-csm
+```
+
+Then in the `plugins` array of your Payload config, call the plugin and enable any collections that require Content Source Maps.
+
+```ts
+import { buildConfig } from "payload/config"
+import contentSourceMaps from "@payloadcms/plugin-csm"
+
+const config = buildConfig({
+  collections: [
+    {
+      slug: "pages",
+      fields: [
+        {
+          name: 'slug',
+          type: 'text',
+        },
+        {
+          name: 'title,'
+          type: 'text',
+        },
+      ],
+    },
+  ],
+  plugins: [
+    contentSourceMaps({
+      collections: ["pages"],
+    }),
+  ],
+})
+
+export default config
+```
+
+Now in your Next.js app, include the `?encodeSourceMaps=true` parameter in any of your API requests. For performance reasons, this should only be done when in draft mode or on preview deployments.
+
+```ts
+if (isDraftMode || process.env.VERCEL_ENV === 'preview') {
+  const res = await fetch(
+    `${process.env.NEXT_PUBLIC_PAYLOAD_CMS_URL}/api/pages?where[slug][equals]=${slug}&encodeSourceMaps=true`,
+  )
+}
+```
+
+And that's it! You are now ready to enter Edit Mode and begin visually editing your content.
+
+##### Edit Mode
+
+To see Visual Editing on your site, you first need to visit any preview deployment on Vercel and login using the Vercel Toolbar. When Content Source Maps are detected on the page, a pencil icon will appear in the toolbar. Clicking this icon will enable Edit Mode, highlighting all editable fields on the page in blue.
+
+![Versions](/images/docs/vercel-toolbar.jpg)
+
+### Troubleshooting
+
+##### Dates
+
+The plugin does not encode `date` fields by default, but for some cases like text that uses negative CSS letter-spacing, it may be necessary to split the encoded data out from the rendered text. This way you can safely use the cleaned data as expected.
+
+```ts
+import { vercelStegaSplit } from '@vercel/stega'
+const { cleaned, encoded } = vercelStegaSplit(text)
+```
+
+##### Blocks
+
+All `blocks` fields by definition do not have plain text strings to encode. For this reason, blocks are given an additional `encodedSourceMap` key, which you can use to enable Visual Editing on entire sections of your site. You can then specify the editing container by adding the `data-vercel-edit-target` HTML attribute to any top-level element of your block.
+
+```ts
+<div data-vercel-edit-target>
+  <span style={{ display: "none" }}>{encodedSourceMap}</span>
+  {children}
+</div>
+```

docs/lexical/converters.mdx

@@ -1,378 +0,0 @@
----
-title: Lexical Converters
-label: Converters
-order: 20
-desc: Conversion between lexical, markdown and html
-keywords: lexical, rich text, editor, headless cms, convert, html, mdx, markdown, md, conversion, export
----
-
-
-## Lexical => HTML
-
-Lexical saves data in JSON, but can also generate its HTML representation via two main methods:
-
-1. **Outputting HTML from the Collection:** Create a new field in your collection to convert saved JSON content to HTML. Payload generates and outputs the HTML for use in your frontend.
-2. **Generating HTML on any server** Convert JSON to HTML on-demand on the server.
-
-The editor comes with built-in HTML serializers, simplifying the process of converting JSON to HTML.
-
-### Outputting HTML from the Collection
-
-To add HTML generation directly within the collection, follow the example below:
-
-```ts
-import type { CollectionConfig } from 'payload/types'
-
-import { HTMLConverterFeature, lexicalEditor, lexicalHTML } from '@payloadcms/richtext-lexical'
-
-const Pages: CollectionConfig = {
-  slug: 'pages',
-  fields: [
-    {
-      name: 'nameOfYourRichTextField',
-      type: 'richText',
-      editor: lexicalEditor({
-        features: ({ defaultFeatures }) => [
-          ...defaultFeatures,
-          // The HTMLConverter Feature is the feature which manages the HTML serializers.
-          // If you do not pass any arguments to it, it will use the default serializers.
-          HTMLConverterFeature({}),
-        ],
-      }),
-    },
-    lexicalHTML('nameOfYourRichTextField', { name: 'nameOfYourRichTextField_html' }),
-  ],
-}
-```
-
-The `lexicalHTML()` function creates a new field that automatically converts the referenced lexical richText field into HTML through an afterRead hook.
-
-### Generating HTML anywhere on the server:
-
-If you wish to convert JSON to HTML ad-hoc, use this code snippet:
-
-```ts
-import type { SerializedEditorState } from 'lexical'
-import {
-  type SanitizedEditorConfig,
-  convertLexicalToHTML,
-  consolidateHTMLConverters,
-} from '@payloadcms/richtext-lexical'
-
-async function lexicalToHTML(
-  editorData: SerializedEditorState,
-  editorConfig: SanitizedEditorConfig,
-) {
-  return await convertLexicalToHTML({
-    converters: consolidateHTMLConverters({ editorConfig }),
-    data: editorData,
-  })
-}
-```
-
-This method employs `convertLexicalToHTML` from `@payloadcms/richtext-lexical`, which converts the serialized editor state into HTML.
-
-Because every `Feature` is able to provide html converters, and because the `htmlFeature` can modify those or provide their own, we need to consolidate them with the default html Converters using the `consolidateHTMLConverters` function.
-
-### CSS
-
-Payload's lexical HTML converter does not generate CSS for you, but it does add classes to the generated HTML. You can use these classes to style the HTML in your frontend.
-
-Here is some "base" CSS you can use to ensure that nested lists render correctly:
-
-```css
-/* Base CSS for Lexical HTML */
-.nestedListItem, .list-check {
-  list-style-type: none;
-}
-```
-
-### Creating your own HTML Converter
-
-HTML Converters are typed as `HTMLConverter`, which contains the node type it should handle, and a function that accepts the serialized node from the lexical editor, and outputs the HTML string. Here's the HTML Converter of the Upload node as an example:
-
-```ts
-import type { HTMLConverter } from '@payloadcms/richtext-lexical'
-
-const UploadHTMLConverter: HTMLConverter<SerializedUploadNode> = {
-  converter: async ({ node, payload }) => {
-    const uploadDocument = await payload.findByID({
-      id: node.value.id,
-      collection: node.relationTo,
-    })
-    const url = (payload?.config?.serverURL || '') + uploadDocument?.url
-
-    if (!(uploadDocument?.mimeType as string)?.startsWith('image')) {
-      // Only images can be serialized as HTML
-      return ``
-    }
-
-    return `<img src="${url}" alt="${uploadDocument?.filename}" width="${uploadDocument?.width}"  height="${uploadDocument?.height}"/>`
-  },
-  nodeTypes: [UploadNode.getType()], // This is the type of the lexical node that this converter can handle. Instead of hardcoding 'upload' we can get the node type directly from the UploadNode, since it's static.
-}
-```
-
-As you can see, we have access to all the information saved in the node (for the Upload node, this is `value`and `relationTo`) and we can use that to generate the HTML.
-
-The `convertLexicalToHTML` is part of `@payloadcms/richtext-lexical` automatically handles traversing the editor state and calling the correct converter for each node.
-
-### Embedding the HTML Converter in your Feature
-
-You can embed your HTML Converter directly within your custom `ServerFeature`, allowing it to be handled automatically by the `consolidateHTMLConverters` function. Here is an example:
-
-```ts
-import { createNode } from '@payloadcms/richtext-lexical'
-import type { FeatureProviderProviderServer } from '@payloadcms/richtext-lexical'
-
-export const UploadFeature: FeatureProviderProviderServer<
-  UploadFeatureProps,
-  UploadFeaturePropsClient
-> = (props) => {
-  /*...*/
-  return {
-    feature: () => {
-      return {
-        nodes: [
-          createNode({
-            converters: {
-              html: yourHTMLConverter, // <= This is where you define your HTML Converter
-            },
-            node: UploadNode,
-            //...
-          }),
-        ],
-        ClientComponent: UploadFeatureClientComponent,
-        clientFeatureProps: clientProps,
-        serverFeatureProps: props,
-        /*...*/
-      }
-    },
-    key: 'upload',
-    serverFeatureProps: props,
-  }
-}
-```
-
-## Headless Editor
-
-Lexical provides a seamless way to perform conversions between various other formats:
-
-- HTML to Lexical (or, importing HTML into the lexical editor)
-- Markdown to Lexical (or, importing Markdown into the lexical editor)
-- Lexical to Markdown
-
-A headless editor can perform such conversions outside of the main editor instance. Follow this method to initiate a headless editor:
-
-```ts
-import { createHeadlessEditor } from '@lexical/headless' // <= make sure this package is installed
-import { getEnabledNodes, sanitizeServerEditorConfig } from '@payloadcms/richtext-lexical'
-
-const yourEditorConfig // <= your editor config here
-
-const headlessEditor = createHeadlessEditor({
-  nodes: getEnabledNodes({
-    editorConfig: sanitizeServerEditorConfig(yourEditorConfig),
-  }),
-})
-```
-
-### Getting the editor config
-
-As you can see, you need to provide an editor config in order to create a headless editor. This is because the editor config is used to determine which nodes & features are enabled, and which converters are used.
-
-To get the editor config, simply import the default editor config and adjust it - just like you did inside of the `editor: lexicalEditor({})` property:
-
-```ts
-import { defaultEditorConfig, defaultEditorFeatures } from '@payloadcms/richtext-lexical' // <= make sure this package is installed
-
-const yourEditorConfig = defaultEditorConfig
-
-// If you made changes to the features of the field's editor config, you should also make those changes here:
-yourEditorConfig.features = [
-  ...defaultEditorFeatures,
-  // Add your custom features here
-]
-```
-
-### Getting the editor config from an existing field
-
-If you have access to the sanitized collection config, you can get access to the lexical sanitized editor config & features, as every lexical richText field returns it. Here is an example how you can get it from another field's afterRead hook:
-
-```ts
-import type { CollectionConfig, RichTextField } from 'payload/types'
-import { createHeadlessEditor } from '@lexical/headless'
-import type { LexicalRichTextAdapter, SanitizedServerEditorConfig } from '@payloadcms/richtext-lexical'
-import {
-  getEnabledNodes,
-  lexicalEditor
-} from '@payloadcms/richtext-lexical'
-
-export const MyCollection: CollectionConfig = {
-  slug: 'slug',
-  fields: [
-    {
-      name: 'text',
-      type: 'text',
-      hooks: {
-        afterRead: [
-          ({ value, collection }) => {
-            const otherRichTextField: RichTextField = collection.fields.find(
-              (field) => 'name' in field && field.name === 'richText',
-            ) as RichTextField
-
-            const lexicalAdapter: LexicalRichTextAdapter =
-              otherRichTextField.editor as LexicalRichTextAdapter
-
-            const sanitizedServerEditorConfig: SanitizedServerEditorConfig =
-              lexicalAdapter.editorConfig
-
-            const headlessEditor = createHeadlessEditor({
-              nodes: getEnabledNodes({
-                editorConfig: sanitizedServerEditorConfig,
-              }),
-            })
-
-            // Do whatever you want with the headless editor
-
-            return value
-          },
-        ],
-      },
-    },
-    {
-      name: 'richText',
-      type: 'richText',
-      editor: lexicalEditor({
-        features,
-      }),
-    }
-  ]
-}
-```
-
-## HTML => Lexical
-
-Once you have your headless editor instance, you can use it to convert HTML to Lexical:
-
-```ts
-import { $generateNodesFromDOM } from '@lexical/html'
-import { $getRoot, $getSelection } from 'lexical'
-import { JSDOM } from 'jsdom'
-
-headlessEditor.update(
-  () => {
-    // In a headless environment you can use a package such as JSDom to parse the HTML string.
-    const dom = new JSDOM(htmlString)
-
-    // Once you have the DOM instance it's easy to generate LexicalNodes.
-    const nodes = $generateNodesFromDOM(headlessEditor, dom.window.document)
-
-    // Select the root
-    $getRoot().select()
-
-    // Insert them at a selection.
-    const selection = $getSelection()
-    selection.insertNodes(nodes)
-  },
-  { discrete: true },
-)
-
-// Do this if you then want to get the editor JSON
-const editorJSON = headlessEditor.getEditorState().toJSON()
-```
-
-Functions prefixed with a `$` can only be run inside an `editor.update()` or `editorState.read()` callback.
-
-This has been taken from the [lexical serialization & deserialization docs](https://lexical.dev/docs/concepts/serialization#html---lexical).
-
-<Banner type="success">
-  <strong>Note:</strong>
-  <br />
-  Using the <code>discrete: true</code> flag ensures instant updates to the editor state. If
-  immediate reading of the updated state isn't necessary, you can omit the flag.
-</Banner>
-
-## Markdown => Lexical
-
-Convert markdown content to the Lexical editor format with the following:
-
-```ts
-import { $convertFromMarkdownString } from '@lexical/markdown'
-import { sanitizeServerEditorConfig } from '@payloadcms/richtext-lexical'
-
-const yourSanitizedEditorConfig = sanitizeServerEditorConfig(yourEditorConfig) // <= your editor config here
-const markdown = `# Hello World`
-
-headlessEditor.update(
-  () => {
-    $convertFromMarkdownString(markdown, yourSanitizedEditorConfig.features.markdownTransformers)
-  },
-  { discrete: true },
-)
-
-// Do this if you then want to get the editor JSON
-const editorJSON = headlessEditor.getEditorState().toJSON()
-```
-
-## Lexical => Markdown
-
-Export content from the Lexical editor into Markdown format using these steps:
-
-1. Import your current editor state into the headless editor.
-2. Convert and fetch the resulting markdown string.
-
-Here's the code for it:
-
-```ts
-import { $convertToMarkdownString } from '@lexical/markdown'
-import { sanitizeServerEditorConfig } from '@payloadcms/richtext-lexical'
-import type { SerializedEditorState } from 'lexical'
-
-const yourSanitizedEditorConfig = sanitizeServerEditorConfig(yourEditorConfig) // <= your editor config here
-const yourEditorState: SerializedEditorState // <= your current editor state here
-
-// Import editor state into your headless editor
-try {
-  headlessEditor.setEditorState(headlessEditor.parseEditorState(yourEditorState)) // This should commit the editor state immediately
-} catch (e) {
-  logger.error({ err: e }, 'ERROR parsing editor state')
-}
-
-// Export to markdown
-let markdown: string
-headlessEditor.getEditorState().read(() => {
-  markdown = $convertToMarkdownString(yourSanitizedEditorConfig?.features?.markdownTransformers)
-})
-```
-
-The `.setEditorState()` function immediately updates your editor state. Thus, there's no need for the `discrete: true` flag when reading the state afterward.
-
-## Lexical => Plain Text
-
-Export content from the Lexical editor into plain text using these steps:
-
-1. Import your current editor state into the headless editor.
-2. Convert and fetch the resulting plain text string.
-
-Here's the code for it:
-
-```ts
-import type { SerializedEditorState } from 'lexical'
-import { $getRoot } from 'lexical'
-
-const yourEditorState: SerializedEditorState // <= your current editor state here
-
-// Import editor state into your headless editor
-try {
-  headlessEditor.setEditorState(headlessEditor.parseEditorState(yourEditorState)) // This should commit the editor state immediately
-} catch (e) {
-  logger.error({ err: e }, 'ERROR parsing editor state')
-}
-
-// Export to plain text
-const plainTextContent =
-  headlessEditor.getEditorState().read(() => {
-    return $getRoot().getTextContent()
-  }) || ''
-```

docs/lexical/migration.mdx

@@ -1,182 +0,0 @@
----
-title: Lexical Migration
-label: Migration
-order: 30
-desc: Migration from slate and payload-plugin-lexical to lexical
-keywords: lexical, rich text, editor, headless cms, migrate, migration
----
-
-## Migrating from Slate
-
-While both Slate and Lexical save the editor state in JSON, the structure of the JSON is different.
-
-### Migration via SlateToLexicalFeature
-
-One way to handle this is to just give your lexical editor the ability to read the slate JSON.
-
-Simply add the `SlateToLexicalFeature` to your editor:
-
-```ts
-import type { CollectionConfig } from 'payload/types'
-
-import { SlateToLexicalFeature, lexicalEditor } from '@payloadcms/richtext-lexical'
-
-const Pages: CollectionConfig = {
-  slug: 'pages',
-  fields: [
-    {
-      name: 'nameOfYourRichTextField',
-      type: 'richText',
-      editor: lexicalEditor({
-        features: ({ defaultFeatures }) => [...defaultFeatures, SlateToLexicalFeature({})],
-      }),
-    },
-  ],
-}
-```
-
-and done! Now, everytime this lexical editor is initialized, it converts the slate date to lexical on-the-fly. If the data is already in lexical format, it will just pass it through.
-
-This is by far the easiest way to migrate from Slate to Lexical, although it does come with a few caveats:
-
-- There is a performance hit when initializing the lexical editor
-- The editor will still output the Slate data in the output JSON, as the on-the-fly converter only runs for the admin panel
-
-The easy way to solve this: Just save the document! This overrides the slate data with the lexical data, and the next time the document is loaded, the lexical data will be used. This solves both the performance and the output issue for that specific document.
-
-### Migration via migration script
-
-The method described above does not solve the issue for all documents, though. If you want to convert all your documents to lexical, you can use a migration script. Here's a simple example:
-
-```ts
-import type { Payload } from 'payload'
-import type { YourDocumentType } from 'payload/generated-types'
-
-import {
-  cloneDeep,
-  convertSlateToLexical,
-  defaultSlateConverters,
-} from '@payloadcms/richtext-lexical'
-
-import { AnotherCustomConverter } from './lexicalFeatures/converters/AnotherCustomConverter'
-
-export async function convertAll(payload: Payload, collectionName: string, fieldName: string) {
-  const docs: YourDocumentType[] = await payload.db.collections[collectionName].find({}).exec() // Use MongoDB models directly to query all documents at once
-  console.log(`Found ${docs.length} ${collectionName} docs`)
-
-  const converters = cloneDeep([...defaultSlateConverters, AnotherCustomConverter])
-
-  // Split docs into batches of 20.
-  const batchSize = 20
-  const batches = []
-  for (let i = 0; i < docs.length; i += batchSize) {
-    batches.push(docs.slice(i, i + batchSize))
-  }
-
-  let processed = 0 // Number of processed docs
-
-  for (const batch of batches) {
-    // Process each batch asynchronously
-    const promises = batch.map(async (doc: YourDocumentType) => {
-      const richText = doc[fieldName]
-
-      if (richText && Array.isArray(richText) && !('root' in richText)) {
-        // It's Slate data - skip already-converted data
-        const converted = convertSlateToLexical({
-          converters: converters,
-          slateData: richText,
-        })
-
-        await payload.update({
-          id: doc.id,
-          collection: collectionName as any,
-          depth: 0, // performance optimization. No need to run population.
-          data: {
-            [fieldName]: converted,
-          },
-        })
-      }
-    })
-
-    // Wait for all promises in the batch to complete. Resolving batches of 20 asynchronously is faster than waiting for each doc to update individually
-    await Promise.all(promises)
-
-    // Update the count of processed docs
-    processed += batch.length
-    console.log(`Converted ${processed} of ${docs.length}`)
-  }
-}
-```
-
-The `convertSlateToLexical` is the same method used in the `SlateToLexicalFeature` - it handles traversing the Slate JSON for you.
-
-Do note that this script might require adjustment depending on your document structure, especially if you have nested richText fields or localization enabled.
-
-### Converting custom Slate nodes
-
-If you have custom Slate nodes, create a custom converter for them. Here's the Upload converter as an example:
-
-```ts
-import type { SerializedUploadNode } from '../uploadNode.'
-import type { SlateNodeConverter } from '@payloadcms/richtext-lexical'
-
-export const SlateUploadConverter: SlateNodeConverter = {
-  converter({ slateNode }) {
-    return {
-      fields: {
-        ...slateNode.fields,
-      },
-      format: '',
-      relationTo: slateNode.relationTo,
-      type: 'upload',
-      value: {
-        id: slateNode.value?.id || '',
-      },
-      version: 1,
-    } as const as SerializedUploadNode
-  },
-  nodeTypes: ['upload'],
-}
-```
-
-It's pretty simple: You get a Slate node as input, and you return the lexical node. The `nodeTypes` array is used to determine which Slate nodes this converter can handle.
-
-When using a migration script, you can add your custom converters to the `converters` property of the `convertSlateToLexical` props, as seen in the example above
-
-When using the `SlateToLexicalFeature`, you can add your custom converters to the `converters` property of the `SlateToLexicalFeature` props:
-
-```ts
-import type { CollectionConfig } from 'payload/types'
-
-import {
-  SlateToLexicalFeature,
-  lexicalEditor,
-  defaultSlateConverters,
-} from '@payloadcms/richtext-lexical'
-
-import { YourCustomConverter } from '../converters/YourCustomConverter'
-
-const Pages: CollectionConfig = {
-  slug: 'pages',
-  fields: [
-    {
-      name: 'nameOfYourRichTextField',
-      type: 'richText',
-      editor: lexicalEditor({
-        features: ({ defaultFeatures }) => [
-          ...defaultFeatures,
-          SlateToLexicalFeature({
-            converters: [...defaultSlateConverters, YourCustomConverter],
-          }),
-        ],
-      }),
-    },
-  ],
-}
-```
-
-## Migrating from payload-plugin-lexical
-
-Migrating from [payload-plugin-lexical](https://github.com/AlessioGr/payload-plugin-lexical) works similar to migrating from Slate.
-
-Instead of a `SlateToLexicalFeature` there is a `LexicalPluginToLexicalFeature` you can use. And instead of `convertSlateToLexical` you can use `convertLexicalPluginToLexical`.

docs/lexical/overview.mdx

@@ -1,179 +0,0 @@
----
-title: Lexical Overview
-label: Overview
-order: 10
-desc: Built by Meta, Lexical is an incredibly powerful rich text editor, and it works beautifully within Payload.
-keywords: lexical, rich text, editor, headless cms
----
-
-One of Payload's goals is to build the best rich text editor experience that we possibly can. We want to combine the beauty and polish of the Medium editing experience with the strength and features of the Notion editor - all in one place.
-
-Classically, we've used SlateJS to work toward this goal, but building custom elements into Slate has proven to be more difficult than we'd like, and we've been keeping our options open.
-
-<Banner type="warning">
-  Payload's Lexical rich text editor is currently in beta. It's stable enough to use as you build on
-  Payload, so if you're up for helping us fine-tune it, you should use it. But if you're looking for
-  stability, use Slate instead.
-</Banner>
-
-Lexical is extremely impressive and trivializes a lot of the hard parts of building new elements into a rich text editor. It has a few distinct advantages over Slate, including the following:
-
-1. A "/" menu, which allows editors to easily add new elements while never leaving their keyboard
-1. A "hover" toolbar that pops up if you select text
-1. It supports Payload blocks natively, directly within your rich text editor
-1. Custom elements, called "features", are much easier to build in Lexical vs. Slate
-
-To use the Lexical editor, first you need to install it:
-
-```
-npm install @payloadcms/richtext-lexical
-```
-
-Once you have it installed, you can pass it to your top-level Payload config as follows:
-
-```ts
-import { buildConfig } from 'payload/config'
-import { lexicalEditor } from '@payloadcms/richtext-lexical'
-
-export default buildConfig({
-  collections: [
-    // your collections here
-  ],
-  // Pass the Lexical editor to the root config
-  editor: lexicalEditor({}),
-})
-```
-
-You can also override Lexical settings on a field-by-field basis as follows:
-
-```ts
-import type { CollectionConfig } from 'payload/types'
-import { lexicalEditor } from '@payloadcms/richtext-lexical'
-
-export const Pages: CollectionConfig = {
-  slug: 'pages',
-  fields: [
-    {
-      name: 'content',
-      type: 'richText',
-      // Pass the Lexical editor here and override base settings as necessary
-      editor: lexicalEditor({}),
-    },
-  ],
-}
-```
-
-## Extending the lexical editor with Features
-
-Lexical has been designed with extensibility in mind. Whether you're aiming to introduce new functionalities or tweak the existing ones, Lexical makes it seamless for you to bring those changes to life.
-
-### Features: The Building Blocks
-
-At the heart of Lexical's customization potential are "features". While Lexical ships with a set of default features we believe are essential for most use cases, the true power lies in your ability to redefine, expand, or prune these as needed.
-
-If you remove all the default features, you're left with a blank editor. You can then add in only the features you need, or you can build your own custom features from scratch.
-
-### Integrating New Features
-
-To weave in your custom features, utilize the `features` prop when initializing the Lexical Editor. Here's a basic example of how this is done:
-
-```ts
-import {
-  BlocksFeature,
-  LinkFeature,
-  UploadFeature,
-  lexicalEditor,
-} from '@payloadcms/richtext-lexical'
-import { Banner } from '../blocks/Banner'
-import { CallToAction } from '../blocks/CallToAction'
-
-{
-  editor: lexicalEditor({
-    features: ({ defaultFeatures }) => [
-      ...defaultFeatures,
-      LinkFeature({
-        // Example showing how to customize the built-in fields
-        // of the Link feature
-        fields: ({ defaultFields }) => [
-          ...defaultFields,
-          {
-            name: 'rel',
-            label: 'Rel Attribute',
-            type: 'select',
-            hasMany: true,
-            options: ['noopener', 'noreferrer', 'nofollow'],
-            admin: {
-              description:
-                'The rel attribute defines the relationship between a linked resource and the current document. This is a custom link field.',
-            },
-          },
-        ],
-      }),
-      UploadFeature({
-        collections: {
-          uploads: {
-            // Example showing how to customize the built-in fields
-            // of the Upload feature
-            fields: [
-              {
-                name: 'caption',
-                type: 'richText',
-                editor: lexicalEditor(),
-              },
-            ],
-          },
-        },
-      }),
-      // This is incredibly powerful. You can re-use your Payload blocks
-      // directly in the Lexical editor as follows:
-      BlocksFeature({
-        blocks: [Banner, CallToAction],
-      }),
-    ],
-  })
-}
-```
-
-## Features overview
-
-Here's an overview of all the included features:
-
-| Feature Name                   | Included by default | Description                                                                                                                                                                            |
-|--------------------------------|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`BoldTextFeature`**          | Yes                 | Handles the bold text format                                                                                                                                                           |
-| **`ItalicTextFeature`**        | Yes                 | Handles the italic text format                                                                                                                                                         |
-| **`UnderlineTextFeature`**     | Yes                 | Handles the underline text format                                                                                                                                                      |
-| **`StrikethroughTextFeature`** | Yes                 | Handles the strikethrough text format                                                                                                                                                  |
-| **`SubscriptTextFeature`**     | Yes                 | Handles the subscript text format                                                                                                                                                      |
-| **`SuperscriptTextFeature`**   | Yes                 | Handles the superscript text format                                                                                                                                                    |
-| **`InlineCodeTextFeature`**    | Yes                 | Handles the inline-code text format                                                                                                                                                    |
-| **`ParagraphFeature`**         | Yes                 | Handles paragraphs. Since they are already a key feature of lexical itself, this Feature mainly handles the Slash and Add-Block menu entries for paragraphs                            |
-| **`HeadingFeature`**           | Yes                 | Adds Heading Nodes (by default, H1 - H6, but that can be customized)                                                                                                                   |
-| **`AlignFeature`**             | Yes                 | Allows you to align text left, centered and right                                                                                                                                      |
-| **`IndentFeature`**            | Yes                 | Allows you to indent text with the tab key                                                                                                                                             |
-| **`UnorderedListFeature`**     | Yes                 | Adds unordered lists (ul)                                                                                                                                                              |
-| **`OrderedListFeature`**       | Yes                 | Adds ordered lists (ol)                                                                                                                                                                |
-| **`CheckListFeature`**         | Yes                 | Adds checklists                                                                                                                                                                        |
-| **`LinkFeature`**              | Yes                 | Allows you to create internal and external links                                                                                                                                       |
-| **`RelationshipFeature`**      | Yes                 | Allows you to create block-level (not inline) relationships to other documents                                                                                                         |
-| **`BlockQuoteFeature`**        | Yes                 | Allows you to create block-level quotes                                                                                                                                                |
-| **`UploadFeature`**            | Yes                 | Allows you to create block-level upload nodes - this supports all kinds of uploads, not just images                                                                                    |
-| **`HorizontalRuleFeature`**    | Yes                 | Horizontal rules / separators. Basically displays an `<hr>` element                                                                                                                    |
-| **`InlineToolbarFeature`**     | Yes                 | The inline toolbar is the floating toolbar which appears when you select text. This toolbar only contains actions relevant for selected text                                           |
-| **`FixedToolbarFeature`**      | No                  | This classic toolbar is pinned to the top and always visible. Both inline and fixed toolbars can be enabled at the same time.                                                          |
-| **`BlocksFeature`**            | No                  | Allows you to use Payload's [Blocks Field](/docs/fields/blocks) directly inside your editor. In the feature props, you can specify the allowed blocks - just like in the Blocks field. |
-| **`TreeViewFeature`**          | No                  | Adds a debug box under the editor, which allows you to see the current editor state live, the dom, as well as time travel. Very useful for debugging                                   |
-
-Notice how even the toolbars are features? That's how extensible our lexical editor is - you could theoretically create your own toolbar if you wanted to!
-
-## Creating your own, custom Feature
-
-Creating your own custom feature requires deep knowledge of the Lexical editor. We recommend you take a look at the [Lexical documentation](https://lexical.dev/docs/intro) first - especially the "concepts" section.
-
-Next, take a look at the [features we've already built](https://github.com/payloadcms/payload/tree/main/packages/richtext-lexical/src/field/features) - understanding how they work will help you understand how to create your own. There is no difference between the features included by default and the ones you create yourself - since those features are all isolated from the "core", you have access to the same APIs, whether the feature is part of payload or not!
-
-## Coming Soon
-
-Lots more documentation will be coming soon, which will show in detail how to create your own custom features within Lexical.
-
-For now, take a look at the TypeScript interfaces and let us know if you need a hand. Much more will be coming from the Payload team on this topic soon.