fix(richtext-lexical): remove unused packages from package.json

.eslintignore

@@ -0,0 +1,14 @@
+.tmp
+**/.git
+**/.hg
+**/.pnp.*
+**/.svn
+**/.yarn/**
+**/build
+**/dist/**
+**/node_modules
+**/temp
+playwright.config.ts
+jest.config.js
+test/live-preview/next-app
+tsconfig.tsbuildinfo

.eslintrc.cjs

@@ -0,0 +1,72 @@
+/** @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,
+}

.git-blame-ignore-revs

@@ -19,12 +19,3 @@ fb7d1be2f3325d076b7c967b1730afcef37922c2
 
 # 3.0 prettier & lint everywhere
 6789e61488a1d3de56f472ac3214faf344030005
-
-# 3.0 prettier & lint everywhere again
-83fd4c66222d7846eeb5cc332dfa99bf1e830831
-
-# Upgrade to typescript-eslint v8, then prettier & lint everywhere
-86fdad0bb8ab27810599c8a32f3d8cba1341e1df
-
-# Prettier and lint remaining db packages
-7fd736ea5b2e9fc4ef936e9dc9e5e3d722f6d8bf

.github/CODEOWNERS

@@ -1,23 +1,24 @@
 # Order matters. The last matching pattern takes precedence.
-# Approvals are not required currently but may be enabled in the future.
 
 ### Package Exports ###
-/**/exports/ @denolfe @jmikrut @DanRibbens
+/**/exports/ @denolfe @jmikrut
 
 ### Packages ###
-/packages/plugin-cloud*/src/ @denolfe
-/packages/email-*/src/ @denolfe
-/packages/storage-*/src/ @denolfe
-/packages/create-payload-app/src/ @denolfe
-/packages/eslint-*/ @denolfe @AlessioGr
+/packages/richtext-*/ @AlessioGr
+/packages/plugin-cloud*/ @denolfe
+/packages/email-*/ @denolfe
+/packages/storage-*/ @denolfe
+/packages/create-payload-app/ @denolfe
+/packages/eslint-*/ @denolfe
 
 ### Templates ###
-/templates/_data/ @denolfe
-/templates/_template/ @denolfe
+/templates/ @jacobsfletch @denolfe
 
 ### Build Files ###
+/**/package.json @denolfe
 /tsconfig.json @denolfe
 /**/tsconfig*.json @denolfe
+
 /jest.config.js @denolfe
 /**/jest.config.js @denolfe
 
@@ -25,5 +26,5 @@
 /package.json @denolfe
 /scripts/ @denolfe
 /.husky/ @denolfe
-/.vscode/ @denolfe @AlessioGr
+/.vscode/ @denolfe
 /.github/ @denolfe

.github/ISSUE_TEMPLATE/1.bug_report.yml

@@ -1,11 +1,11 @@
-name: v2 Bug Report
-description: Report a bug for Payload v2. ONLY CRITICAL bugs will be fixed in v2.
-labels: ['status: needs-triage', 'v2']
+name: Bug Report
+description: Create a bug report for Payload
+labels: ['[possible-bug]']
 body:
   - type: markdown
     attributes:
       value: |
-        ONLY CRITICAL bugs will be fixed in v2.
+        *Note:* Feature requests should be opened as [discussions](https://github.com/payloadcms/payload/discussions/new?category=feature-requests-ideas).
   - type: input
     id: reproduction-link
     attributes:

.github/ISSUE_TEMPLATE/1.bug_report_v3.yml

@@ -1,76 +0,0 @@
-name: Functionality Bug
-description: '[REPRODUCTION REQUIRED] - Create a bug report'
-labels: ['status: needs-triage', 'v3', 'validate-reproduction']
-body:
-  - type: textarea
-    attributes:
-      label: Describe the Bug
-    validations:
-      required: true
-
-  - type: input
-    id: reproduction-link
-    attributes:
-      label: Link to the code that reproduces this issue
-      description: >-
-        _REQUIRED_: Please provide a link to your reproduction. Note, if the URL is invalid (404 or a private repository), we may close the issue.
-        Either use `npx create-payload-app@beta -t blank` then push to a repo or follow the [reproduction-guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md) for more information.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Reproduction Steps
-      description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue, based on the linked minimal reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
-    validations:
-      required: true
-
-  - type: dropdown
-    attributes:
-      label: Which area(s) are affected? (Select all that apply)
-      multiple: true
-      options:
-        - 'Not sure'
-        - 'area: core'
-        - 'area: docs'
-        - 'area: templates'
-        - 'area: ui'
-        - 'db-mongodb'
-        - 'db-postgres'
-        - 'db-sqlite'
-        - 'db-vercel-postgres'
-        - 'plugin: cloud'
-        - 'plugin: cloud-storage'
-        - 'plugin: form-builder'
-        - 'plugin: nested-docs'
-        - 'plugin: richtext-lexical'
-        - 'plugin: richtext-slate'
-        - 'plugin: search'
-        - 'plugin: sentry'
-        - 'plugin: seo'
-        - 'plugin: stripe'
-        - 'plugin: other'
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Environment Info
-      description: Paste output from `pnpm payload info` (>= beta.92) _or_ Payload, Node.js, and Next.js versions.
-      render: text
-      placeholder: |
-        Payload:
-        Node.js:
-        Next.js:
-    validations:
-      required: true
-
-  - type: markdown
-    attributes:
-      value: Before submitting the issue, go through the steps you've written down to make sure the steps provided are detailed and clear.
-  - type: markdown
-    attributes:
-      value: Contributors should be able to follow the steps provided in order to reproduce the bug.
-  - type: markdown
-    attributes:
-      value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!

.github/ISSUE_TEMPLATE/2.design_issue.yml

@@ -1,40 +0,0 @@
-name: Design Issue
-description: '[SCREENSHOT REQUIRED] - Create a design issue report'
-labels: ['status: needs-triage', 'v3', 'area: ui']
-body:
-  - type: textarea
-    attributes:
-      label: Describe the Bug.
-      description: >-
-        _REQUIRED:_ Please a screenshot/video of the issue along with a detailed description of the problem.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Reproduction Steps
-      description: Steps to reproduce the behavior, please provide a clear description of how to reproduce the issue, based on the linked minimal reproduction. Screenshots can be provided in the issue body below. If using code blocks, make sure that [syntax highlighting is correct](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks#syntax-highlighting) and double check that the rendered preview is not broken.
-    validations:
-      required: true
-
-  - type: textarea
-    attributes:
-      label: Environment Info
-      description: Paste output from `pnpm payload info` (>= beta.92) _or_ Payload, Node.js, and Next.js versions.
-      render: text
-      placeholder: |
-        Payload:
-        Node.js:
-        Next.js:
-    validations:
-      required: true
-
-  - type: markdown
-    attributes:
-      value: Before submitting the issue, go through the steps you've written down to make sure the steps provided are detailed and clear.
-  - type: markdown
-    attributes:
-      value: Contributors should be able to follow the steps provided in order to reproduce the bug.
-  - type: markdown
-    attributes:
-      value: These steps are used to add integration tests to ensure the same issue does not happen again. Thanks in advance!

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,23 +1,23 @@
-<!--
+## Description
 
-Thank you for the PR! Please go through the checklist below and make sure you've completed all the steps.
+<!-- Please include a summary of the pull request and any related issues it fixes. Please also include relevant motivation and context. -->
 
-Please review the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository if you haven't already.
+- [ ] I have read and understand the [CONTRIBUTING.md](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md) document in this repository.
 
-The following items will ensure that your PR is handled as smoothly as possible:
+## Type of change
 
-- PR Title must follow conventional commits format. For example, `feat: my new feature`, `fix(plugin-seo): my fix`.
-- Minimal description explained as if explained to someone not immediately familiar with the code.
-- Provide before/after screenshots or code diffs if applicable.
-- Link any related issues/discussions from GitHub or Discord.
-- Add review comments if necessary to explain to the reviewer the logic behind a change
+<!-- Please delete options that are not relevant. -->
 
-### What?
+- [ ] Chore (non-breaking change which does not add functionality)
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Change to the [templates](https://github.com/payloadcms/payload/tree/main/templates) directory (does not affect core functionality)
+- [ ] Change to the [examples](https://github.com/payloadcms/payload/tree/main/examples) directory (does not affect core functionality)
+- [ ] This change requires a documentation update
 
-### Why?
+## Checklist:
 
-### How?
-
-Fixes #
-
--->
+- [ ] I have added tests that prove my fix is effective or that my feature works
+- [ ] Existing test suite passes locally with my changes
+- [ ] I have made corresponding changes to the documentation

.github/actions/release-commenter/.eslintrc.js

@@ -1,13 +0,0 @@
-module.exports = {
-  env: {
-    es6: true,
-    node: true,
-  },
-  extends: ['eslint:recommended', 'plugin:@typescript-eslint/eslint-recommended'],
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    ecmaVersion: 2018,
-    sourceType: 'module',
-  },
-  plugins: ['@typescript-eslint'],
-}

.github/actions/release-commenter/README.md

@@ -1,74 +0,0 @@
-# Release Commenter
-
-This GitHub Action automatically comments on and/or labels Issues and PRs when a fix is released for them.
-
-> [!IMPORTANT]
-> 🔧 Heavily modified version of https://github.com/apexskier/github-release-commenter
-
-## Fork Modifications
-
-- Filters to closed PRs only
-- Adds tag filter to support non-linear releases
-- Better logging
-- Moved to pnpm
-- Uses @vercel/ncc for packaging
-- Comments on locked issues by unlocking then re-locking
-
-## How it works
-
-Use this action in a workflow [triggered by a release](https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#release). It will scan commits between that and the prior release, find associated Issues and PRs, and comment on them to let people know a release has been made. Associated Issues and PRs can be directly [linked](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue) to the commit or manually linked from a PR associated with the commit.
-
-## Inputs
-
-**GITHUB_TOKEN**
-
-A GitHub personal access token with repo scope, such as [`secrets.GITHUB_TOKEN`](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#about-the-github_token-secret).
-
-**comment-template** (optional)
-
-Override the comment posted on Issues and PRs. Set to the empty string to disable commenting. Several variables strings will be automatically replaced:
-
-- `{release_link}` - a markdown link to the release
-- `{release_name}` - the release's name
-- `{release_tag}` - the release's tag
-
-**label-template** (optional)
-
-Add the given label. Multiple labels can be separated by commas. Several variable strings will be automatically replaced:
-
-- `{release_name}` - the release's name
-- `{release_tag}` - the release's tag
-
-**skip-label** (optional)
-
-Skip processing if any of the given labels are present. Same processing rules as **label-template**. Default is "dependencies".
-
-## Example
-
-```yml
-on:
-  release:
-    types: [published]
-
-jobs:
-  release:
-    steps:
-      - uses: apexskier/github-release-commenter@v1
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          comment-template: |
-            Release {release_link} addresses this.
-```
-
-## Known limitations
-
-These are some known limitations of this action. I'd like to try to address them in the future.
-
-- Non-linear releases aren't supported. For example, releasing a patch to a prior major release after a new major release has been bumped.
-- Non-sequential releases aren't supported. For example, if you release multiple prereleases between two official releases, this will only create a comment for the first prerelease in which a fix is released, not the final release.
-- The first release for a project will be ignored. This is intentional, as the use case is unlikely. Most projects will either have several alphas that don't need release comments, or won't use issues/PRs for the first commit.
-- If a large number of things are commented on, you may see the error `Error: You have triggered an abuse detection mechanism. Please wait a few minutes before you try again.`. Consider using the `skip-label` input to reduce your load on the GitHub API.
-
-## Versions
-
-Workflows will automatically update the tags `v1` and `latest`, allowing you to reference one of those instead of locking to a specific release.

.github/actions/release-commenter/action.yml

@@ -1,32 +0,0 @@
-name: Release Commenter
-description: Comment on PRs and Issues when a fix is released
-branding:
-  icon: message-square
-  color: blue
-inputs:
-  GITHUB_TOKEN:
-    description: |
-      A GitHub personal access token with repo scope, such as
-      secrets.GITHUB_TOKEN.
-    required: true
-  comment-template:
-    description: |
-      Text template for the comment string.
-    required: false
-    default: |
-      Included in release {release_link}
-  label-template:
-    description: Add the given label. Multiple labels can be separated by commas.
-    required: false
-  skip-label:
-    description: Skip commenting if any of the given label are present. Multiple labels can be separated by commas.
-    required: false
-    default: 'dependencies'
-  tag-filter:
-    description: |
-      Filter tags by a regular expression. Must be escaped. e.g. 'v\\d' to isolate tags between major versions.
-    required: false
-    default: null
-runs:
-  using: node20
-  main: dist/index.js

.github/actions/release-commenter/jest.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  testEnvironment: 'node',
-  testPathIgnorePatterns: ['/node_modules/', '<rootDir>/dist/'],
-  transform: {
-    '^.+\\.(t|j)sx?$': ['@swc/jest'],
-  },
-}

.github/actions/release-commenter/package.json

@@ -1,34 +0,0 @@
-{
-  "name": "release-commenter",
-  "version": "0.0.0",
-  "private": true,
-  "description": "GitHub Action to automatically comment on PRs and Issues when a fix is released.",
-  "license": "MIT",
-  "main": "dist/index.js",
-  "scripts": {
-    "build": "pnpm build:typecheck && pnpm build:ncc",
-    "build:ncc": "ncc build src/index.ts -t -o dist",
-    "build:typecheck": "tsc",
-    "clean": "rimraf dist",
-    "test": "jest"
-  },
-  "dependencies": {
-    "@actions/core": "^1.3.0",
-    "@actions/github": "^5.0.0"
-  },
-  "devDependencies": {
-    "@octokit/webhooks-types": "^7.5.1",
-    "@swc/jest": "^0.2.36",
-    "@types/jest": "^27.5.2",
-    "@types/node": "^20.16.5",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "@vercel/ncc": "0.38.1",
-    "concurrently": "^8.2.2",
-    "eslint": "^7.32.0",
-    "jest": "^29.7.0",
-    "prettier": "^3.3.3",
-    "ts-jest": "^26.5.6",
-    "typescript": "^4.9.5"
-  }
-}

.github/actions/release-commenter/src/__snapshots__/index.test.ts.snap

@@ -1,266 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`tests feature tests can apply labels 1`] = `
-[
-  [
-    {
-      "issue_number": 123,
-      "labels": [
-        ":dart: landed",
-        "release-current_tag_name",
-        "Release Name",
-      ],
-    },
-  ],
-  [
-    {
-      "issue_number": 7,
-      "labels": [
-        ":dart: landed",
-        "release-current_tag_name",
-        "Release Name",
-      ],
-    },
-  ],
-]
-`;
-
-exports[`tests main test 1`] = `
-{
-  "graphql": [MockFunction] {
-    "calls": [
-      [
-        "
-            {
-              resource(url: "http://repository/commit/SHA1") {
-                ... on Commit {
-                  messageHeadlineHTML
-                  messageBodyHTML
-                  associatedPullRequests(first: 10) {
-                    pageInfo {
-                      hasNextPage
-                    }
-                    edges {
-                      node {
-                        bodyHTML
-                        number
-                        state
-                        labels(first: 10) {
-                          pageInfo {
-                            hasNextPage
-                          }
-                          nodes {
-                            name
-                          }
-                        }
-                        timelineItems(itemTypes: [CONNECTED_EVENT, DISCONNECTED_EVENT], first: 100) {
-                          pageInfo {
-                            hasNextPage
-                          }
-                          nodes {
-                            ... on ConnectedEvent {
-                              __typename
-                              isCrossRepository
-                              subject {
-                                ... on Issue {
-                                  number
-                                }
-                              }
-                            }
-                            ... on DisconnectedEvent {
-                              __typename
-                              isCrossRepository
-                              subject {
-                                ... on Issue {
-                                  number
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          ",
-      ],
-      [
-        "
-            {
-              resource(url: "http://repository/commit/SHA2") {
-                ... on Commit {
-                  messageHeadlineHTML
-                  messageBodyHTML
-                  associatedPullRequests(first: 10) {
-                    pageInfo {
-                      hasNextPage
-                    }
-                    edges {
-                      node {
-                        bodyHTML
-                        number
-                        state
-                        labels(first: 10) {
-                          pageInfo {
-                            hasNextPage
-                          }
-                          nodes {
-                            name
-                          }
-                        }
-                        timelineItems(itemTypes: [CONNECTED_EVENT, DISCONNECTED_EVENT], first: 100) {
-                          pageInfo {
-                            hasNextPage
-                          }
-                          nodes {
-                            ... on ConnectedEvent {
-                              __typename
-                              isCrossRepository
-                              subject {
-                                ... on Issue {
-                                  number
-                                }
-                              }
-                            }
-                            ... on DisconnectedEvent {
-                              __typename
-                              isCrossRepository
-                              subject {
-                                ... on Issue {
-                                  number
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          ",
-      ],
-    ],
-    "results": [
-      {
-        "type": "return",
-        "value": Promise {},
-      },
-      {
-        "type": "return",
-        "value": Promise {},
-      },
-    ],
-  },
-  "rest": {
-    "issues": {
-      "addLabels": [MockFunction],
-      "createComment": [MockFunction] {
-        "calls": [
-          [
-            {
-              "body": "Included in release [current_tag_name](http://current_release). Replacements: current_tag_name, current_tag_name.",
-              "issue_number": 3,
-            },
-          ],
-          [
-            {
-              "body": "Included in release [current_tag_name](http://current_release). Replacements: current_tag_name, current_tag_name.",
-              "issue_number": 123,
-            },
-          ],
-          [
-            {
-              "body": "Included in release [current_tag_name](http://current_release). Replacements: current_tag_name, current_tag_name.",
-              "issue_number": 7,
-            },
-          ],
-        ],
-        "results": [
-          {
-            "type": "return",
-            "value": Promise {},
-          },
-          {
-            "type": "return",
-            "value": Promise {},
-          },
-          {
-            "type": "return",
-            "value": Promise {},
-          },
-        ],
-      },
-      "get": [MockFunction] {
-        "calls": [
-          [
-            {
-              "issue_number": 3,
-            },
-          ],
-          [
-            {
-              "issue_number": 123,
-            },
-          ],
-          [
-            {
-              "issue_number": 7,
-            },
-          ],
-        ],
-        "results": [
-          {
-            "type": "return",
-            "value": Promise {},
-          },
-          {
-            "type": "return",
-            "value": Promise {},
-          },
-          {
-            "type": "return",
-            "value": Promise {},
-          },
-        ],
-      },
-    },
-    "repos": {
-      "compareCommits": [MockFunction] {
-        "calls": [
-          [
-            {
-              "base": "prior_tag_name",
-              "head": "current_tag_name",
-            },
-          ],
-        ],
-        "results": [
-          {
-            "type": "return",
-            "value": Promise {},
-          },
-        ],
-      },
-      "listReleases": [MockFunction] {
-        "calls": [
-          [
-            {
-              "per_page": 100,
-            },
-          ],
-        ],
-        "results": [
-          {
-            "type": "return",
-            "value": Promise {},
-          },
-        ],
-      },
-    },
-  },
-}
-`;

.github/actions/release-commenter/src/index.test.ts

@@ -1,399 +0,0 @@
-import type * as githubModule from '@actions/github'
-import type * as coreModule from '@actions/core'
-import { mock } from 'node:test'
-
-jest.mock('@actions/core')
-jest.mock('@actions/github')
-
-type Mocked<T> = {
-  -readonly [P in keyof T]: T[P] extends Function ? jest.Mock<T[P]> : jest.Mocked<Partial<T[P]>>
-}
-
-const github = require('@actions/github') as jest.Mocked<Mocked<typeof githubModule>>
-const core = require('@actions/core') as jest.Mocked<Mocked<typeof coreModule>>
-
-describe('tests', () => {
-  let mockOctokit: any = {}
-  let currentTag: string = 'current_tag_name'
-
-  ;(core.warning as any) = jest.fn(console.warn.bind(console))
-  ;(core.error as any) = jest.fn(console.error.bind(console))
-
-  let commentTempate: string = ''
-  let labelTemplate: string | null = null
-  const skipLabelTemplate: string | null = 'skip,test'
-  let tagFilter: string | RegExp | null = null
-
-  let simpleMockOctokit: any = {}
-
-  beforeEach(() => {
-    tagFilter = null
-    currentTag = 'current_tag_name'
-    ;(github.context as any) = {
-      payload: {
-        repo: {
-          owner: 'owner',
-          repo: 'repo',
-        },
-        release: {
-          tag_name: currentTag,
-        },
-        repository: { html_url: 'http://repository' },
-      },
-    }
-
-    github.getOctokit.mockReset().mockImplementationOnce(((token: string) => {
-      expect(token).toBe('GITHUB_TOKEN_VALUE')
-      return mockOctokit
-    }) as any)
-    ;(core.getInput as any).mockImplementation((key: string) => {
-      if (key == 'GITHUB_TOKEN') {
-        return 'GITHUB_TOKEN_VALUE'
-      }
-      if (key == 'comment-template') {
-        return commentTempate
-      }
-      if (key == 'label-template') {
-        return labelTemplate
-      }
-      if (key == 'skip-label') {
-        return skipLabelTemplate
-      }
-      if (key == 'tag-filter') {
-        return tagFilter
-      }
-      fail(`Unexpected input key ${key}`)
-    })
-
-    commentTempate =
-      'Included in release {release_link}. Replacements: {release_name}, {release_tag}.'
-    labelTemplate = null
-    simpleMockOctokit = {
-      rest: {
-        issues: {
-          get: jest.fn(() => Promise.resolve({ data: { locked: false } })),
-          createComment: jest.fn(() => Promise.resolve()),
-          addLabels: jest.fn(() => Promise.resolve()),
-        },
-        repos: {
-          listReleases: jest.fn(() =>
-            Promise.resolve({
-              data: [
-                {
-                  name: 'Release Name',
-                  tag_name: 'current_tag_name',
-                  html_url: 'http://current_release',
-                },
-                {
-                  tag_name: 'prior_tag_name',
-                  html_url: 'http://prior_release',
-                },
-              ],
-            }),
-          ),
-          compareCommits: jest.fn(() =>
-            Promise.resolve({
-              data: { commits: [{ sha: 'SHA1' }] },
-            }),
-          ),
-        },
-      },
-      graphql: jest.fn(() =>
-        Promise.resolve({
-          resource: {
-            messageHeadlineHTML: '',
-            messageBodyHTML:
-              '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #123.">Closes</span> <p><span class="issue-keyword tooltipped tooltipped-se" aria-label="This pull request closes issue #7.">Closes</span>',
-            associatedPullRequests: {
-              pageInfo: { hasNextPage: false },
-              edges: [],
-            },
-          },
-        }),
-      ),
-    }
-  })
-
-  afterEach(() => {
-    expect(core.error).not.toHaveBeenCalled()
-    expect(core.warning).not.toHaveBeenCalled()
-    expect(core.setFailed).not.toHaveBeenCalled()
-  })
-
-  test('main test', async () => {
-    mockOctokit = {
-      ...simpleMockOctokit,
-      rest: {
-        issues: {
-          get: jest.fn(() => Promise.resolve({ data: { locked: false } })),
-          createComment: jest.fn(() => Promise.resolve()),
-          addLabels: jest.fn(() => Promise.resolve()),
-        },
-        repos: {
-          listReleases: jest.fn(() =>
-            Promise.resolve({
-              data: [
-                {
-                  tag_name: 'current_tag_name',
-                  html_url: 'http://current_release',
-                },
-                {
-                  tag_name: 'prior_tag_name',
-                  html_url: 'http://prior_release',
-                },
-              ],
-            }),
-          ),
-          compareCommits: jest.fn(() =>
-            Promise.resolve({
-              data: { commits: [{ sha: 'SHA1' }, { sha: 'SHA2' }] },
-            }),
-          ),
-        },
-      },
-      graphql: jest.fn(() =>
-        Promise.resolve({
-          resource: {
-            messageHeadlineHTML:
-              '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #3.">Closes</span> <a class="issue-link js-issue-link" data-error-text="Failed to load title" data-id="718013420" data-permission-text="Title is private" data-url="https://github.com/apexskier/github-release-commenter/issues/1" data-hovercard-type="issue" data-hovercard-url="/apexskier/github-release-commenter/issues/1/hovercard" href="https://github.com/apexskier/github-release-commenter/issues/1">#1</a>',
-            messageBodyHTML:
-              '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #123.">Closes</span> <p><span class="issue-keyword tooltipped tooltipped-se" aria-label="This pull request closes issue #7.">Closes</span>',
-            associatedPullRequests: {
-              pageInfo: { hasNextPage: false },
-              edges: [
-                {
-                  node: {
-                    bodyHTML:
-                      '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #4.">Closes</span> <span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #5.">Closes</span>',
-                    number: 9,
-                    labels: {
-                      pageInfo: { hasNextPage: false },
-                      nodes: [{ name: 'label1' }, { name: 'label2' }],
-                    },
-                    timelineItems: {
-                      pageInfo: { hasNextPage: false },
-                      nodes: [
-                        {
-                          isCrossRepository: true,
-                          __typename: 'ConnectedEvent',
-                          subject: { number: 1 },
-                        },
-                        {
-                          isCrossRepository: false,
-                          __typename: 'ConnectedEvent',
-                          subject: { number: 2 },
-                        },
-                        {
-                          isCrossRepository: false,
-                          __typename: 'DisconnectedEvent',
-                          subject: { number: 2 },
-                        },
-                        {
-                          isCrossRepository: false,
-                          __typename: 'ConnectedEvent',
-                          subject: { number: 2 },
-                        },
-                      ],
-                    },
-                  },
-                },
-                {
-                  node: {
-                    bodyHTML: '',
-                    number: 42,
-                    labels: {
-                      pageInfo: { hasNextPage: false },
-                      nodes: [{ name: 'label1' }, { name: 'skip' }],
-                    },
-                    timelineItems: {
-                      pageInfo: { hasNextPage: false },
-                      nodes: [
-                        {
-                          isCrossRepository: true,
-                          __typename: 'ConnectedEvent',
-                          subject: { number: 82 },
-                        },
-                      ],
-                    },
-                  },
-                },
-              ],
-            },
-          },
-        }),
-      ),
-    }
-
-    jest.isolateModules(() => {
-      require('./index')
-    })
-
-    await new Promise<void>(setImmediate)
-
-    expect(mockOctokit).toMatchSnapshot()
-    expect(mockOctokit.rest.issues.createComment).toHaveBeenCalledTimes(3)
-  })
-
-  describe('can filter tags', () => {
-    const v3prev = 'v3.0.1'
-    const v3current = 'v3.0.2'
-    const v2prev = 'v2.0.1'
-    const v2current = 'v2.0.2'
-
-    const listReleasesData = [
-      {
-        name: 'Current Release Name',
-        tag_name: v3current,
-        html_url: 'http://v3.0.2',
-      },
-      {
-        name: 'Prev Release Name',
-        tag_name: v3prev,
-        html_url: 'http://v3.0.1',
-      },
-      {
-        name: 'v2 Current Release Name',
-        tag_name: v2current,
-        html_url: 'http://v2.0.2',
-      },
-      {
-        name: 'v2 Prev Release Name',
-        tag_name: v2prev,
-        html_url: 'http://v2.0.1',
-      },
-    ]
-
-    it.each`
-      description    | prevTag   | currentTag   | filter
-      ${'no filter'} | ${v3prev} | ${v3current} | ${null}
-      ${'v3'}        | ${v3prev} | ${v3current} | ${'v\\d'}
-      ${'v2'}        | ${v2prev} | ${v2current} | ${'v\\d'}
-    `('should filter tags with $description', async ({ prevTag, currentTag, filter }) => {
-      // @ts-ignore
-      github.context.payload.release.tag_name = currentTag
-
-      tagFilter = filter
-
-      mockOctokit = {
-        ...simpleMockOctokit,
-        rest: {
-          issues: {
-            get: jest.fn(() => Promise.resolve({ data: { locked: false } })),
-            createComment: jest.fn(() => Promise.resolve()),
-            addLabels: jest.fn(() => Promise.resolve()),
-          },
-          repos: {
-            listReleases: jest.fn(() =>
-              Promise.resolve({
-                data: listReleasesData,
-              }),
-            ),
-            compareCommits: jest.fn(() =>
-              Promise.resolve({
-                data: { commits: [{ sha: 'SHA1' }] },
-              }),
-            ),
-          },
-        },
-        graphql: jest.fn(() =>
-          Promise.resolve({
-            resource: {
-              messageHeadlineHTML: '',
-              messageBodyHTML:
-                '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #123.">Closes</span> <p><span class="issue-keyword tooltipped tooltipped-se" aria-label="This pull request closes issue #7.">Closes</span>',
-              associatedPullRequests: {
-                pageInfo: { hasNextPage: false },
-                edges: [],
-              },
-            },
-          }),
-        ),
-      }
-
-      jest.isolateModules(() => {
-        require('./index')
-      })
-
-      await new Promise<void>((resolve) => setImmediate(() => resolve()))
-
-      expect(github.getOctokit).toHaveBeenCalled()
-      expect(mockOctokit.rest.repos.compareCommits.mock.calls).toEqual([
-        [{ base: prevTag, head: currentTag }],
-      ])
-    })
-  })
-
-  describe('feature tests', () => {
-    beforeEach(() => {
-      mockOctokit = simpleMockOctokit
-    })
-
-    it('can disable comments', async () => {
-      commentTempate = ''
-
-      jest.isolateModules(() => {
-        require('./index')
-      })
-
-      await new Promise<void>((resolve) => setImmediate(() => resolve()))
-
-      expect(github.getOctokit).toHaveBeenCalled()
-      expect(mockOctokit.rest.issues.createComment).not.toHaveBeenCalled()
-    })
-
-    it('should unlock and comment', async () => {
-      mockOctokit = {
-        ...simpleMockOctokit,
-        rest: {
-          ...simpleMockOctokit.rest,
-          issues: {
-            // Return locked for both issues to be commented on
-            get: jest.fn(() => Promise.resolve({ data: { locked: true } })),
-            lock: jest.fn(() => Promise.resolve()),
-            unlock: jest.fn(() => Promise.resolve()),
-            createComment: jest.fn(() => Promise.resolve()),
-          },
-        },
-        graphql: jest.fn(() =>
-          Promise.resolve({
-            resource: {
-              messageHeadlineHTML: '',
-              messageBodyHTML:
-                '<span class="issue-keyword tooltipped tooltipped-se" aria-label="This commit closes issue #123.">Closes</span> <p><span class="issue-keyword tooltipped tooltipped-se" aria-label="This pull request closes issue #7.">Closes</span>',
-              associatedPullRequests: {
-                pageInfo: { hasNextPage: false },
-                edges: [],
-              },
-            },
-          }),
-        ),
-      }
-
-      jest.isolateModules(() => {
-        require('./index')
-      })
-
-      await new Promise<void>((resolve) => setImmediate(() => resolve()))
-
-      expect(github.getOctokit).toHaveBeenCalled()
-
-      // Should call once for both linked issues
-      expect(mockOctokit.rest.issues.unlock).toHaveBeenCalledTimes(2)
-      expect(mockOctokit.rest.issues.createComment).toHaveBeenCalledTimes(2)
-      expect(mockOctokit.rest.issues.lock).toHaveBeenCalledTimes(2)
-    })
-
-    it.skip('can apply labels', async () => {
-      labelTemplate = ':dart: landed,release-{release_tag},{release_name}'
-
-      jest.isolateModules(() => {
-        require('./index')
-      })
-
-      await new Promise<void>((resolve) => setImmediate(() => resolve()))
-
-      expect(github.getOctokit).toHaveBeenCalled()
-      expect(mockOctokit.rest.issues.addLabels.mock.calls).toMatchSnapshot()
-    })
-  })
-})

.github/actions/release-commenter/src/index.ts

@@ -1,349 +0,0 @@
-import * as core from '@actions/core'
-import * as github from '@actions/github'
-import type * as Webhooks from '@octokit/webhooks-types'
-
-const closesMatcher = /aria-label="This (?:commit|pull request) closes issue #(\d+)\."/g
-
-const releaseLinkTemplateRegex = /{release_link}/g
-const releaseNameTemplateRegex = /{release_name}/g
-const releaseTagTemplateRegex = /{release_tag}/g
-
-;(async function main() {
-  try {
-    const payload = github.context.payload as Webhooks.EventPayloadMap['release']
-
-    const githubToken = core.getInput('GITHUB_TOKEN')
-    const tagFilter = core.getInput('tag-filter') || undefined // Accept tag filter as an input
-    const octokit = github.getOctokit(githubToken)
-
-    const commentTemplate = core.getInput('comment-template')
-    const labelTemplate = core.getInput('label-template') || null
-    const skipLabelTemplate = core.getInput('skip-label') || null
-
-    // Fetch the releases with the optional tag filter applied
-    const { data: rawReleases } = await octokit.rest.repos.listReleases({
-      ...github.context.repo,
-      per_page: 100,
-    })
-
-    // Get the current release tag or latest tag
-    const currentTag = payload?.release?.tag_name || rawReleases?.[0]?.tag_name
-
-    let releases = rawReleases
-
-    // Filter releases by the tag filter if provided
-    if (tagFilter) {
-      core.info(`Filtering releases by tag filter: ${tagFilter}`)
-      // Get the matching part of the current release tag
-      const regexMatch = currentTag.match(tagFilter)?.[0]
-      if (!regexMatch) {
-        core.error(`Current release tag ${currentTag} does not match the tag filter ${tagFilter}`)
-        return
-      }
-
-      core.info(`Matched string from filter: ${regexMatch}`)
-
-      releases = releases
-        .filter((release) => {
-          const match = release.tag_name.match(regexMatch)?.[0]
-          return match
-        })
-        .slice(0, 2)
-    }
-
-    core.info(`Releases: ${JSON.stringify(releases, null, 2)}`)
-
-    if (releases.length < 2) {
-      if (!releases.length) {
-        core.error(`No releases found with the provided tag filter: '${tagFilter}'`)
-        return
-      }
-
-      core.info('first release')
-      return
-    }
-
-    const [currentRelease, priorRelease] = releases
-
-    core.info(`${priorRelease.tag_name}...${currentRelease.tag_name}`)
-
-    const {
-      data: { commits },
-    } = await octokit.rest.repos.compareCommits({
-      ...github.context.repo,
-      base: priorRelease.tag_name,
-      head: currentRelease.tag_name,
-    })
-
-    if (!currentRelease.name) {
-      core.info('Current release has no name, will fall back to the tag name.')
-    }
-    const releaseLabel = currentRelease.name || currentRelease.tag_name
-
-    const comment = commentTemplate
-      .trim()
-      .split(releaseLinkTemplateRegex)
-      .join(`[${releaseLabel}](${currentRelease.html_url})`)
-      .split(releaseNameTemplateRegex)
-      .join(releaseLabel)
-      .split(releaseTagTemplateRegex)
-      .join(currentRelease.tag_name)
-
-    const parseLabels = (rawInput: string | null) =>
-      rawInput
-        ?.split(releaseNameTemplateRegex)
-        .join(releaseLabel)
-        ?.split(releaseTagTemplateRegex)
-        .join(currentRelease.tag_name)
-        ?.split(',')
-        ?.map((l) => l.trim())
-        .filter((l) => l)
-
-    const labels = parseLabels(labelTemplate)
-    const skipLabels = parseLabels(skipLabelTemplate)
-
-    const linkedIssuesPrs = new Set<number>()
-
-    await Promise.all(
-      commits.map((commit) =>
-        (async () => {
-          const query = `
-            {
-              resource(url: "${payload.repository.html_url}/commit/${commit.sha}") {
-                ... on Commit {
-                  messageHeadlineHTML
-                  messageBodyHTML
-                  associatedPullRequests(first: 10) {
-                    pageInfo {
-                      hasNextPage
-                    }
-                    edges {
-                      node {
-                        bodyHTML
-                        number
-                        state
-                        labels(first: 10) {
-                          pageInfo {
-                            hasNextPage
-                          }
-                          nodes {
-                            name
-                          }
-                        }
-                        timelineItems(itemTypes: [CONNECTED_EVENT, DISCONNECTED_EVENT], first: 100) {
-                          pageInfo {
-                            hasNextPage
-                          }
-                          nodes {
-                            ... on ConnectedEvent {
-                              __typename
-                              isCrossRepository
-                              subject {
-                                ... on Issue {
-                                  number
-                                }
-                              }
-                            }
-                            ... on DisconnectedEvent {
-                              __typename
-                              isCrossRepository
-                              subject {
-                                ... on Issue {
-                                  number
-                                }
-                              }
-                            }
-                          }
-                        }
-                      }
-                    }
-                  }
-                }
-              }
-            }
-          `
-          const response: {
-            resource: null | {
-              messageHeadlineHTML: string
-              messageBodyHTML: string
-              associatedPullRequests: {
-                pageInfo: { hasNextPage: boolean }
-                edges: ReadonlyArray<{
-                  node: {
-                    bodyHTML: string
-                    number: number
-                    state: 'OPEN' | 'CLOSED' | 'MERGED'
-                    labels: {
-                      pageInfo: { hasNextPage: boolean }
-                      nodes: ReadonlyArray<{
-                        name: string
-                      }>
-                    }
-                    timelineItems: {
-                      pageInfo: { hasNextPage: boolean }
-                      nodes: ReadonlyArray<{
-                        __typename: 'ConnectedEvent' | 'DisconnectedEvent'
-                        isCrossRepository: boolean
-                        subject: {
-                          number: number
-                        }
-                      }>
-                    }
-                  }
-                }>
-              }
-            }
-          } = await octokit.graphql(query)
-
-          if (!response.resource) {
-            return
-          }
-
-          // core.info(JSON.stringify(response.resource, null, 2))
-
-          core.info(`Checking commit: ${payload.repository.html_url}/commit/${commit.sha}`)
-
-          const associatedClosedPREdges = response.resource.associatedPullRequests.edges.filter(
-            (e) => e.node.state === 'MERGED',
-          )
-
-          if (associatedClosedPREdges.length) {
-            core.info(
-              `  Associated Merged PRs:\n    ${associatedClosedPREdges.map((pr) => `${payload.repository.html_url}/pull/${pr.node.number}`).join('\n    ')}`,
-            )
-          } else {
-            core.info('  No associated merged PRs')
-          }
-
-          const html = [
-            response.resource.messageHeadlineHTML,
-            response.resource.messageBodyHTML,
-            ...associatedClosedPREdges.map((pr) => pr.node.bodyHTML),
-          ].join(' ')
-
-          for (const match of html.matchAll(closesMatcher)) {
-            const [, num] = match
-            linkedIssuesPrs.add(parseInt(num, 10))
-            core.info(
-              `  Linked issue/PR from closesMatcher: ${payload.repository.html_url}/pull/${num}`,
-            )
-          }
-
-          if (response.resource.associatedPullRequests.pageInfo.hasNextPage) {
-            core.warning(`Too many PRs associated with ${commit.sha}`)
-          }
-
-          const seen = new Set<number>()
-          for (const associatedPR of associatedClosedPREdges) {
-            if (associatedPR.node.timelineItems.pageInfo.hasNextPage) {
-              core.warning(`Too many links for #${associatedPR.node.number}`)
-            }
-            if (associatedPR.node.labels.pageInfo.hasNextPage) {
-              core.warning(`Too many labels for #${associatedPR.node.number}`)
-            }
-            // a skip labels is present on this PR
-            if (
-              skipLabels?.some((l) => associatedPR.node.labels.nodes.some(({ name }) => name === l))
-            ) {
-              continue
-            }
-
-            linkedIssuesPrs.add(associatedPR.node.number)
-            core.info(
-              `  Linked issue/PR from associated PR: ${payload.repository.html_url}/pull/${associatedPR.node.number}`,
-            )
-
-            // These are sorted by creation date in ascending order. The latest event for a given issue/PR is all we need
-            // ignore links that aren't part of this repo
-            const links = associatedPR.node.timelineItems.nodes
-              .filter((node) => !node.isCrossRepository)
-              .reverse()
-            for (const link of links) {
-              if (seen.has(link.subject.number)) {
-                continue
-              }
-              if (link.__typename == 'ConnectedEvent') {
-                linkedIssuesPrs.add(link.subject.number)
-                core.info(
-                  `Linked issue/PR from connected event: ${payload.repository.html_url}/pull/${link.subject.number}`,
-                )
-              }
-              seen.add(link.subject.number)
-            }
-          }
-        })(),
-      ),
-    )
-
-    core.info(
-      `Final issues/PRs to be commented on: \n${Array.from(linkedIssuesPrs)
-        .map((num) => `  ${payload.repository.html_url}/pull/${num}`)
-        .join('\n')}`,
-    )
-
-    const requests: Array<Promise<unknown>> = []
-    for (const issueNumber of linkedIssuesPrs) {
-      const baseRequest = {
-        ...github.context.repo,
-        issue_number: issueNumber,
-      }
-      if (comment) {
-        const commentRequest = {
-          ...baseRequest,
-          body: comment,
-        }
-
-        // Check if issue is locked or not
-        const { data: issue } = await octokit.rest.issues.get(baseRequest)
-
-        let createCommentPromise: () => Promise<void>
-        if (!issue.locked) {
-          createCommentPromise = async () => {
-            try {
-              await octokit.rest.issues.createComment(commentRequest)
-            } catch (error) {
-              core.error(error as Error)
-              core.error(
-                `Failed to comment on issue/PR: ${issueNumber}. ${payload.repository.html_url}/pull/${issueNumber}`,
-              )
-            }
-          }
-        } else {
-          core.info(
-            `Issue/PR is locked: ${issueNumber}. Unlocking, commenting, and re-locking. ${payload.repository.html_url}/pull/${issueNumber}`,
-          )
-          createCommentPromise = async () => {
-            try {
-              core.debug(`Unlocking issue/PR: ${issueNumber}`)
-              await octokit.rest.issues.unlock(baseRequest)
-              core.debug(`Commenting on issue/PR: ${issueNumber}`)
-              await octokit.rest.issues.createComment(commentRequest)
-              core.debug(`Re-locking issue/PR: ${issueNumber}`)
-              await octokit.rest.issues.lock(baseRequest)
-            } catch (error) {
-              core.error(error as Error)
-              core.error(
-                `Failed to unlock, comment, and re-lock issue/PR: ${issueNumber}. ${payload.repository.html_url}/pull/${issueNumber}`,
-              )
-            }
-          }
-        }
-
-        requests.push(createCommentPromise())
-      }
-      if (labels) {
-        const request = {
-          ...baseRequest,
-          labels,
-        }
-        // core.info(JSON.stringify(request, null, 2))
-        requests.push(octokit.rest.issues.addLabels(request))
-      }
-    }
-
-    await Promise.all(requests)
-  } catch (error) {
-    core.error(error as Error)
-    core.setFailed((error as Error).message)
-  }
-})()

.github/actions/release-commenter/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "lib": ["es2020.string"],
-    "noEmit": true,
-    "strict": true,
-    "noUnusedLocals": true,
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "forceConsistentCasingInFileNames": true,
-    "downlevelIteration": true,
-    "skipLibCheck": true,
-  },
-  "exclude": ["src/**/*.test.ts"]
-}

.github/actions/setup/action.yml

@@ -5,11 +5,11 @@ inputs:
   node-version:
     description: 'The Node.js version to use'
     required: true
-    default: 22.6.2
+    default: 18.20.2
   pnpm-version:
     description: 'The pnpm version to use'
     required: true
-    default: 9.7.1
+    default: 8.15.7
 
 runs:
   using: composite
@@ -25,7 +25,7 @@ runs:
         node-version: ${{ inputs.node-version }}
 
     - name: Install pnpm
-      uses: pnpm/action-setup@v4
+      uses: pnpm/action-setup@v3
       with:
         version: ${{ inputs.pnpm-version }}
         run_install: false

.github/actions/triage/LICENSE

@@ -1,22 +0,0 @@
-MIT License
-
-Copyright (c) 2024 Payload <info@payloadcms.com>. All modification and additions are copyright of Payload.
-
----
-
-Original license:
-ISC License
-
-Copyright (c) 2023, Balázs Orbán
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

.github/actions/triage/README.md

@@ -1,21 +0,0 @@
-# Triage
-
-Modified version of https://github.com/balazsorban44/nissuer
-
-## Modifications
-
-- Port to TypeScript
-- Remove issue locking
-- Remove reproduction blocklist
-- Uses `@vercel/ncc` for packaging
-
-## Development
-
-> [!IMPORTANT]
-> Whenever a modification is made to the action, the action built to `dist` must be committed to the repository.
-
-This is done by running:
-
-```sh
-pnpm build
-```

.github/actions/triage/action.yml

@@ -1,40 +0,0 @@
-name: Triage
-description: Initial triage for issues
-
-inputs:
-  reproduction-comment:
-    description: 'Either a string or a path to a .md file inside the repository. Example: ".github/invalid-reproduction.md"'
-    default: '.github/invalid-reproduction.md'
-  reproduction-hosts:
-    description: 'Comma-separated list of hostnames that are allowed for reproductions. Example: "github.com,codesandbox.io"'
-    default: github.com
-  reproduction-invalid-label:
-    description: 'Label to apply to issues without a valid reproduction. Example: "invalid-reproduction"'
-    default: 'invalid-reproduction'
-  reproduction-issue-labels:
-    description: 'Comma-separated list of issue labels. If configured, only verify reproduction URLs of issues with one of these labels present. Adding a comma at the end will handle non-labeled issues as invalid. Example: "bug,", will consider issues with the label "bug" or no label.'
-    default: ''
-  reproduction-link-section:
-    description: 'A regular expression string with "(.*)" matching a valid URL in the issue body. The result is trimmed. Example: "### Link to reproduction(.*)### To reproduce"'
-    default: '### Link to reproduction(.*)### To reproduce'
-  tag-only:
-    description: Log and tag only. Do not perform closing or commenting actions.
-    default: false
-
-runs:
-  using: 'composite'
-  steps:
-    - name: Checkout code
-      if: ${{ github.event_name != 'pull_request' }}
-      uses: actions/checkout@v4
-    - name: Run action
-      run: node ${{ github.action_path }}/dist/index.js
-      shell: sh
-      # https://github.com/actions/runner/issues/665#issuecomment-676581170
-      env:
-        'INPUT_REPRODUCTION_COMMENT': ${{inputs.reproduction-comment}}
-        'INPUT_REPRODUCTION_HOSTS': ${{inputs.reproduction-hosts}}
-        'INPUT_REPRODUCTION_INVALID_LABEL': ${{inputs.reproduction-invalid-label}}
-        'INPUT_REPRODUCTION_ISSUE_LABELS': ${{inputs.reproduction-issue-labels}}
-        'INPUT_REPRODUCTION_LINK_SECTION': ${{inputs.reproduction-link-section}}
-        'INPUT_TAG_ONLY': ${{inputs.tag-only}}

.github/actions/triage/jest.config.js

@@ -1,7 +0,0 @@
-module.exports = {
-  testEnvironment: 'node',
-  testPathIgnorePatterns: ['/node_modules/', '<rootDir>/dist/'],
-  transform: {
-    '^.+\\.(t|j)sx?$': ['@swc/jest'],
-  },
-}

.github/actions/triage/package.json

@@ -1,34 +0,0 @@
-{
-  "name": "triage",
-  "version": "0.0.0",
-  "private": true,
-  "description": "GitHub Action to triage new issues",
-  "license": "MIT",
-  "main": "dist/index.js",
-  "scripts": {
-    "build": "pnpm build:typecheck && pnpm build:ncc",
-    "build:ncc": "ncc build src/index.ts -t -o dist",
-    "build:typecheck": "tsc",
-    "clean": "rimraf dist",
-    "test": "jest"
-  },
-  "dependencies": {
-    "@actions/core": "^1.3.0",
-    "@actions/github": "^5.0.0"
-  },
-  "devDependencies": {
-    "@octokit/webhooks-types": "^7.5.1",
-    "@swc/jest": "^0.2.36",
-    "@types/jest": "^27.5.2",
-    "@types/node": "^20.16.5",
-    "@typescript-eslint/eslint-plugin": "^4.33.0",
-    "@typescript-eslint/parser": "^4.33.0",
-    "@vercel/ncc": "0.38.1",
-    "concurrently": "^8.2.2",
-    "eslint": "^7.32.0",
-    "jest": "^29.7.0",
-    "prettier": "^3.3.3",
-    "ts-jest": "^26.5.6",
-    "typescript": "^4.9.5"
-  }
-}

.github/actions/triage/src/index.ts

@@ -1,195 +0,0 @@
-import { debug, error, getBooleanInput, getInput, info, setFailed } from '@actions/core'
-
-import { context, getOctokit } from '@actions/github'
-import { readFile, access } from 'node:fs/promises'
-import { join } from 'node:path'
-
-// Ensure GITHUB_TOKEN and GITHUB_WORKSPACE are present
-if (!process.env.GITHUB_TOKEN) throw new TypeError('No GITHUB_TOKEN provided')
-if (!process.env.GITHUB_WORKSPACE) throw new TypeError('Not a GitHub workspace')
-
-// Define the configuration object
-interface Config {
-  invalidLink: {
-    comment: string
-    bugLabels: string[]
-    hosts: string[]
-    label: string
-    linkSection: string
-  }
-  tagOnly: boolean
-  token: string
-  workspace: string
-}
-
-const config: Config = {
-  invalidLink: {
-    comment: getInput('reproduction_comment') || '.github/invalid-reproduction.md',
-    bugLabels: getInput('reproduction_issue_labels')
-      .split(',')
-      .map((l) => l.trim()),
-    hosts: (getInput('reproduction_hosts') || 'github.com').split(',').map((h) => h.trim()),
-    label: getInput('reproduction_invalid_label') || 'invalid-reproduction',
-    linkSection:
-      getInput('reproduction_link_section') || '### Link to reproduction(.*)### To reproduce',
-  },
-  tagOnly: getBooleanOrUndefined('tag_only') || false,
-  token: process.env.GITHUB_TOKEN,
-  workspace: process.env.GITHUB_WORKSPACE,
-}
-
-// Attempt to parse JSON, return parsed object or error
-function tryParse(json: string): Record<string, unknown> {
-  try {
-    return JSON.parse(json)
-  } catch (e) {
-    setFailed(`Could not parse JSON: ${e instanceof Error ? e.message : e}`)
-    return {}
-  }
-}
-
-// Retrieves a boolean input or undefined based on environment variables
-function getBooleanOrUndefined(value: string): boolean | undefined {
-  const variable = process.env[`INPUT_${value.toUpperCase()}`]
-  return variable === undefined || variable === '' ? undefined : getBooleanInput(value)
-}
-
-// Returns the appropriate label match type
-function getLabelMatch(value: string | undefined): 'name' | 'description' {
-  return value === 'name' ? 'name' : 'description'
-}
-
-// Function to check if an issue contains a valid reproduction link
-async function checkValidReproduction(): Promise<void> {
-  const { issue, action } = context.payload as {
-    issue: { number: number; body: string; labels: { name: string }[] } | undefined
-    action: string
-  }
-
-  if (action !== 'opened' || !issue?.body) return
-
-  const labels = issue.labels.map((l) => l.name)
-
-  const issueMatchingLabel =
-    labels.length &&
-    config.invalidLink.bugLabels.length &&
-    labels.some((l) => config.invalidLink.bugLabels.includes(l))
-
-  if (!issueMatchingLabel) {
-    info(
-      `Issue #${issue.number} does not match required labels: ${config.invalidLink.bugLabels.join(', ')}`,
-    )
-    info(`Issue labels: ${labels.join(', ')}`)
-    return
-  }
-
-  info(`Issue #${issue.number} labels: ${labels.join(', ')}`)
-
-  const { rest: client } = getOctokit(config.token)
-  const common = { ...context.repo, issue_number: issue.number }
-
-  const labelsToRemove = labels.filter((l) => config.invalidLink.bugLabels.includes(l))
-
-  if (await isValidReproduction(issue.body)) {
-    await Promise.all(
-      labelsToRemove.map((label) => client.issues.removeLabel({ ...common, name: label })),
-    )
-
-    return info(`Issue #${issue.number} contains a valid reproduction 💚`)
-  }
-
-  info(`Invalid reproduction, issue will be closed/labeled/commented...`)
-
-  // Adjust labels
-  await Promise.all(
-    labelsToRemove.map((label) => client.issues.removeLabel({ ...common, name: label })),
-  )
-  info(`Issue #${issue.number} - validate label removed`)
-  await client.issues.addLabels({ ...common, labels: [config.invalidLink.label] })
-  info(`Issue #${issue.number} - labeled`)
-
-  // If tagOnly, do not close or comment
-  if (config.tagOnly) {
-    info('Tag-only enabled, no closing/commenting actions taken')
-    return
-  }
-
-  // Perform closing and commenting actions
-  await client.issues.update({ ...common, state: 'closed' })
-  info(`Issue #${issue.number} - closed`)
-
-  const comment = join(config.workspace, config.invalidLink.comment)
-  await client.issues.createComment({ ...common, body: await getCommentBody(comment) })
-  info(`Issue #${issue.number} - commented`)
-}
-
-/**
- * Determine if an issue contains a valid/accessible link to a reproduction.
- *
- * Returns `true` if the link is valid.
- * @param body - The body content of the issue
- */
-async function isValidReproduction(body: string): Promise<boolean> {
-  const linkSectionRe = new RegExp(config.invalidLink.linkSection, 'is')
-  const link = body.match(linkSectionRe)?.[1]?.trim()
-
-  if (!link) {
-    info('Missing link')
-    info(`Link section regex: ${linkSectionRe}`)
-    info(`Link section: ${body}`)
-    return false
-  }
-
-  info(`Checking validity of link: ${link}`)
-
-  if (!URL.canParse(link)) {
-    info(`Invalid URL: ${link}`)
-    return false
-  }
-
-  const url = new URL(link)
-
-  if (!config.invalidLink.hosts.includes(url.hostname)) {
-    info('Link did not match allowed reproduction hosts')
-    return false
-  }
-
-  try {
-    // Verify that the link can be accessed
-    const response = await fetch(link)
-    const isOk = response.status < 400 || response.status >= 500
-
-    info(`Link status: ${response.status}`)
-    if (!isOk) {
-      info(`Link returned status ${response.status}`)
-    }
-    return isOk
-  } catch (error) {
-    info(`Error fetching link: ${(error as Error).message}`)
-    return false
-  }
-}
-
-/**
- * Return either a file's content or a string
- * @param {string} pathOrComment
- */
-async function getCommentBody(pathOrComment: string) {
-  try {
-    await access(pathOrComment)
-    return await readFile(pathOrComment, 'utf8')
-  } catch (error: any) {
-    if (error.code === 'ENOENT') return pathOrComment
-    throw error
-  }
-}
-
-async function run() {
-  const { token, workspace, ...safeConfig } = config
-  info('Configuration:')
-  info(JSON.stringify(safeConfig, null, 2))
-
-  await checkValidReproduction()
-}
-
-run().catch(setFailed)

.github/actions/triage/tsconfig.json

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "es5",
-    "lib": ["es2020.string"],
-    "noEmit": true,
-    "strict": true,
-    "noUnusedLocals": false, // Undo this
-    "noImplicitReturns": true,
-    "noFallthroughCasesInSwitch": true,
-    "forceConsistentCasingInFileNames": true,
-    "downlevelIteration": true,
-    "skipLibCheck": true,
-  },
-  "exclude": ["src/**/*.test.ts"]
-}

.github/comments/invalid-reproduction.md

@@ -1,18 +0,0 @@
-We cannot recreate the issue with the provided information. **Please add a reproduction in order for us to be able to investigate.**
-
-### Why was this issue marked with the `invalid-reproduction` label?
-
-To be able to investigate, we need access to a reproduction to identify what triggered the issue. We prefer a link to a public GitHub repository created with `create-payload-app@beta -t blank` or a forked/branched version of this repository with tests added (more info in the [reproduction-guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md)).
-
-To make sure the issue is resolved as quickly as possible, please make sure that the reproduction is as **minimal** as possible. This means that you should **remove unnecessary code, files, and dependencies** that do not contribute to the issue. Ensure your reproduction does not depend on secrets, 3rd party registries, private dependencies, or any other data that cannot be made public. Avoid a reproduction including a whole monorepo (unless relevant to the issue). The easier it is to reproduce the issue, the quicker we can help.
-
-Please test your reproduction against the latest version of Payload to make sure your issue has not already been fixed.
-
-### I added a link, why was it still marked?
-
-Ensure the link is pointing to a codebase that is accessible (e.g. not a private repository). "[example.com](http://example.com/)", "n/a", "will add later", etc. are not acceptable links -- we need to see a public codebase. See the above section for accepted links.
-
-### Useful Resources
-
-- [Reproduction Guide](https://github.com/payloadcms/payload/blob/main/.github/reproduction-guide.md)
-- [Contributing to Payload](https://www.youtube.com/watch?v=08Qa3ggR9rw)

.github/dependabot.yml

@@ -1,74 +0,0 @@
-# docs: https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: github-actions
-    directories:
-      - /
-      - /.github/workflows
-      - /.github/actions/* # Not working until resolved: https://github.com/dependabot/dependabot-core/issues/6345
-      - /.github/actions/setup
-    target-branch: beta
-    schedule:
-      interval: monthly
-      timezone: America/Detroit
-      time: '06:00'
-    groups:
-      github_actions:
-        patterns:
-          - '*'
-
-  - package-ecosystem: npm
-    directory: /
-    target-branch: beta
-    schedule:
-      interval: weekly
-      day: sunday
-      timezone: America/Detroit
-      time: '06:00'
-    commit-message:
-      prefix: 'chore(deps)'
-    labels:
-      - dependencies
-    groups:
-      production-deps:
-        dependency-type: production
-        update-types:
-          - minor
-          - patch
-        patterns:
-          - '*'
-        exclude-patterns:
-          - 'drizzle*'
-      dev-deps:
-        dependency-type: development
-        update-types:
-          - minor
-          - patch
-        patterns:
-          - '*'
-        exclude-patterns:
-          - 'drizzle*'
-
-  # Only bump patch versions for 2.x
-  - package-ecosystem: npm
-    directory: /
-    target-branch: main
-    schedule:
-      interval: weekly
-      day: sunday
-      timezone: America/Detroit
-      time: '06:00'
-    commit-message:
-      prefix: 'chore(deps)'
-    labels:
-      - dependencies
-    groups:
-      production-deps:
-        dependency-type: production
-        update-types:
-          - patch
-        patterns:
-          - '*'
-        exclude-patterns:
-          - 'drizzle*'

.github/pnpm-workspace.yaml

@@ -1,2 +0,0 @@
-packages:
-  - 'actions/*'

.github/workflows/label-author.yml

@@ -0,0 +1,50 @@
+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/label-on-change.yml

@@ -1,116 +0,0 @@
-name: label-on-change
-
-on:
-  # https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
-  issues:
-    types:
-      - assigned
-      - closed
-      - labeled
-      - reopened
-
-  # TODO: Handle labeling on comment
-
-jobs:
-  on-labeled-ensure-one-status:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-    # Only run on issue labeled and if label starts with 'status:'
-    if: github.event.action == 'labeled' && startsWith(github.event.label.name, 'status:')
-    steps:
-      - name: Ensure only one status label
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            // Get all labels that start with 'status:' and are not the incoming label
-            const incomingLabelName = context.payload.label.name;
-            const labelNamesToRemove = context.payload.issue.labels
-              .filter(label => label.name.startsWith('status:') && label.name !== incomingLabelName)
-              .map(label => label.name);
-
-            if (!labelNamesToRemove.length) {
-              console.log('No labels to remove');
-              return;
-            }
-
-            console.log(`Labels to remove: '${labelNamesToRemove}'`);
-
-            // If there is more than one status label, remove all but the incoming label
-            for (const labelName of labelNamesToRemove) {
-              await github.rest.issues.removeLabel({
-                issue_number: context.issue.number,
-                name: labelName,
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-              });
-              console.log(`Removed '${labelName}' label`);
-            }
-
-  on-issue-close:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-    if: github.event.action == 'closed'
-    steps:
-      - name: Remove all labels on issue close
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{ secrets.GITHUB_TOKEN }}
-          script: |
-            // Get all labels that start with 'status:' and 'stale'
-            const labelNamesToRemove = context.payload.issue.labels
-              .filter(label => label.name.startsWith('status:') || label.name === 'stale')
-              .map(label => label.name);
-
-            if (!labelNamesToRemove.length) {
-              console.log('No labels to remove');
-              return;
-            }
-
-            console.log(`Labels to remove: '${labelNamesToRemove}'`);
-
-            for (const labelName of labelNamesToRemove) {
-              await github.rest.issues.removeLabel({
-                issue_number: context.issue.number,
-                name: labelName,
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-              });
-              console.log(`Removed '${labelName}' label`);
-            }
-
-  on-issue-reopen:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-    if: github.event.action == 'reopened'
-    steps:
-      - name: Add needs-triage label on issue reopen
-        uses: actions-ecosystem/action-add-labels@v1
-        with:
-          labels: 'status: needs-triage'
-
-  on-issue-assigned:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-    if: >
-      github.event.action == 'assigned' &&
-      contains(github.event.issue.labels.*.name, 'status: needs-triage')
-    steps:
-      - name: Remove needs-triage label on issue assign
-        uses: actions-ecosystem/action-remove-labels@v1
-        with:
-          labels: 'status: needs-triage'
-
-  # on-pr-merge:
-  #   runs-on: ubuntu-latest
-  #   if: github.event.pull_request.merged == true
-  #   steps:
-
-  # on-pr-close:
-  #   runs-on: ubuntu-latest
-  #   if: github.event_name == 'pull_request_target' && github.event.pull_request.merged == false
-  #   steps:

.github/workflows/lock-issues.yml

@@ -1,26 +0,0 @@
-name: lock-issues
-
-on:
-  schedule:
-    # Run nightly at 12am EST
-    - cron: '0 4 * * *'
-  workflow_dispatch:
-
-permissions:
-  issues: write
-
-jobs:
-  lock_issues:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Lock issues
-        uses: dessant/lock-threads@v5
-        with:
-          process-only: 'issues'
-          issue-inactive-days: '1'
-          exclude-any-issue-labels: 'status: awaiting-reply'
-          log-output: true
-          issue-comment: >
-            This issue has been automatically locked.
-
-            Please open a new issue if this issue persists with any additional detail.

.github/workflows/main.yml

@@ -17,8 +17,8 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  NODE_VERSION: 22.6.0
-  PNPM_VERSION: 9.7.1
+  NODE_VERSION: 18.20.2
+  PNPM_VERSION: 8.15.7
   DO_NOT_TRACK: 1 # Disable Turbopack telemetry
   NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry
 
@@ -74,7 +74,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
           version: ${{ env.PNPM_VERSION }}
           run_install: false
@@ -120,7 +120,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
           version: ${{ env.PNPM_VERSION }}
           run_install: false
@@ -167,7 +167,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
           version: ${{ env.PNPM_VERSION }}
           run_install: false
@@ -196,7 +196,6 @@ jobs:
           - postgres-custom-schema
           - postgres-uuid
           - supabase
-          - sqlite
     env:
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: postgres
@@ -207,9 +206,6 @@ jobs:
       AWS_REGION: us-east-1
 
     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
@@ -220,12 +216,17 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
           version: ${{ env.PNPM_VERSION }}
           run_install: false
 
-      - run: pnpm install
+      - 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
@@ -291,7 +292,6 @@ jobs:
           - access-control
           - admin__e2e__1
           - admin__e2e__2
-          - admin-root
           - auth
           - field-error-states
           - fields-relationship
@@ -310,7 +310,6 @@ jobs:
           - fields__collections__Upload
           - live-preview
           - localization
-          - locked-documents
           - i18n
           - plugin-cloud-storage
           - plugin-form-builder
@@ -331,7 +330,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
           version: ${{ env.PNPM_VERSION }}
           run_install: false
@@ -370,7 +369,7 @@ jobs:
         run: pnpm exec playwright install-deps chromium
 
       - name: E2E Tests
-        run: PLAYWRIGHT_JSON_OUTPUT_NAME=results_${{ matrix.suite }}.json pnpm test:e2e:prod:ci ${{ matrix.suite }}
+        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
@@ -391,7 +390,6 @@ jobs:
       #     job-summary: true
 
   app-build-with-packed:
-    if: false # Disable until package resolution in tgzs can be figured out
     runs-on: ubuntu-latest
     needs: build
 
@@ -406,7 +404,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
           version: ${{ env.PNPM_VERSION }}
           run_install: false
@@ -419,15 +417,15 @@ jobs:
           key: ${{ github.sha }}-${{ github.run_number }}
 
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.11.0
+        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
-          cd templates/blank
+          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
@@ -450,7 +448,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
           version: ${{ env.PNPM_VERSION }}
           run_install: false
@@ -491,7 +489,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Start MongoDB
-        uses: supercharge/mongodb-github-action@1.11.0
+        uses: supercharge/mongodb-github-action@1.10.0
         with:
           mongodb-version: 6.0
 
@@ -519,7 +517,7 @@ jobs:
           node-version: ${{ env.NODE_VERSION }}
 
       - name: Install pnpm
-        uses: pnpm/action-setup@v4
+        uses: pnpm/action-setup@v3
         with:
           version: ${{ env.PNPM_VERSION }}
           run_install: false
@@ -548,16 +546,3 @@ jobs:
     steps:
       - if: ${{ always() && (contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled')) }}
         run: exit 1
-
-  publish-canary:
-    name: Publish Canary
-    runs-on: ubuntu-latest
-    needs:
-      - all-green
-
-    steps:
-      # debug github.ref output
-      - run: |
-          echo github.ref: ${{ github.ref }}
-          echo isBeta: ${{ github.ref == 'refs/heads/beta' }}
-          echo isMain: ${{ github.ref == 'refs/heads/main' }}

.github/workflows/post-release.yml

@@ -1,30 +0,0 @@
-name: post-release
-
-on:
-  release:
-    types:
-      - published
-  workflow_dispatch:
-
-jobs:
-  post_release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          # Only needed if debugging on a branch other than default
-          # ref: ${{ github.event.release.target_commitish || github.ref }}
-      - uses: ./.github/actions/release-commenter
-        continue-on-error: true
-        env:
-          ACTIONS_STEP_DEBUG: true
-        with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          tag-filter: 'v\d'
-
-          # Change to blank to disable commenting
-          # comment-template: ''
-
-          comment-template: |
-            🚀 This is included in version {release_link}

.github/workflows/pr-title.yml

@@ -5,6 +5,7 @@ on:
     types:
       - opened
       - edited
+      - synchronize
 
 permissions:
   pull-requests: write
@@ -37,21 +38,19 @@ jobs:
             db-\*
             db-mongodb
             db-postgres
-            db-vercel-postgres
-            db-sqlite
-            drizzle
             email-nodemailer
             eslint
             graphql
             live-preview
             live-preview-react
             next
-            payload-cloud
+            payload
             plugin-cloud
             plugin-cloud-storage
             plugin-form-builder
             plugin-nested-docs
             plugin-redirects
+            plugin-relationship-object-ids
             plugin-search
             plugin-sentry
             plugin-seo
@@ -62,7 +61,6 @@ jobs:
             storage-\*
             storage-azure
             storage-gcs
-            storage-uploadthing
             storage-vercel-blob
             storage-s3
             translations
@@ -103,19 +101,3 @@ jobs:
         with:
           header: pr-title-lint-error
           delete: true
-
-  label-pr-on-open:
-    name: label-pr-on-open
-    runs-on: ubuntu-latest
-    if: github.event.action == 'opened'
-    steps:
-      - name: Tag with main branch with v2
-        if: github.event.pull_request.base.ref == 'main'
-        uses: actions-ecosystem/action-add-labels@v1
-        with:
-          labels: v2
-      - name: Tag with beta branch with v3
-        if: github.event.pull_request.base.ref == 'beta'
-        uses: actions-ecosystem/action-add-labels@v1
-        with:
-          labels: v3

.github/workflows/release-canary.yml

@@ -6,8 +6,8 @@ on:
       - beta
 
 env:
-  NODE_VERSION: 22.6.0
-  PNPM_VERSION: 9.7.1
+  NODE_VERSION: 18.20.2
+  PNPM_VERSION: 8.15.7
   DO_NOT_TRACK: 1 # Disable Turbopack telemetry
   NEXT_TELEMETRY_DISABLED: 1 # Disable Next telemetry
 

.github/workflows/stale.yml

@@ -1,42 +0,0 @@
-name: stale
-
-on:
-  workflow_dispatch:
-
-jobs:
-  stale:
-    runs-on: ubuntu-latest
-    permissions:
-      issues: write
-      pull-requests: write
-    steps:
-      - uses: actions/stale@v9
-        id: stale
-        with:
-          debug-only: true
-          days-before-stale: 90
-          days-before-close: 7
-          ascending: true
-          operations-per-run: 300
-
-          # Ignore all assigned
-          exempt-all-assignees: false
-
-          # Issues
-          stale-issue-label: 'stale'
-          exempt-issue-labels: 'blocked,must,should,keep,created-by: Payload team,created-by: Contributor'
-          stale-issue-message: >
-            This issue has been marked as stale due to lack of activity. To keep the ticket open, please indicate that it is still relevant in a comment below.
-          close-issue-message: >
-            This issue was automatically closed due to lack of activity.
-
-          # Pull Requests
-          stale-pr-label: 'stale'
-          exempt-pr-labels: 'blocked,must,should,keep,created-by: Payload team,created-by: Contributor'
-          stale-pr-message: >
-            This PR is stale due to lack of activity. To keep the PR open, please indicate that it is still relevant in a comment below.
-          close-pr-message: >
-            This pull request was automatically closed due to lack of activity.
-
-      - name: Print outputs
-        run: echo ${{ format('{0},{1}', toJSON(steps.stale.outputs.staled-issues-prs), toJSON(steps.stale.outputs.closed-issues-prs)) }}

.github/workflows/triage.yml

@@ -1,102 +0,0 @@
-name: triage
-
-on:
-  pull_request:
-    types:
-      - opened
-  issues:
-    types:
-      - opened
-
-env:
-  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-permissions:
-  contents: read
-  issues: write
-  pull-requests: 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-on-open
-    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 payloadTeamUsernames = [
-              'denolfe',
-              'jmikrut',
-              'DanRibbens',
-              'jacobsfletch',
-              'JarrodMFlesch',
-              'AlessioGr',
-              'JessChowdhury',
-              'kendelljoseph',
-              'PatrikKozak',
-              'tylandavis',
-              'paulpopus',
-              'r1tsuu',
-              'GermanJablo',
-            ];
-
-            const type = context.payload.pull_request ? 'pull_request' : 'issue';
-
-            const isTeamMember = payloadTeamUsernames
-              .map(n => n.toLowerCase())
-              .includes(context.payload[type].user.login.toLowerCase());
-
-            if (isTeamMember) {
-              github.rest.issues.addLabels({
-                issue_number: context.issue.number,
-                owner: context.repo.owner,
-                repo: context.repo.repo,
-                labels: ['created-by: Payload team'],
-              });
-              console.log(`Added 'created-by: Payload team' label`);
-              return;
-            }
-
-            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 '${label}' label.`);
-
-  triage:
-    name: initial-triage
-    if: github.event_name == 'issues'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - uses: ./.github/actions/triage
-        with:
-          reproduction-comment: '.github/comments/invalid-reproduction.md'
-          reproduction-link-section: '### Link to the code that reproduces this issue(.*)### Reproduction Steps'
-          reproduction-issue-labels: 'validate-reproduction'
-          tag-only: 'true'

.gitignore

@@ -5,10 +5,6 @@ dist
 !/.idea/runConfigurations
 !/.idea/payload.iml
 
-# Custom actions
-!.github/actions/**/dist
-
-test/packed
 test-results
 .devcontainer
 .localstack
@@ -26,10 +22,6 @@ meta_shared.json
 # Ignore test directory media folder/files
 /media
 test/media
-*payloadtests.db
-*payloadtests.db-journal
-*payloadtests.db-shm
-*payloadtests.db-wal
 /versions
 
 # Created by https://www.toptal.com/developers/gitignore/api/node,macos,windows,webstorm,sublimetext,visualstudiocode
@@ -157,7 +149,6 @@ out
 # Nuxt.js build / generate output
 .nuxt
 dist
-dist_optimized
 
 # Gatsby files
 .cache/
@@ -305,15 +296,3 @@ $RECYCLE.BIN/
 
 /build
 .swc
-app/(payload)/admin/importMap.js
-test/live-preview/app/(payload)/admin/importMap.js
-/test/live-preview/app/(payload)/admin/importMap.js
-test/admin-root/app/(payload)/admin/importMap.js
-/test/admin-root/app/(payload)/admin/importMap.js
-test/app/(payload)/admin/importMap.js
-/test/app/(payload)/admin/importMap.js
-test/pnpm-lock.yaml
-test/databaseAdapter.js
-/filename-compound-index
-/media-with-relation-preview
-/media-without-relation-preview

.husky/pre-commit

@@ -1 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
 pnpm run lint-staged --quiet

.idea/payload.iml

@@ -26,7 +26,6 @@
       <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/next/dist" />
       <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" />
@@ -76,12 +75,8 @@
       <excludeFolder url="file://$MODULE_DIR$/packages/ui/.swc" />
       <excludeFolder url="file://$MODULE_DIR$/packages/ui/.turbo" />
       <excludeFolder url="file://$MODULE_DIR$/packages/ui/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/drizzle/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/drizzle/dist" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-sqlite/.turbo" />
-      <excludeFolder url="file://$MODULE_DIR$/packages/db-sqlite/dist" />
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
   </component>
-</module>
+</module>

.idea/runConfigurations/Run_Dev_Fields.xml

@@ -1,13 +1,8 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Dev Fields" type="js.build_tools.npm">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="dev" />
-    </scripts>
-    <arguments value="fields" />
-    <node-interpreter value="project" />
-    <envs />
+  <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>
     <method v="2" />
   </configuration>
 </component>

.idea/runConfigurations/Run_Dev__community.xml

@@ -1,13 +1,8 @@
 <component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Dev _community" type="js.build_tools.npm">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="dev" />
-    </scripts>
-    <arguments value="_community" />
-    <node-interpreter value="project" />
-    <envs />
+  <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>
     <method v="2" />
   </configuration>
 </component>

.idea/runConfigurations/Run_Dev_admin.xml

@@ -1,13 +0,0 @@
-<component name="ProjectRunConfigurationManager">
-  <configuration default="false" name="Run Dev admin" type="js.build_tools.npm">
-    <package-json value="$PROJECT_DIR$/package.json" />
-    <command value="run" />
-    <scripts>
-      <script value="dev" />
-    </scripts>
-    <arguments value="admin" />
-    <node-interpreter value="project" />
-    <envs />
-    <method v="2" />
-  </configuration>
-</component>

.idea/runConfigurations/_template__of_JavaScriptTestRunnerJest.xml

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

.node-version

@@ -1 +1 @@
-v22.6.0
+v18.20.2

.npmrc

@@ -1,3 +1,2 @@
 symlink=true
-node-linker=isolated
-hoist-workspace-packages=false # the default in pnpm v9 is true, but that can break our runtime dependency checks
+node-linker=isolated # due to a typescript bug, isolated mode requires @types/express-serve-static-core, terser and monaco-editor to be installed https://github.com/microsoft/TypeScript/issues/47663#issuecomment-1519138189 along with two other changes in the code which I've marked with (tsbugisolatedmode) in the code

.nvmrc

@@ -1 +1 @@
-v22.6.0
+v18.20.2

.tool-versions

@@ -1,2 +0,0 @@
-pnpm 9.7.1
-nodejs 22.6.0

.vscode/launch.json

@@ -10,14 +10,14 @@
       "cwd": "${workspaceFolder}"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts _community",
+      "command": "node --no-deprecation test/dev.js _community",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Community",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts storage-uploadthing",
+      "command": "node --no-deprecation test/dev.js storage-uploadthing",
       "cwd": "${workspaceFolder}",
       "name": "Uploadthing",
       "request": "launch",
@@ -25,7 +25,7 @@
       "envFile": "${workspaceFolder}/test/storage-uploadthing/.env"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts live-preview",
+      "command": "node --no-deprecation test/dev.js live-preview",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Live Preview",
       "request": "launch",
@@ -43,33 +43,19 @@
       }
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts admin",
+      "command": "node --no-deprecation test/dev.js admin",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Admin",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts auth",
+      "command": "node --no-deprecation test/dev.js auth",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Auth",
       "request": "launch",
       "type": "node-terminal"
     },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts fields-relationship",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Fields-Relationship",
-      "request": "launch",
-      "type": "node-terminal"
-    },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts login-with-username",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Login-With-Username",
-      "request": "launch",
-      "type": "node-terminal"
-    },
     {
       "command": "pnpm run dev plugin-cloud-storage",
       "cwd": "${workspaceFolder}",
@@ -81,21 +67,21 @@
       }
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts collections-graphql",
+      "command": "node --no-deprecation test/dev.js collections-graphql",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev GraphQL",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts fields",
+      "command": "node --no-deprecation test/dev.js fields",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Fields",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts versions",
+      "command": "node --no-deprecation test/dev.js versions",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Postgres",
       "request": "launch",
@@ -105,35 +91,28 @@
       }
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts versions",
+      "command": "node --no-deprecation test/dev.js versions",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Versions",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts localization",
+      "command": "node --no-deprecation test/dev.js localization",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Localization",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts locked-documents",
-      "cwd": "${workspaceFolder}",
-      "name": "Run Dev Locked Documents",
-      "request": "launch",
-      "type": "node-terminal"
-    },
-    {
-      "command": "pnpm tsx --no-deprecation test/dev.ts uploads",
+      "command": "node --no-deprecation test/dev.js uploads",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Uploads",
       "request": "launch",
       "type": "node-terminal"
     },
     {
-      "command": "pnpm tsx --no-deprecation test/dev.ts field-error-states",
+      "command": "node --no-deprecation test/dev.js field-error-states",
       "cwd": "${workspaceFolder}",
       "name": "Run Dev Field Error States",
       "request": "launch",

.vscode/settings.json

@@ -31,15 +31,8 @@
     "editor.formatOnSave": true
   },
   "editor.formatOnSaveMode": "file",
-  "eslint.rules.customizations": [
-    // Defaultt all ESLint errors to 'warn' to differentate from TypeScript's 'error' level
-    { "rule": "*", "severity": "warn" },
-
-    // Silence some warnings that will get auto-fixed
-    { "rule": "perfectionist/*", "severity": "off", "fixable": true },
-    { "rule": "curly", "severity": "off", "fixable": true },
-    { "rule": "object-shorthand", "severity": "off", "fixable": true }
-  ],
+  // All ESLint rules to 'warn' to differentate from TypeScript's 'error' level
+  "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"],
@@ -49,8 +42,8 @@
     }
   },
   "files.insertFinalNewline": true,
-  "jestrunner.jestCommand": "pnpm exec cross-env NODE_OPTIONS=\"--no-deprecation\" node 'node_modules/jest/bin/jest.js'",
+  "jestrunner.jestCommand": "pnpm exec cross-env NODE_OPTIONS=\"--experimental-vm-modules --no-deprecation\" node 'node_modules/jest/bin/jest.js'",
   "jestrunner.debugOptions": {
-    "runtimeArgs": ["--no-deprecation"]
+    "runtimeArgs": ["--experimental-vm-modules", "--no-deprecation"]
   }
 }

CONTRIBUTING.md

@@ -63,7 +63,7 @@ Each test directory is split up in this way specifically to reduce friction when
 
 The following command will start Payload with your config: `pnpm dev my-test-dir`. Example: `pnpm dev fields` for the test/`fields` test suite. This command will start up Payload using your config and refresh a test database on every restart. If you're using VS Code, the most common run configs are automatically added to your editor - you should be able to find them in your VS Code launch tab.
 
-By default, payload will [automatically log you in](https://payloadcms.com/docs/authentication/overview#admin-autologin) with the default credentials. To disable that, you can either pass in the --no-auto-login flag (example: `pnpm dev my-test-dir --no-auto-login`) or set the `PAYLOAD_PUBLIC_DISABLE_AUTO_LOGIN` environment variable to `false`.
+By default, payload will [automatically log you in](https://payloadcms.com/docs/authentication/config#admin-autologin) with the default credentials. To disable that, you can either pass in the --no-auto-login flag (example: `pnpm dev my-test-dir --no-auto-login`) or set the `PAYLOAD_PUBLIC_DISABLE_AUTO_LOGIN` environment variable to `false`.
 
 The default credentials are `dev@payloadcms.com` as E-Mail and `test` as password. These are used in the auto-login.
 
@@ -120,21 +120,5 @@ This is how you can preview changes you made locally to the docs:
 2. Run `yarn install`
 3. Duplicate the `.env.example` file and rename it to `.env`
 4. Add a `DOCS_DIR` environment variable to the `.env` file which points to the absolute path of your modified docs folder. For example `DOCS_DIR=/Users/yourname/Documents/GitHub/payload/docs`
-5. Run `yarn run fetchDocs:local`. If this was successful, you should see no error messages and the following output: _Docs successfully written to /.../website/src/app/docs.json_. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
+5. Run `yarn run fetchDocs:local`. If this was successful, you should see no error messages and the following output: *Docs successfully written to /.../website/src/app/docs.json*. There could be error messages if you have incorrect markdown in your local docs folder. In this case, it will tell you how you can fix it
 6. You're done! Now you can start the website locally using `yarn run dev` and preview the docs under [http://localhost:3000/docs/](http://localhost:3000/docs/)
-
-## Internationalization (i18n)
-
-If your PR adds a string to the UI, we need to make sure to translate it into all the languages ​​that Payload supports. To do that:
-
-- Find the appropriate internationalization file for your package. These are typically located in `packages/translations/src/languages`, although some packages (e.g., richtext-lexical) have separate i18n files for each feature.
-- Add the string to the English locale "en".
-- Translate it to other languages. You can use the `translateNewKeys` script if you have an OpenAI API key in your `.env` (under `OPENAI_KEY`), or you can use ChatGPT or Google translate - whatever is easier for you. For payload core translations (in packages/translations) you can run the `translateNewKeys` script using `cd packages/translations && pnpm translateNewKeys`. For lexical translations, you can run it using `cd packages/richtext-lexical && pnpm translateNewKeys`. External contributors can skip this step and leave it to us.
-
-To display translation strings in the UI, make sure to use the `t` utility of the `useTranslation` hook:
-
-```ts
-const { t } = useTranslation()
-// ...
-t('yourStringKey')
-```

README.md

@@ -1,7 +1,6 @@
 <a href="https://payloadcms.com"><img width="100%" src="https://github.com/payloadcms/payload/blob/main/packages/payload/src/admin/assets/images/github-banner-alt.jpg?raw=true" alt="Payload headless CMS Admin panel built with React" /></a>
 <br />
 <br />
-
 <p align="left">
   <a href="https://github.com/payloadcms/payload/actions"><img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/payloadcms/payload/main.yml?style=flat-square"></a>
   &nbsp;
@@ -100,10 +99,6 @@ If you want to add contributions to this repository, please follow the instructi
 
 The [Examples Directory](./examples) is a great resource for learning how to setup Payload in a variety of different ways, but you can also find great examples in our blog and throughout our social media.
 
-If you'd like to run the examples, you can either copy them to a folder outside this repo or run them directly by (1) navigating to the example's subfolder (`cd examples/your-example-folder`) and (2) using the `--ignore-workspace` flag to bypass workspace restrictions (e.g., `pnpm --ignore-workspace install` or `pnpm --ignore-workspace dev`).
-
-You can see more examples at:
-
 - [Examples Directory](./examples)
 - [Payload Blog](https://payloadcms.com/blog)
 - [Payload YouTube](https://www.youtube.com/@payloadcms)

app/(app)/layout.tsx

@@ -1,14 +0,0 @@
-import React from 'react'
-
-export const metadata = {
-  description: 'Generated by Next.js',
-  title: 'Next.js',
-}
-
-export default function RootLayout({ children }: { children: React.ReactNode }) {
-  return (
-    <html lang="en">
-      <body>{children}</body>
-    </html>
-  )
-}

app/(app)/test/page.tsx

@@ -1,11 +0,0 @@
-import configPromise from '@payload-config'
-import { getPayloadHMR } from '@payloadcms/next/utilities'
-
-export const Page = async ({ params, searchParams }) => {
-  const payload = await getPayloadHMR({
-    config: configPromise,
-  })
-  return <div>test ${payload?.config?.collections?.length}</div>
-}
-
-export default Page

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

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

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

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

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

@@ -1,5 +1,5 @@
 /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+/* 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'
 

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

@@ -1,5 +1,5 @@
 /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+/* 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'
 

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

@@ -1,8 +1,6 @@
 /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
+/* DO NOT MODIFY it because it could be re-written at any time. */
 import config from '@payload-config'
-import { GRAPHQL_POST, REST_OPTIONS } from '@payloadcms/next/routes'
+import { GRAPHQL_POST } from '@payloadcms/next/routes'
 
 export const POST = GRAPHQL_POST(config)
-
-export const OPTIONS = REST_OPTIONS(config)

app/(payload)/layout.tsx

@@ -1,21 +1,16 @@
 /* THIS FILE WAS GENERATED AUTOMATICALLY BY PAYLOAD. */
-/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
 import configPromise from '@payload-config'
 import { RootLayout } from '@payloadcms/next/layouts'
 // import '@payloadcms/ui/styles.css' // Uncomment this line if `@payloadcms/ui` in `tsconfig.json` points to `/ui/dist` instead of `/ui/src`
+/* DO NOT MODIFY IT BECAUSE IT COULD BE REWRITTEN AT ANY TIME. */
 import React from 'react'
 
-import { importMap } from './admin/importMap.js'
 import './custom.scss'
 
 type Args = {
   children: React.ReactNode
 }
 
-const Layout = ({ children }: Args) => (
-  <RootLayout config={configPromise} importMap={importMap}>
-    {children}
-  </RootLayout>
-)
+const Layout = ({ children }: Args) => <RootLayout config={configPromise}>{children}</RootLayout>
 
 export default Layout

app/global-error.tsx

@@ -1,27 +0,0 @@
-/* eslint-disable no-restricted-exports */
-'use client'
-
-import * as Sentry from '@sentry/nextjs'
-import NextError from 'next/error.js'
-import { useEffect } from 'react'
-
-export default function GlobalError({ error }: { error: { digest?: string } & Error }) {
-  useEffect(() => {
-    if (process.env.NEXT_PUBLIC_SENTRY_DSN) {
-      Sentry.captureException(error)
-    }
-  }, [error])
-
-  return (
-    <html lang="en-US">
-      <body>
-        {/* `NextError` is the default Next.js error page component. Its type
-        definition requires a `statusCode` prop. However, since the App Router
-        does not expose status codes for errors, we simply pass 0 to render a
-        generic error message. */}
-        {/* @ts-expect-error types repo */}
-        <NextError statusCode={0} />
-      </body>
-    </html>
-  )
-}

docs/access-control/collections.mdx

@@ -6,140 +6,96 @@ desc: With Collection-level Access Control you can define which users can create
 keywords: collections, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Collection Access Control is [Access Control](../access-control) used to restrict access to Documents within a [Collection](../collections/overview), as well as what they can and cannot see within the [Admin Panel](../admin/overview) as it relates to that Collection.
+You can define Collection-level Access Control within each Collection's `access` property. All Access Control functions accept one `args` argument.
 
-To add Access Control to a Collection, use the `access` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload';
-
-export const CollectionWithAccessControl: CollectionConfig = {
-  // ...
-  access: { // highlight-line
-    // ...
-  },
-}
-```
-
-## Config Options
-
-Access Control is specific to the operation of the request.
-
-To add Access Control to a Collection, use the `access` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload';
-
-export const CollectionWithAccessControl: CollectionConfig = {
-  // ...
-  // highlight-start
-  access: {
-    create: () => {...},
-    read: () => {...},
-    update: () => {...},
-    delete: () => {...},
-
-    // Auth-enabled Collections only
-    admin: () => {...},
-    unlock: () => {...},
-
-    // Version-enabled Collections only
-    readVersions: () => {...},
-  },
-  // highlight-end
-}
-```
-
-The following options are available:
+## Available Controls
 
 | Function                | Allows/Denies Access                         |
 | ----------------------- | -------------------------------------------- |
-| **`create`** | Used in the `create` operation. [More details](#create). |
-| **`read`**     | Used in the `find` and `findByID` operations. [More details](#read). |
-| **`update`** | Used in the `update` operation. [More details](#update). |
-| **`delete`** | Used in the `delete` operation. [More details](#delete). |
+| **[`create`](#create)** | Used in the `create` operation               |
+| **[`read`](#read)**     | Used in the `find` and `findByID` operations |
+| **[`update`](#update)** | Used in the `update` operation               |
+| **[`delete`](#delete)** | Used in the `delete` operation               |
 
-If a Collection supports [`Authentication`](../authentication/overview), the following additional options are available:
+#### Auth-enabled Controls
+
+If a Collection supports [`Authentication`](/docs/authentication/overview), the following Access Controls become available:
 
 | Function                | Allows/Denies Access                                           |
 | ----------------------- | -------------------------------------------------------------- |
-| **`admin`**   | Used to restrict access to the [Admin Panel](../admin/overview). [More details](#admin). |
-| **`unlock`** | Used to restrict which users can access the `unlock` operation. [More details](#unlock). |
+| **[`admin`](#admin)**   | Used to restrict access to the Payload Admin panel             |
+| **[`unlock`](#unlock)** | Used to restrict which users can access the `unlock` operation |
 
-If a Collection supports [Versions](../versions/overview), the following additional options are available:
+**Example Collection config:**
 
-| Function           | Allows/Denies Access                                                                                                   |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| **`readVersions`** | Used to control who can read versions, and who can't. Will automatically restrict the Admin UI version viewing access. [More details](#read-versions). |
+```ts
+import type { CollectionConfig } from 'payload';
+
+export const Posts: CollectionConfig = {
+  slug: "posts",
+  // highlight-start
+  access: {
+    create: ({ req: { user } }) => { ... },
+    read: ({ req: { user } }) => { ... },
+    update: ({ req: { user } }) => { ... },
+    delete: ({ req: { user } }) => { ... },
+    admin: ({ req: { user } }) => { ... },
+  },
+  // highlight-end
+};
+```
 
 ### Create
 
 Returns a boolean which allows/denies access to the `create` request.
 
-To add create Access Control to a Collection, use the `create` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithCreateAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    create: ({ req: { user }, data }) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `create` function:
+**Available argument properties:**
 
 | Option     | Description                                                                                                                  |
 | ---------- | ---------------------------------------------------------------------------------------------------------------------------- |
-| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |
 | **`data`** | The data passed to create the document with.                                                                                 |
 
-### Read
-
-Returns a boolean which allows/denies access to the `read` request.
-
-To add read Access Control to a Collection, use the `read` property in the [Collection Config](../collections/overview):
+**Example:**
 
 ```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithReadAccess: CollectionConfig = {
-  // ...
+const PublicUsers = {
+  slug: 'public-users',
   access: {
     // highlight-start
-    read: ({ req: { user } }) => {
-      return Boolean(user)
-    },
+    // allow guest users to self-registration
+    create: () => true,
     // highlight-end
+    ...
   },
+  fields: [ ... ],
 }
 ```
 
-<Banner type="success">
-  <strong>Tip:</strong>
-  Return a [Query](../queries/overview) to limit the Documents to only those that match the constraint. This can be helpful to restrict users' access to specific Documents. [More details](../queries/overview).
-</Banner>
+### Read
 
-As your application becomes more complex, you may want to define your function in a separate file and import them into your Collection Config:
+Read access functions can return a boolean result or optionally return a [query constraint](/docs/queries/overview) which limits the documents that are returned to only those that match the constraint you provide. This can be helpful to restrict users' access to only certain documents however you specify.
+
+**Available argument properties:**
+
+| Option    | Description                                                                |
+| --------- | -------------------------------------------------------------------------- |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |
+| **`id`**  | `id` of document requested, if within `findByID`                           |
+
+**Example:**
 
 ```ts
 import type { Access } from 'payload'
 
-export const canReadPage: Access = ({ req: { user } }) => {
-  // Allow authenticated users
+const canReadPage: Access = ({ req: { user } }) => {
+  // allow authenticated users
   if (user) {
     return true
   }
-
-  // By returning a Query, guest users can read public Documents
-  // Note: this assumes you have a `isPublic` checkbox field on your Collection
+  // using a query constraint, guest users can access when a field named 'isPublic' is set to true
   return {
+    // assumes we have a checkbox field named 'isPublic'
     isPublic: {
       equals: true,
     },
@@ -147,96 +103,55 @@ export const canReadPage: Access = ({ req: { user } }) => {
 }
 ```
 
-The following arguments are provided to the `read` function:
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
-| **`id`**  | `id` of document requested, if within `findByID`.                           |
-
 ### Update
 
-Returns a boolean which allows/denies access to the `update` request.
+Update access functions can return a boolean result or optionally return a [query constraint](/docs/queries/overview) to limit the document(s) that can be updated by the currently authenticated user. For example, returning a `query` from the `update` Access Control is helpful in cases where you would like to restrict a user to only being able to update the documents containing a `createdBy` relationship field equal to the user's ID.
 
-To add update Access Control to a Collection, use the `update` property in the [Collection Config](../collections/overview):
+**Available argument properties:**
 
-```ts
-import type { CollectionConfig } from 'payload'
+| Option     | Description                                                                |
+| ---------- | -------------------------------------------------------------------------- |
+| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |
+| **`id`**   | `id` of document requested to update                                       |
+| **`data`** | The data passed to update the document with                                |
 
-export const CollectionWithUpdateAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    update: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  Return a [Query](../queries/overview) to limit the Documents to only those that match the constraint. This can be helpful to restrict users' access to specific Documents. [More details](../queries/overview).
-</Banner>
-
-As your application becomes more complex, you may want to define your function in a separate file and import them into your Collection Config:
+**Example:**
 
 ```ts
 import type { Access } from 'payload'
 
-export const canUpdateUser: Access = ({ req: { user }, id }) => {
-  // Allow users with a role of 'admin'
+const canUpdateUser: Access = ({ req: { user }, id }) => {
+  // allow users with a role of 'admin'
   if (user.roles && user.roles.some((role) => role === 'admin')) {
     return true
   }
-
   // allow any other users to update only oneself
   return user.id === id
 }
 ```
 
-The following arguments are provided to the `update` function:
-
-| Option     | Description                                                                |
-| ---------- | -------------------------------------------------------------------------- |
-| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
-| **`id`**   | `id` of document requested to update.                                       |
-| **`data`** | The data passed to update the document with.                                |
-
 ### Delete
 
 Similarly to the Update function, returns a boolean or a [query constraint](/docs/queries/overview) to limit which documents can be deleted by which users.
 
-To add delete Access Control to a Collection, use the `delete` property in the [Collection Config](../collections/overview):
+**Available argument properties:**
 
-```ts
-import type { CollectionConfig } from 'payload'
+| Option    | Description                                                                                         |
+| --------- | --------------------------------------------------------------------------------------------------- |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object with additional `user` property, which is the currently logged in user |
+| **`id`**  | `id` of document requested to delete                                                                |
 
-export const CollectionWithDeleteAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    delete: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-As your application becomes more complex, you may want to define your function in a separate file and import them into your Collection Config:
+**Example:**
 
 ```ts
 import type { Access } from 'payload'
 
-export const canDeleteCustomer: Access = async ({ req, id }) => {
+const canDeleteCustomer: Access = async ({ req, id }) => {
   if (!id) {
-    // allow the admin UI to show controls to delete since it is indeterminate without the `id`
+    // allow the admin UI to show controls to delete since it is indeterminate without the id
     return true
   }
-
-  // Query another Collection using the `id`
+  // query another collection using the id
   const result = await req.payload.find({
     collection: 'contracts',
     limit: 0,
@@ -250,90 +165,22 @@ export const canDeleteCustomer: Access = async ({ req, id }) => {
 }
 ```
 
-The following arguments are provided to the `delete` function:
-
-| Option    | Description                                                                                         |
-| --------- | --------------------------------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object with additional `user` property, which is the currently logged in user. |
-| **`id`**  | `id` of document requested to delete.
-
 ### Admin
 
-If the Collection is use to access the [Admin Panel](../admin/overview#the-admin-user-collection), the `Admin` Access Control function determines whether or not the currently logged in user can access the admin UI.
+If the Collection is [used to access the Payload Admin panel](/docs/admin/overview#the-admin-user-collection), the `Admin` Access Control function determines whether or not the currently logged in user can access the admin UI.
 
-To add Admin Access Control to a Collection, use the `admin` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithAdminAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    admin: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `admin` function:
+**Available argument properties:**
 
 | Option    | Description                                                                |
 | --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |
 
 ### Unlock
 
-Determines which users can [unlock](/docs/authentication/operations#unlock) other users who may be blocked from authenticating successfully due to [failing too many login attempts](/docs/authentication/overview#options).
+Determines which users can [unlock](/docs/authentication/operations#unlock) other users who may be blocked from authenticating successfully due to [failing too many login attempts](/docs/authentication/config#options).
 
-To add Unlock Access Control to a Collection, use the `unlock` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithUnlockAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    unlock: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `unlock` function:
+**Available argument properties:**
 
 | Option    | Description                                                                |
 | --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
-
-### Read Versions
-
-If the Collection has [Versions](../versions/overview) enabled, the `readVersions` Access Control function determines whether or not the currently logged in user can access the version history of a Document.
-
-To add Read Versions Access Control to a Collection, use the `readVersions` property in the [Collection Config](../collections/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionWithVersionsAccess: CollectionConfig = {
-  // ...
-  access: {
-    // highlight-start
-    readVersions: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `readVersions` function:
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |

docs/access-control/fields.mdx

@@ -1,39 +1,25 @@
 ---
 title: Field-level Access Control
 label: Fields
-order: 40
+order: 30
 desc: Field-level Access Control is specified within a field's config, and allows you to define which users can create, read or update Fields.
 keywords: fields, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Field Access Control is [Access Control](../access-control) used to restrict access to specific [Fields](../fields/overview) within a Document.
+Field Access Control is specified with functions inside a field's config. All field-level Controls return a boolean value to allow or deny access for the specified operation. No field-level Access Controls support returning query constraints. All Access Control functions accept one `args` argument.
 
-To add Access Control to a Field, use the `access` property in your [Field Config](../fields/overview):
+## Available Controls
+
+| Function                | Purpose                                                                          |
+| ----------------------- | -------------------------------------------------------------------------------- |
+| **[`create`](#create)** | Allows or denies the ability to set a field's value when creating a new document |
+| **[`read`](#read)**     | Allows or denies the ability to read a field's value                             |
+| **[`update`](#update)** | Allows or denies the ability to update a field's value                           |
+
+**Example Collection config:**
 
 ```ts
-import type { Field } from 'payload';
-
-export const FieldWithAccessControl: Field = {
-  // ...
-  access: { // highlight-line
-    // ...
-  },
-}
-```
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  Field Access Controls does not support returning [Query](../queries/overview) constraints like [Collection Access Control](./collections) does.
-</Banner>
-
-## Config Options
-
-Access Control is specific to the operation of the request.
-
-To add Access Control to a Field, use the `access` property in the [Field Config](../fields/overview):
-
-```ts
-import type { CollectionConfig } from 'payload';
+import { CollectionConfig } from 'payload';
 
 export const Posts: CollectionConfig = {
   slug: 'posts',
@@ -53,14 +39,6 @@ export const Posts: CollectionConfig = {
 };
 ```
 
-The following options are available:
-
-| Function                | Purpose                                                                          |
-| ----------------------- | -------------------------------------------------------------------------------- |
-| **`create`** | Allows or denies the ability to set a field's value when creating a new document. [More details](#create). |
-| **`read`**     | Allows or denies the ability to read a field's value. [More details](#read).       |
-| **`update`** | Allows or denies the ability to update a field's value [More details](#update).    |
-
 ### Create
 
 Returns a boolean which allows or denies the ability to set a field's value when creating a new document. If `false` is returned, any passed values will be discarded.

docs/access-control/globals.mdx

@@ -1,44 +1,35 @@
 ---
 title: Globals Access Control
 label: Globals
-order: 30
+order: 40
 desc: Global-level Access Control is specified within each Global's `access` property and allows you to define which users can read or update Globals.
 keywords: globals, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Global Access Control is [Access Control](../access-control) used to restrict access to [Global](../globals/overview) Documents, as well as what they can and cannot see within the [Admin Panel](../admin/overview) as it relates to that Global.
+You can define Global-level Access Control within each Global's `access` property. All Access Control functions accept one `args` argument.
 
-To add Access Control to a Global, use the `access` property in your [Global Config](../configuration/globals):
+## Available Controls
 
-```ts
-import type { GlobalConfig } from 'payload';
+| Function                | Allows/Denies Access                   |
+| ----------------------- | -------------------------------------- |
+| **[`read`](#read)**     | Used in the `findOne` Global operation |
+| **[`update`](#update)** | Used in the `update` Global operation  |
 
-export const GlobalWithAccessControl: GlobalConfig = {
-  // ...
-  access: { // highlight-line
-    // ...
-  },
-}
-```
-
-## Config Options
-
-Access Control is specific to the operation of the request.
-
-To add Access Control to a [Global](../configuration/globals), use the `access` property in the [Global Config](../globals/overview):
+**Example Global config:**
 
 ```ts
 import { GlobalConfig } from 'payload'
 
-const GlobalWithAccessControl: GlobalConfig = {
-  // ...
+const Header: GlobalConfig = {
+  slug: 'header',
   // highlight-start
   access: {
-    read: ({ req: { user } }) => {...},
-    update: ({ req: { user } }) => {...},
-
-    // Version-enabled Globals only
-    readVersion: () => {...},
+    read: ({ req: { user } }) => {
+      /* */
+    },
+    update: ({ req: { user } }) => {
+      /* */
+    },
   },
   // highlight-end
 }
@@ -46,97 +37,23 @@ const GlobalWithAccessControl: GlobalConfig = {
 export default Header
 ```
 
-The following options are available:
-
-| Function                | Allows/Denies Access                   |
-| ----------------------- | -------------------------------------- |
-| **`read`**     | Used in the `findOne` Global operation. [More details](#read). |
-| **`update`** | Used in the `update` Global operation. [More details](#update). |
-
-If a Global supports [Versions](../versions/overview), the following additional options are available:
-
-| Function           | Allows/Denies Access                                                                                                   |
-| ------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| **`readVersions`** | Used to control who can read versions, and who can't. Will automatically restrict the Admin UI version viewing access. [More details](#read-versions). |
-
 ### Read
 
-Returns a boolean result or optionally a [query constraint](../queries/overview) which limits who can read this global based on its current properties.
+Returns a boolean result or optionally a [query constraint](/docs/queries/overview) which limits who can read this global based on its current properties.
 
-To add read Access Control to a [Global](../configuration/globals), use the `read` property in the [Global Config](../globals/overview):
-
-```ts
-import { GlobalConfig } from 'payload'
-
-const Header: GlobalConfig = {
-  // ...
-  // highlight-start
-  read: {
-    read: ({ req: { user } }) => {
-      return Boolean(user)
-    },
-  }
-  // highlight-end
-}
-```
-
-The following arguments are provided to the `read` function:
+**Available argument properties:**
 
 | Option    | Description                                                                |
 | --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |
 
 ### Update
 
-Returns a boolean result or optionally a [query constraint](../queries/overview) which limits who can update this global based on its current properties.
+Returns a boolean result or optionally a [query constraint](/docs/queries/overview) which limits who can update this global based on its current properties.
 
-To add update Access Control to a [Global](../configuration/globals), use the `access` property in the [Global Config](../globals/overview):
-
-```ts
-import { GlobalConfig } from 'payload'
-
-const Header: GlobalConfig = {
-  // ...
-  // highlight-start
-  access: {
-    update: ({ req: { user }, data }) => {
-      return Boolean(user)
-    },
-  }
-  // highlight-end
-}
-```
-
-The following arguments are provided to the `update` function:
+**Available argument properties:**
 
 | Option     | Description                                                                |
 | ---------- | -------------------------------------------------------------------------- |
-| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |
+| **`req`**  | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user` |
 | **`data`** | The data passed to update the global with.                                 |
-
-### Read Versions
-
-If the Global has [Versions](../versions/overview) enabled, the `readVersions` Access Control function determines whether or not the currently logged in user can access the version history of a Document.
-
-To add Read Versions Access Control to a Collection, use the `readVersions` property in the [Global Config](../globals/overview):
-
-```ts
-import type { GlobalConfig } from 'payload'
-
-export const GlobalWithVersionsAccess: GlobalConfig = {
-  // ...
-  access: {
-    // highlight-start
-    readVersions: ({ req: { user }}) => {
-      return Boolean(user)
-    },
-    // highlight-end
-  },
-}
-```
-
-The following arguments are provided to the `readVersions` function:
-
-| Option    | Description                                                                |
-| --------- | -------------------------------------------------------------------------- |
-| **`req`** | The [Request](https://developer.mozilla.org/en-US/docs/Web/API/Request) object containing the currently authenticated `user`. |

docs/access-control/overview.mdx

@@ -2,59 +2,84 @@
 title: Access Control
 label: Overview
 order: 10
-desc: Payload makes it simple to define and manage Access Control. By declaring roles, you can set permissions and restrict what your users can interact with.
+desc: Payload makes it simple to define and manage access control. By declaring roles, you can set permissions and restrict what your users can interact with.
 keywords: overview, access control, permissions, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
+Access control within Payload is extremely powerful while remaining easy and intuitive to manage. Declaring who should have access to what documents is no more complex than writing a simple JavaScript function that either returns a `boolean` or a [`query`](/docs/queries/overview) constraint to restrict which documents users can interact with.
+
 <YouTube id="DoPLyXG26Dg" title="Overview of Payload Access Control" />
 
-Access Control determines what a user can and cannot do with any given Document, as well as what they can and cannot see within the [Admin Panel](../admin/overview). By implementing Access Control, you can define granular restrictions based on the user, their roles (RBAC), Document data, or any other criteria your application requires.
+**Example use cases:**
 
-Access Control functions are scoped to the _operation_, meaning you can have different rules for `create`, `read`, `update`, `delete`, etc. Access Control functions are executed _before_ any changes are made and _before_ any operations are completed. This allows you to determine if the user has the necessary permissions before fulfilling the request.
+- Allowing anyone `read` access to all `Post`s
+- Only allowing public access to `Post`s where a `status` field is equal to `published`
+- Giving only `User`s with a `role` field equal to `admin` the ability to delete `Page`(s)
+- Allowing anyone to create `ContactSubmission`s, but only logged in users to `read`, `update` or `delete` them
+- 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
 
-There are many use cases for Access Control, including:
+## Default Settings
 
-- Allowing anyone `read` access to all posts
-- Only allowing public access to posts where a `status` field is equal to `published`
-- Giving only users with a `role` field equal to `admin` the ability to delete posts
-- Allowing anyone to submit contact forms, but only logged in users to `read`, `update` or `delete` them
-- Restricting a user to only be able to see their own orders, but no-one else's
-- Allowing users that belong to a certain organization to access only that organization's resources
+**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 `req` and returns `true` if a user is logged in, and `false` if not.
 
-There are three main types of Access Control in Payload:
-
-- [Collection Access Control](./collections)
-- [Global Access Control](./globals)
-- [Field Access Control](./fields)
-
-## Default Access Control
-
-Payload provides default Access Control so that your data is secured behind [Authentication](../authentication) without additional configuration. To do this, Payload sets a default function that simply checks if a user is present on the request. You can override this default behavior by defining your own Access Control functions as needed.
-
-Here is the default Access Control that Payload provides:
+**Default Access function:**
 
 ```ts
 const defaultPayloadAccess = ({ req: { user } }) => {
   // Return `true` if a user is found
   // and `false` if it is undefined or null
-  return Boolean(user) // highlight-line
+  return Boolean(user)
 }
 ```
 
-<Banner type="warning">
-  <strong>Important:</strong>
-  In the [Local API](../local-api/overview), all Access Control is _skipped_ by default. This allows your server to have full control over your application. To opt back in, you can set the `overrideAccess` option to `false` in your requests.
+<Banner type="success">
+  <strong>Note:</strong>
+  <br />
+  In the Local API, all Access Control functions are skipped by default, allowing your server to do
+  whatever it needs. But, you can opt back in by setting the option
+  <strong>
+    overrideAccess
+  </strong>
+  {' '}
+  to <strong>false</strong>.
 </Banner>
 
-## The Access Operation
+## Access Control Types
 
-The Admin Panel responds dynamically to your changes to Access Control. For example, if you restrict editing `ExampleCollection` to only users that feature an "admin" role, Payload will **hide** that Collection from the Admin Panel entirely. This is super powerful and allows you to control who can do what within your Admin Panel using the same functions that secure your APIs.
+You can manage access within Payload on three different levels:
 
-To accomplish this, Payload exposes the [Access Operation](../authentication/operations#access). Upon login, Payload executes each Access Control function at the top level, across all Collections, Globals, and Fields, and returns a response that contains a reflection of what the currently authenticated user can do within your application.
+- [Collections](/docs/access-control/collections)
+- [Fields](/docs/access-control/fields)
+- [Globals](/docs/access-control/globals)
+
+## When Access Control is Executed
+
+<Banner type="success">
+  <strong>Note:</strong>
+  <br />
+  Access control functions are utilized in two places. It's important to understand how and when
+  your access control is executed.
+</Banner>
+
+### 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
+
+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
 
 <Banner type="warning">
   <strong>Important:</strong>
-  When your access control functions are executed via the [Access Operation](../authentication/operations#access),  the `id` and `data` arguments will be `undefined`. This is because Payload is executing your functions without referencing a specific Document.
+  <br />
+  When your access control functions are executed via the <strong>access</strong> operation, the{' '}
+  <strong>id</strong> and <strong>data</strong> arguments will be <strong>undefined</strong>,
+  because Payload is executing your functions without referencing a specific document.
 </Banner>
 
-If you use `id` or `data` within your access control functions, make sure to check that they are defined first. If they are not, then you can assume that your Access Control is being executed via the Access Operation to determine solely what the user can do within the Admin Panel.
+If you use `id` or `data` within your access control functions, make sure to check that they are defined first. If they are not, then you can assume that your access control is being executed via the `access` operation, to determine solely what the user can do within the Admin UI.

docs/admin/collections.mdx

@@ -1,173 +0,0 @@
----
-title: Collection Admin Config
-label: Collections
-order: 20
-desc:
-keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-The behavior of [Collections](../configuration/collections) within the [Admin Panel](./overview) can be fully customized to fit the needs of your application. This includes grouping or hiding their navigation links, adding [Custom Components](./components), selecting which fields to display in the List View, and more.
-
-To configure Admin Options for Collections, use the `admin` property in your Collection Config:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const MyCollection: CollectionConfig = {
-  // ...
-  admin: { // highlight-line
-    // ...
-  },
-}
-```
-
-## Admin Options
-
-The following options are available:
-
-| 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 details](../hooks/collections).                                                                                                                                       |
-| **`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. A field with `virtual: true` cannot be used as the title.      |
-| **`description`**                | Text to display below the Collection label in the List View to give editors more information. Alternatively, you can use the `admin.components.Description` to render a React component. [More details](#components). |
-| **`defaultColumns`**             | Array of field names that correspond to which columns to show by default in this Collection's List View.                                                                                                              |
-| **`hideAPIURL`**                 | Hides the "API URL" meta field while editing documents within this Collection.                                                                                                                                        |
-| **`enableRichTextLink`**         | The [Rich Text](../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](../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`**                       | Page metadata overrides to apply to this Collection within the Admin Panel. [More details](./metadata).                                                                                                               |
-| **`preview`**                    | Function to generate preview URLs within the Admin Panel that can point to your app. [More details](#preview).                                                                                                        |
-| **`livePreview`**                | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).                                                                                         |
-| **`components`**                 | Swap in your own React components to be used within this Collection. [More details](#components).                                                                                                                     |
-| **`listSearchableFields`**       | Specify which fields should be searched in the List search view. [More details](#list-searchable-fields).                                                                                                             |
-| **`pagination`**                 | Set pagination-specific options for this Collection. [More details](#pagination).                                                                                                                                     |
-
-### Components
-
-Collections can set their own [Custom Components](./components) which only apply to [Collection](../configuration/collections)-specific UI within the [Admin Panel](./overview). This includes elements such as the Save Button, or entire layouts such as the Edit View.
-
-To override Collection Components, use the `admin.components` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollection: SanitizedCollectionConfig = {
-  // ...
-  admin: {
-    components: { // highlight-line
-      // ...
-    },
-  },
-}
-```
-
-The following options are available:
-
-| Path                       | Description                                                                                                            |
-| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| **`beforeList`**           | An array of components to inject _before_ the built-in List View                                                          |
-| **`beforeListTable`**      | An array of components to inject _before_ the built-in List View's table                                                  |
-| **`afterList`**            | An array of components to inject _after_ the built-in List View                                                           |
-| **`afterListTable`**       | An array of components to inject _after_ the built-in List View's table
-| **`Description`**          | A component to render below the Collection label in the List View. An alternative to the `admin.description` property. |
-| **`edit.SaveButton`**      | Replace the default Save Button with a Custom Component. [Drafts](../versions/drafts) must be disabled.                                     |
-| **`edit.SaveDraftButton`** | Replace the default Save Draft Button with a Custom Component. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. |
-| **`edit.PublishButton`**   | Replace the default Publish Button with a Custom Component. [Drafts](../versions/drafts) must be enabled.                                  |
-| **`edit.PreviewButton`**   | Replace the default Preview Button with a Custom Component. [Preview](#preview) must be enabled.                                         |
-| **`views`**                | Override or create new views within the Admin Panel. [More details](./views).                                     |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components).
-</Banner>
-
-### Preview
-
-It is possible to display a Preview Button within the Edit View of the Admin Panel. This will allow editors to visit the frontend of your app the corresponds to the document they are actively editing. This way they can preview the latest, potentially unpublished changes.
-
-To configure the Preview Button, set the `admin.preview` property to a function in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Posts: CollectionConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    preview: (doc, { locale }) => {
-      if (doc?.slug) {
-        return `/${doc.slug}?locale=${locale}`
-      }
-
-      return null
-    },
-    // highlight-end
-  },
-}
-```
-
-The preview function receives two arguments:
-
-| Argument | Description |
-| --- | --- |
-| **`doc`** | The Document being edited. |
-| **`ctx`** | An object containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT. |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  For fully working example of this, check of the official [Draft Preview Example](https://github.com/payloadcms/payload/tree/main/examples/draft-preview) in the [Examples Directory](https://github.com/payloadcms/payload/tree/main/examples).
-</Banner>
-
-### Pagination
-
-All Collections receive their own List View which displays a paginated list of documents that can be sorted and filtered. The pagination behavior of the List View can be customized on a per-Collection basis, and uses the same [Pagination](../queries/pagination) API that Payload provides.
-
-To configure pagination options, use the `admin.pagination` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Posts: CollectionConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    pagination: {
-      defaultLimit: 10,
-      limits: [10, 20, 50],
-    },
-    // highlight-end
-  },
-}
-```
-
-The following options are available:
-
-| 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. |
-
-### List Searchable Fields
-
-In the List View, there is a "search" box that allows you to quickly find a document through a simple text search. By default, it searches on the ID field. If defined, the `admin.useAsTitle` field is used. Or, you can explicitly define which fields to search based on the needs of your application.
-
-To define which fields should be searched, use the `admin.listSearchableFields` property in your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Posts: CollectionConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    listSearchableFields: ['title', 'slug'],
-    // highlight-end
-  },
-}
-```
-
-<Banner type="warning">
-  <strong>Tip:</strong>
-  If you are adding `listSearchableFields`, make sure you index each of these fields so your admin queries can remain performant.
-</Banner>

docs/admin/components.mdx

@@ -1,266 +1,52 @@
 ---
 title: Swap in your own React components
 label: Custom Components
-order: 40
+order: 20
 desc: Fully customize your Admin Panel by swapping in your own React components. Add fields, remove views, update routes and change functions to sculpt your perfect Dashboard.
 keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-The Payload [Admin Panel](./overview) is designed to be as minimal and straightforward as possible to allow for both easy customization and full control over the UI. In order for Payload to support this level of customization, Payload provides a pattern for you to supply your own React components through your [Payload Config](../configuration/overview).
+The [Payload Admin Panel](./overview) is designed to be as minimal and straightforward as possible to allow for both easy customization and full control over the UI. In order for Payload to support this level of customization, Payload provides a pattern for you to supply your own React components through your [Payload Config](../configuration/overview).
 
-All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api/overview) directly on the front-end. Custom Components are available for nearly every part of the Admin Panel for extreme granularity and control.
+All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api) directly in the front-end. Custom Components are available for nearly every part of the Admin Panel for extreme granularity and control.
 
 <Banner type="success">
   <strong>Note:</strong>
-  Client Components continue to be fully supported. To use Client Components in your app, simply include the `use client` directive. Payload will automatically detect and remove all default, [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types) before rendering your component. [More details](#client-components).
+  Client Components continue to be fully supported. To use Client Components in your app, simply include the `use client` directive. Payload will automatically detect and remove all default [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types) before rendering your component. [More details](#client-components).
 </Banner>
 
+To swap in your own Custom Component, consult the list of available components below. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-components) accordingly.
+
 There are four main types of Custom Components in Payload:
 
-- [Root Components](#root-components)
-- [Collection Components](./collections#components)
-- [Global Components](./globals#components)
+- [Root Components](#custom-root-components)
+- [Collection Components](#custom-collection-components)
+- [Global Components](#custom-global-components)
 - [Field Components](./fields)
 
-To swap in your own Custom Component, consult the list of available components. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-components) accordingly.
+## Custom Root Components
 
+Root Components are those that effect the [Admin Panel](./overview) generally, such as the logo. You can override Root Components through the `admin.components` property of the [Payload Config](../getting-started/overview).
 
-## Defining Custom Components in the Payload Config
-
-In the Payload Config, you can define custom React Components to enhance the admin interface. However, these components should not be imported directly into the server-only Payload Config to avoid including client-side code. Instead, you specify the path to the component. Here’s how you can do it:
-
-
-src/components/Logout.tsx
-```tsx
-'use client'
-import React from 'react'
-
-export const MyComponent = () => {
-  return (
-    <button>Click me!</button>
-  )
-}
-```
-
-payload.config.ts:
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  admin: { // highlight-line
-    components: {
-      logout: {
-        Button: '/src/components/Logout#MyComponent'
-      }
-    }
-  },
-})
-```
-
-In the path `/src/components/Logout#MyComponent`, `/src/components/Logout` is the file path, and `MyComponent` is the named export. If the component is the default export, the export name can be omitted. Path and export name are separated by a `#`.
-
-### Configuring the Base Directory
-
-Component paths, by default, are relative to your working directory - this is usually where your Next.js config lies. To simplify component paths, you have the option to configure the *base directory* using the `admin.baseDir.baseDir` property:
+Here is an example showing what it might look like to swap out Root Components for your own. See [Building Custom Components](#building-custom-components) for exact details on how to build them:
 
 ```ts
 import { buildConfig } from 'payload'
-import { fileURLToPath } from 'node:url'
-import path from 'path'
-const filename = fileURLToPath(import.meta.url)
-const dirname = path.dirname(filename)
 
-const config = buildConfig({
-  // ...
-  admin: { // highlight-line
-     importMap: {
-      baseDir: path.resolve(dirname, 'src'),
-    },
-    components: {
-      logout: {
-        Button: '/components/Logout#MyComponent'
-      }
-    }
-  },
-})
-```
-
-In this example, we set the base directory to the `src` directory - thus we can omit the `/src/` part of our component path string.
-
-### Passing Props
-
-Each React Component in the Payload Config is typed as `PayloadComponent`. This usually is a string, but can also be an object containing the following properties:
-
-| Property      | Description                                                                                                                   |
-|---------------|-------------------------------------------------------------------------------------------------------------------------------|
-| `clientProps` | Props to be passed to the React Component if it's a Client Component                                                          |
-| `exportName`  | Instead of declaring named exports using `#` in the component path, you can also omit them from `path` and pass them in here. |
-| `path`        | Path to the React Component. Named exports can be appended to the end of the path, separated by a `#`                         |
-| `serverProps` | Props to be passed to the React Component if it's a Server Component                                                          |
-
-To pass in props from the config, you can use the `clientProps` and/or `serverProps` properties. This alleviates the need to use an HOC (Higher-Order-Component) to declare a React Component with props passed in.
-
-Here is an example:
-
-src/components/Logout.tsx
-```tsx
-'use client'
-import React from 'react'
-
-export const MyComponent = ({ text }: { text: string }) => {
-  return (
-    <button>Click me! {text}</button>
-  )
-}
-```
-
-payload.config.ts:
-```ts
-import { buildConfig } from 'payload'
-
-const config = buildConfig({
-  // ...
-  admin: { // highlight-line
-    components: {
-      logout: {
-        Button: {
-          path: '/src/components/Logout',
-          clientProps: {
-            text: 'Some Text.'
-          },
-          exportName: 'MyComponent'
-        }
-      }
-    }
-  },
-})
-```
-
-### Import Maps
-
-It's essential to understand how `PayloadComponent` paths function behind the scenes. Directly importing React Components into your Payload Config using import statements can introduce client-only modules like CSS into your server-only config. This could error when attempting to load the Payload Config in server-only environments and unnecessarily increase the size of the Payload Config, which should remain streamlined and efficient for server use.
-
-Instead, we utilize component paths to reference React Components. This method enhances the Payload Config with actual React Component imports on the client side, without affecting server-side usage. A script is deployed to scan the Payload Config, collecting all component paths and creating an `importMap.js`. This file, located in app/(payload)/admin/importMap.js, must be statically imported by your Next.js root page and layout. The script imports all the React Components from the specified paths into a Map, associating them with their respective paths (the ones you defined).
-
-When constructing the `ClientConfig`, Payload uses the component paths as keys to fetch the corresponding React Component imports from the Import Map. It then substitutes the `PayloadComponent` with a `MappedComponent`. A `MappedComponent` includes the React Component and additional metadata, such as whether it's a server or a client component and which props it should receive. These components are then rendered through the `<RenderComponent />` component within the Payload Admin Panel.
-
-Import maps are regenerated whenever you modify any element related to component paths. This regeneration occurs at startup and whenever Hot Module Replacement (HMR) runs. If the import maps fail to regenerate during HMR, you can restart your application and execute the `payload generate:importmap` command to manually create a new import map. If you encounter any errors running this command, see the [Troubleshooting](../local-api/outside-nextjs#troubleshooting) section.
-
-### Component paths in external packages
-
-Component paths are resolved relative to your project's base directory, which is either your current working directory or the directory specified in `config.admin.baseDir`. When using custom components from external packages, you can't use relative paths. Instead, use an import path that's accessible as if you were writing an import statement in your project's base directory.
-
-For example, to export a field with a custom component from an external package named `my-external-package`:
-
-```ts
-import type { Field } from 'payload'
-export const MyCustomField: Field = {
-  type: 'text',
-  name: 'MyField',
-  admin: {
-    components: {
-      Field: 'my-external-package/client#MyFieldComponent'
-    }
-  }
-}
-```
-
-Despite `MyFieldComponent` living in `src/components/MyFieldComponent.tsx` in `my-external-package`, this will not be accessible from the consuming project. Instead, we recommend exporting all custom components from one file in the external package. For example, you can define a `src/client.ts file in `my-external-package`:
-
-```ts
-'use client'
-export { MyFieldComponent } from './components/MyFieldComponent'
-```
-
-Then, update the package.json of `my-external-package:
-
-```json
-{
-...
-  "exports": {
-    "./client": {
-        "import": "./dist/client.js",
-        "types": "./dist/client.d.ts",
-        "default": "./dist/client.js"
-    }
-  }
-}
-```
-
-This setup allows you to specify the component path as `my-external-package/client#MyFieldComponent` as seen above. The import map will generate:
-
-```ts
-import { MyFieldComponent } from 'my-external-package/client'
-```
-
-which is a valid way to access MyFieldComponent that can be resolved by the consuming project.
-
-### Custom Components from unknown locations
-
-By default, any component paths from known locations are added to the import map. However, if you need to add any components from unknown locations to the import map, you can do so by adding them to the `admin.dependencies` array in your Payload Config. This is mostly only relevant for plugin authors and not for regular Payload users.
-
-Example:
-
-```ts
-export default {
-  // ...
-  admin: {
-    // ...
-    dependencies: {
-      myTestComponent: { // myTestComponent is the key - can be anything
-        path: '/components/TestComponent.js#TestComponent',
-        type: 'component',
-        clientProps: {
-          test: 'hello',
-        },
-      },
-    },
-  }
-}
-```
-
-This way, `TestComponent` is added to the import map, no matter if it's referenced in a known location or not. On the client, you can then use the component like this:
-
-```tsx
-'use client'
-
-import { RenderComponent, useConfig } from '@payloadcms/ui'
-import React from 'react'
-
-export const CustomView = () => {
-  const { config } = useConfig()
-  return (
-    <div>
-      <RenderComponent mappedComponent={config.admin.dependencies?.myTestComponent} />
-    </div>
-  )
-}
-```
-
-## Root Components
-
-Root Components are those that effect the [Admin Panel](./overview) generally, such as the logo or the main nav.
-
-To override Root Components, use the `admin.components` property in your [Payload Config](../getting-started/overview):
-
-```ts
-import { buildConfig } from 'payload'
+import { MyCustomLogo } from './MyCustomLogo'
 
 export default buildConfig({
   // ...
   admin: {
-    // highlight-start
     components: {
-      // ...
+      graphics: {
+        Logo: MyCustomLogo, // highlight-line
+      },
     },
-    // highlight-end
   },
 })
 ```
 
-_For details on how to build Custom Components, see [Building Custom Components](#building-custom-components)._
-
 The following options are available:
 
 | Path                  | Description                                                                                                                                                                                                         |
@@ -275,30 +61,30 @@ The following options are available:
 | **`logout.Button`**   | The button displayed in the sidebar that logs the user out.                                                                                                                                                         |
 | **`graphics.Icon`**   | The simplified logo used in contexts like the the `Nav` component.                                                                                                                                                  |
 | **`graphics.Logo`**   | The full logo used in contexts like the `Login` view.                                                                                                                                                               |
-| **`providers`**       | Custom [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context) providers that will wrap the entire Admin Panel. [More details](#custom-providers).                                       |
-| **`actions`**         | An array of Custom Components to be rendered _within_ the header of the Admin Panel, providing additional interactivity and functionality.                                                                  |
-| **`header`**          | An array of Custom Components to be injected above the Payload header.                                                   |
-| **`views`**           | Override or create new views within the Admin Panel. [More details](./views).                                                                                                                                 |
+| **`providers`**       | Custom [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context) providers that will wrap the entire [Admin Panel](./overview). [More details](#custom-providers).                                       |
+| **`actions`**         | An array of Custom Components to be rendered in the header of the [Admin Panel](./overview), providing additional interactivity and functionality.                                                                  |
+| **`views`**           | Override or create new views within the [Admin Panel](./overview). [More details](./views).                                                                                                                                 |
 
 <Banner type="success">
-  <strong>Note:</strong>
-  You can also use set [Collection Components](./collections#components) and [Global Components](./globals#components) in their respective configs.
+  <strong>Note:</strong> You can also use the `admin.components` property on any Collection Config or Global Config to set [Custom Collection Components](#custom-collection-components) or [Custom Global Components](#custom-global-components).
 </Banner>
 
 ### Custom Providers
 
-As you add more and more Custom Components to your [Admin Panel](./overview), you may find it helpful to add additional [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context)(s). Payload allows you to inject your own context providers in your app so you can export your own custom hooks, etc.
+You can add additional [React Context](https://react.dev/learn/scaling-up-with-reducer-and-context) to any Payload app through Custom Providers. As you add more and more Custom Components to your [Admin Panel](./overview), this is a great way to share state across all of them.
 
-To add a Custom Provider, use the `admin.components.providers` property in your [Payload Config](../getting-started/overview):
+To do this, add `admin.components.providers` to your config:
 
 ```ts
 import { buildConfig } from 'payload'
 
+import { MyProvider } from './MyProvider'
+
 export default buildConfig({
   // ...
   admin: {
     components: {
-      providers: ['/path/to/MyProvider'], // highlight-line
+      providers: [MyProvider], // highlight-line
     },
   },
 })
@@ -327,11 +113,81 @@ export const useMyCustomContext = () => useContext(MyCustomContext)
   <strong>Reminder:</strong> Custom Providers are by definition Client Components. This means they must include the `use client` directive at the top of their files and cannot use server-only code.
 </Banner>
 
+## Custom Collection Components
+
+Collection Components are those that effect [Collection](../configuration/collections)-specific UI within the [Admin Panel](./overview), such as the save button. You can override Collection Components through the `admin.components` property on any [Collection Config](../configuration/collections).
+
+Here is an example showing what it might look like to swap out Collection Components for your own. See [Building Custom Components](#building-custom-components) for exact details on how to build them:
+
+```ts
+import type { SanitizedCollectionConfig } from 'payload/types'
+import { CustomSaveButton } from './CustomSaveButton'
+
+export const MyCollection: SanitizedCollectionConfig = {
+  slug: 'my-collection',
+  admin: {
+    components: {
+      edit: {
+        SaveButton: CustomSaveButton, // highlight-line
+      },
+    },
+  },
+  // ...
+}
+```
+
+The following options are available:
+
+| Path                       | Description                                                                                                            |
+| -------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
+| **`beforeList`**           | An array of components to inject _before_ the built-in List View                                                          |
+| **`beforeListTable`**      | An array of components to inject _before_ the built-in List View's table                                                  |
+| **`afterList`**            | An array of components to inject _after_ the built-in List View                                                           |
+| **`afterListTable`**       | An array of components to inject _after_ the built-in List View's table                                                   |
+| **`edit.SaveButton`**      | Replace the default `Save` button with a Custom Component. Drafts must be disabled                                     |
+| **`edit.SaveDraftButton`** | Replace the default `Save Draft` button with a Custom Component. Drafts must be enabled and autosave must be disabled. |
+| **`edit.PublishButton`**   | Replace the default `Publish` button with a Custom Component. Drafts must be enabled.                                  |
+| **`edit.PreviewButton`**   | Replace the default `Preview` button with a Custom Component.                                                          |
+| **`views`**                | Override or create new views within the [Admin Panel](./overview). [More details](./views).                                     |
+
+## Custom Global Components
+
+Global Components are those that effect [Global](../configuration/globals)-specific UI within the [Admin Panel](./overview), such as the save button. You can override Global Components through the `admin.components` property on any [Global Config](../configuration/globals).
+
+Here is an example showing what it might look like to swap out Global Components for your own. See [Building Custom Components](#building-custom-components) for exact details on how to build them:
+
+```ts
+import type { SanitizedGlobalConfig } from 'payload/types'
+import { CustomSaveButton } from './CustomSaveButton'
+
+export const MyGlobal: SanitizedGlobalConfig = {
+  slug: 'my-global',
+  admin: {
+    components: {
+      elements: {
+        SaveButton: CustomSaveButton, // highlight-line
+      },
+    },
+  },
+  // ...
+}
+```
+
+The following options are available:
+
+| Path                           | Description                                                                                                            |
+| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
+| **`elements.SaveButton`**      | Replace the default `Save` button with a Custom Component. Drafts must be disabled.                                    |
+| **`elements.SaveDraftButton`** | Replace the default `Save Draft` button with a Custom Component. Drafts must be enabled and autosave must be disabled. |
+| **`elements.PublishButton`**   | Replace the default `Publish` button with a Custom Component. Drafts must be enabled.                                  |
+| **`elements.PreviewButton`**   | Replace the default `Preview` button with a Custom Component.                                                          |
+| **`views`**                    | Override or create new views within the [Admin Panel](./overview). [More details](./views).                                     |
+
 ## Building Custom Components
 
-All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api/overview) directly on the front-end, among other things.
+All Custom Components in Payload are [React Server Components](https://react.dev/reference/rsc/server-components) by default, with the exception of [Custom Providers](#custom-providers). This enables the use of the [Local API](../local-api) directly in the front-end.
 
-To make building Custom Components as easy as possible, Payload automatically provides common props, such as the [`payload`](../local-api/overview) class and the [`i18n`](../configuration/i18n) object. This means that when building Custom Components within the Admin Panel, you do not have to get these yourself.
+To make building Custom Components as easy as possible, Payload automatically provides common props, such as the [`payload`](../local-api/overview) class and the [`i18n`](../configuration/i18n) object. This means that when building Custom Components within the Admin Panel, you do not have to get these yourself like you would from an external application.
 
 Here is an example:
 
@@ -357,17 +213,17 @@ Each Custom Component receives the following props by default:
 | Prop                      | Description                                                                                           |
 | ------------------------- | ----------------------------------------------------------------------------------------------------- |
 | `payload`                 | The [Payload](../local-api/overview) class.                                                           |
-| `i18n`                    | The [i18n](../configuration/i18n) object.                                                                           |
+| `i18n`                    | The [i18n](../i18n) object.                                                                           |
 
 Custom Components also receive various other props that are specific to the context in which the Custom Component is being rendered. For example, [Custom Views](./views) receive the `user` prop. For a full list of available props, consult the documentation related to the specific component you are working with.
 
 <Banner type="success">
-  See [Root Components](#root-components), [Collection Components](#collection-components), [Global Components](#global-components), or [Field Components](#custom-field-components) for a complete list of all available components.
+  See [Root Components](#custom-root-components), [Collection Components](#custom-collection-components), [Global Components](#custom-global-components), or [Field Components](#custom-field-components) for a complete list of all available components.
 </Banner>
 
 ### Client Components
 
-When [Building Custom Components](#building-custom-components), it's still possible to use client-side code such as `useState` or the `window` object. To do this, simply add the `use client` directive at the top of your file. Payload will automatically detect and remove all default, [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types) before rendering your component.
+When [Building Custom Components](#building-custom-components), it's still possible to use client-side code such as `useState` or the `window` object. To do this, simply add the `use client` directive at the top of your file. Payload will automatically detect and remove all default [non-serializable props](https://react.dev/reference/rsc/use-client#serializable-types) before rendering your component.
 
 ```tsx
 'use client' // highlight-line
@@ -391,7 +247,7 @@ export const MyClientComponent: React.FC = () => {
 
 ### Accessing the Payload Config
 
-From any Server Component, the [Payload Config](../configuration/overview) can be accessed directly from the `payload` prop:
+From any Server Component, the [Payload Config](../configuration/overview) can be retrieved using the `payload` prop:
 
 ```tsx
 import React from 'react'
@@ -409,7 +265,7 @@ export default async function MyServerComponent({
 }
 ```
 
-But, the Payload Config is [non-serializable](https://react.dev/reference/rsc/use-client#serializable-types) by design. It is full of custom validation functions, React components, etc. This means that the Payload Config, in its entirety, cannot be passed directly to Client Components.
+But the Payload Config is [non-serializable](https://react.dev/reference/rsc/use-client#serializable-types) by design. It is full of custom validation functions, React components, etc. This means that the Payload Config, in its entirety, cannot be passed directly to Client Components.
 
 For this reason, Payload creates a Client Config and passes it into the Config Provider. This is a serializable version of the Payload Config that can be accessed from any Client Component via the [`useConfig`](./hooks#useconfig) hook:
 
@@ -418,7 +274,7 @@ import React from 'react'
 import { useConfig } from '@payloadcms/ui'
 
 export const MyClientComponent: React.FC = () => {
-  const { config: { serverURL } } = useConfig() // highlight-line
+  const { serverURL } = useConfig() // highlight-line
 
   return (
     <Link href={serverURL}>
@@ -432,22 +288,6 @@ export const MyClientComponent: React.FC = () => {
   See [Using Hooks](#using-hooks) for more details.
 </Banner>
 
-All [Field Components](./fields) automatically receive their respective Field Config through a common [`field`](./fields#the-field-prop) prop:
-
-```tsx
-'use client'
-import React from 'react'
-import type { TextFieldClientComponent } from 'payload'
-
-export const MyClientFieldComponent: TextFieldClientComponent = ({ field: { name } }) => {
-  return (
-    <p>
-      {`This field's name is ${name}`}
-    </p>
-  )
-}
-```
-
 ### Using Hooks
 
 To make it easier to [build your Custom Components](#building-custom-components), you can use [Payload's built-in React Hooks](./hooks) in any Client Component. For example, you might want to interact with one of Payload's many React Contexts:
@@ -558,7 +398,7 @@ const Greeting: React.FC = () => {
 
 ### Styling Custom Components
 
-Payload has a robust [CSS Library](./customizing-css) that you can use to style your Custom Components similarly to Payload's built-in styling. This will ensure that your Custom Components match the existing design system, and so that they automatically adapt to any theme changes that might occur.
+Payload has a robust [CSS Library](./customizing-css) that you can style your Custom Components similarly to Payload's built-in styling. This will ensure that your Custom Component matches the existing design system, and so that it automatically adapts to any theme changes.
 
 To apply custom styles, simply import your own `.css` or `.scss` file into your Custom Component:
 

docs/admin/customizing-css.mdx

@@ -1,7 +1,7 @@
 ---
 title: Customizing CSS & SCSS
 label: Customizing CSS
-order: 80
+order: 60
 desc: Customize the Payload Admin Panel further by adding your own CSS or SCSS style sheet to the configuration, powerful theme and design options are waiting for you.
 keywords: admin, css, scss, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
@@ -33,27 +33,6 @@ Here is an example of how you might target the Dashboard View and change the bac
   If you are building [Custom Components](./overview), it is best to import your own stylesheets directly into your components, rather than using the global stylesheet. You can continue to use the [CSS library](#css-library) as needed.
 </Banner>
 
-### Specificity rules
-
-All Payload CSS is encapsulated inside CSS layers under `@layer payload-default`. Any custom css will now have the highest possible specificity.
-
-We have also provided a layer `@layer payload` if you want to use layers and ensure that your styles are applied after payload.
-
-To override existing styles in a way that the previous rules of specificity would be respected you can use the default layer like so
-```css
-@layer payload-default {
-  // my styles within the payload specificity
-}
-```
-
-## Re-using Payload SCSS variables and utilities
-
-You can re-use Payload's SCSS variables and utilities in your own stylesheets by importing it from the UI package.
-
-```scss
-@import '~@payloadcms/ui/scss';
-```
-
 ## CSS Library
 
 To make it as easy as possible for you to override default 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, including targeting nested components and their various component states.

docs/admin/environment-vars.mdx

@@ -0,0 +1,78 @@
+---
+title: Environment Variables in the Admin Panel
+label: Environment Variables
+order: 100
+desc: NEEDS TO BE WRITTEN
+---
+
+Environment variables are a way to store sensitive information that your application needs to function. This could be anything from API keys to database credentials. Payload allows you to provide environment variables to your [Admin Panel](./overview) that can be accessed by your [Custom Components](./components) and [Custom Endpoints](../rest-api/overview#custom-endpoints).
+
+For security and safety reasons, the Admin Panel not **not** include environment variables in client-side bundle by default. But, Payload provides a mechanism to expose environment variables to the client-side bundle when needed.
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  <br />
+  Be careful about what variables you provide to your client-side code. Analyze every single one to
+  make sure that you're not accidentally leaking anything that an outside attacker could exploit. Only keys
+  that are safe for anyone to read in plain text should be provided to your [Admin Panel](./overview).
+</Banner>
+
+## Client-side Environments
+
+If you are building [Custom Components](./components) that are using Client Components and need to access environment variables from the client-side, you can do so by prefixing your environment variables with `NEXT_PUBLIC_`.
+
+For example, if you've got the following environment variable:
+
+```bash
+NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXX
+```
+
+This key will automatically be made available to the client-side Payload bundle and can be referenced in your Custom Component as follows:
+
+```tsx
+'use client'
+import React from 'react'
+
+const stripeKey = process.env.NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY // highlight-line
+
+const MyClientComponent = () => {
+  // do something with the key
+
+  return (
+    <div>
+      My Client Component
+    </div>
+  )
+}
+```
+
+<Banner type="info">
+  <strong>Note:</strong>
+  For more information on how to use environment variables in the [Admin Panel](./overview), see the [Next.js documentation](https://nextjs.org/docs/pages/building-your-application/configuring/environment-variables).
+</Banner>
+
+## Server-side Environments
+
+All [Custom Endpoints](../rest-api/overview#custom-endpoints) and [Custom Components](./components) that are Server Components are unaffected by this restriction and can access any environment variables you provide. For example, if you've got the following environment variable:
+
+```bash
+STRIPE_SECRET=sk_test_XXXXXXXXXXXXXXXXXX
+```
+
+This key will be available to your Server Components as follows:
+
+```tsx
+import React from 'react'
+
+const stripeSecret = process.env.STRIPE_SECRET // highlight-line
+
+const MyServerComponent = async () => {
+  // do something with the secret
+
+  return (
+    <div>
+      My Server Component
+    </div>
+  )
+}
+```

docs/admin/fields.mdx

@@ -1,572 +1,195 @@
 ---
 title: Customizing Fields
 label: Customizing Fields
-order: 60
+order: 40
 desc:
 keywords:
 ---
 
-[Fields](../fields/overview) within the [Admin Panel](./overview) can be endlessly customized in their appearance and behavior without affecting their underlying data structure. Fields are designed to withstand heavy modification or even complete replacement through the use of [Custom Field Components](#field-components), [Conditional Logic](#conditional-logic), [Custom Validations](../fields/overview#validation), and more.
-
-For example, your app might need to render a specific interface that Payload does not inherently support, such as a color picker. To do this, you could replace the default [Text Field](../fields/text) input with your own user-friendly component that formats the data into a valid color value.
+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.
 
 <Banner type="success">
   <strong>Tip:</strong>
-  Don't see a built-in field type that you need? Build it! Using a combination of [Field Validations](../fields/overview#validation)
-  and [Custom Components](./components), you can override the entirety of how a component functions within the [Admin Panel](./overview) to effectively create your own field type.
+  <br />
+  Don't see a built-in field type that you need? Build it! Using a combination of custom validation
+  and custom components, you can override the entirety of how a component functions within the admin
+  panel and effectively create your own field type.
 </Banner>
 
-## Admin Options
-
-You can customize the appearance and behavior of fields within the [Admin Panel](./overview) through the `admin` property of any [Field Config](../fields/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionConfig: CollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      name: 'myField',
-      type: 'text',
-      admin: { // highlight-line
-        // ...
-      },
-    }
-  ]
-}
-```
-
-The following options are available:
-
-| Option                  | Description                                                                                                                                                                                                                      |
-| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`condition`**         | Programmatically show / hide fields based on other fields. [More details](../admin/fields#conditional-logic).                                                                                                                    |
-| **`components`**        | All Field Components can be swapped out for [Custom Components](../admin/components) that you define. [More details](../admin/fields).                                                                                           |
-| **`description`**       | Helper text to display alongside the field to provide more information for the editor. [More details](../admin/fields#description).                                                                                              |
-| **`position`**          | Specify if the field should be rendered in the sidebar by defining `position: 'sidebar'`.                                                                                                                                        |
-| **`width`**             | Restrict the width of a field. You can pass any string-based value here, be it pixels, percentages, etc. This property is especially useful when fields are nested within a `Row` type where they can be organized horizontally. |
-| **`style`**             | [CSS Properties](https://developer.mozilla.org/en-US/docs/Web/CSS) to inject into the root element of the field.                                                                                                                 |
-| **`className`**         | Attach a [CSS class attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/Class_selectors) to the root DOM element of a field.                                                                                             |
-| **`readOnly`**          | Setting a field to `readOnly` has no effect on the API whatsoever but disables the admin component's editability to prevent editors from modifying the field's value.                                                            |
-| **`disabled`**          | If a field is `disabled`, it is completely omitted from the [Admin Panel](../admin/overview).                                                                                                                                    |
-| **`disableBulkEdit`**   | Set `disableBulkEdit` to `true` to prevent fields from appearing in the select options when making edits for multiple documents. Defaults to `true` for UI fields.                                                               |
-| **`disableListColumn`** | Set `disableListColumn` to `true` to prevent fields from appearing in the list view column selector.                                                                                                                             |
-| **`disableListFilter`** | Set `disableListFilter` to `true` to prevent fields from appearing in the list view filter options.                                                                                                                              |
-| **`hidden`**            | Will transform the field into a `hidden` input type. Its value will still submit with requests in the Admin Panel, but the field itself will not be visible to editors.                                                          |
-
-## Field Components
-
-Within the [Admin Panel](./overview), fields are rendered in three distinct places:
-
-- [Field](#the-field-component) - The actual form field rendered in the Edit View.
-- [Cell](#the-cell-component) - The table cell component rendered in the List View.
-- [Filter](#the-filter-component) - The filter component rendered in the List View.
-
-To easily swap in Field Components with your own, use the `admin.components` property in your [Field Config](../fields/overview):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const CollectionConfig: CollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      // ...
-      admin: {
-        components: { // highlight-line
-          // ...
-        },
-      },
-    }
-  ]
-}
-```
-
-The following options are available:
+**Fields support the following custom components:**
 
 | Component    | Description                                                                                                                 |
-| ---------- | --------------------------------------------------------------------------------------------------------------------------- |
-| **`Field`**  | The form field rendered of the Edit View. [More details](#the-field-component).                                                |
-| **`Cell`**   | The table cell rendered of the List View. [More details](#the-cell-component).              |
-| **`Filter`** | The filter component rendered in the List View. [More details](#the-filter-component). || Component         | Description                                                                                                     |
-| **`Label`**       | Override the default Label of the Field Component. [More details](#the-label-component).                                    |
-| **`Error`**       | Override the default Error of the Field Component. [More details](#the-error-component).                                    |
-| **`Description`** | Override the default Description of the Field Component. [More details](#the-description-component).                      |
-| **`beforeInput`** | An array of elements that will be added before the input of the Field Component. [More details](#afterinput-and-beforeinput).|
-| **`afterInput`**  | An array of elements that will be added after the input of the Field Component. [More details](#afterinput-and-beforeinput). |
+| ------------ | --------------------------------------------------------------------------------------------------------------------------- |
+| **`Filter`** | Override the text input that is presented in the `List` view when a user is filtering documents by the customized field.    |
+| **`Cell`**   | Used in the `List` view's table to represent a table-based preview of the data stored in the field. [More details](#cell-component).|
+| **`Field`**  | Swap out the field itself within all `Edit` views. [More details](#field-component).                                                |
 
-_\* **`beforeInput`** and **`afterInput`** are only supported in fields that do not contain other fields, such as [`Text`](../fields/text), and [`Textarea`](../fields/textarea)._
+As an alternative to replacing the entire Field component, you may want to keep the majority of the default Field component and only swap components within. This allows you to replace the **`Label`** or **`Error`** within a field component or add additional components inside the field with **`beforeInput`** or **`afterInput`**. **`beforeInput`** and **`afterInput`** are allowed in any fields that don't contain other fields, except [UI](/docs/fields/ui) and [Rich Text](/docs/fields/rich-text).
 
-### The Field Component
+| Component         | Description                                                                                                     |
+| ----------------- | --------------------------------------------------------------------------------------------------------------- |
+| **`Label`**       | Override the default Label in the Field Component. [More details](#label-component).                                    |
+| **`Error`**       | Override the default Label in the Field Component. [More details](#error-component).                                    |
+| **`beforeInput`** | An array of elements that will be added before `input`/`textarea` elements. [More details](#afterinput-and-beforeinput).|
+| **`afterInput`**  | An array of elements that will be added after `input`/`textarea` elements. [More details](#afterinput-and-beforeinput). |
 
-The Field Component is the actual form field rendered in the Edit View. This is the input that user's will interact with when editing a document.
+## Cell Component
 
-To easily swap in your own Field Component, use the `admin.components.Field` property in your [Field Config](../fields/overview):
+These are the props that will be passed to your custom Cell to use in your own components.
 
-```ts
-import type { CollectionConfig } from 'payload'
+| Property         | Description                                                       |
+| ---------------- | ----------------------------------------------------------------- |
+| **`field`**      | An object that includes the field configuration.                  |
+| **`colIndex`**   | A unique number for the column in the list.                       |
+| **`collection`** | An object with the config of the Collection that the field is in. |
+| **`cellData`**   | The data for the field that the cell represents.                  |
+| **`rowData`**    | An object with all the field values for the row.                  |
 
-export const CollectionConfig: CollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      // ...
-      admin: {
-        components: {
-          Field: '/path/to/MyFieldComponent', // highlight-line
-        },
-      },
-    }
-  ]
+#### Example
+
+```tsx
+import React from 'react'
+import type { CellProps } from 'payload'
+import './index.scss'
+
+const baseClass = 'custom-cell'
+
+const CustomCell: React.FC<Props> = (props) => {
+  const { field, colIndex, collection, cellData, rowData } = props
+
+  return <span className={baseClass}>{cellData}</span>
 }
 ```
 
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
+## Field Component
 
-<Banner type="warning">
-  Instead of replacing the entire Field Component, you can alternately replace or slot-in only specific parts by using the [`Label`](#the-label-component), [`Error`](#the-error-component), [`beforeInput`](#afterinput-and-beforinput), and [`afterInput`](#afterinput-and-beforinput) properties.
-</Banner>
+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.
 
-All Field Components receive the following props:
+### Sending and receiving values from the form
 
-| Property         | Description                                                                                                                                                                                                                      |
-| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`docPreferences`** | An object that contains the [Preferences](./preferences) for the document.
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
-| **`locale`**     | The locale of the field. [More details](../configuration/localization).                                                                                                                                                                   |
-| **`readOnly`**   | A boolean value that represents if the field is read-only or not.                                                                                                                                                                  |
-| **`user`**       | The currently authenticated user. [More details](../authentication/overview). |
-| **`validate`**   | A function that can be used to validate the field.                                                                                                                                                                                 |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-#### Sending and receiving values from the form
-
-When swapping out the `Field` component, you are responsible for sending and receiving the field's `value` from the form itself.
-
-To do so, import the [`useField`](./hooks#usefield) hook from `@payloadcms/ui` and use it to manage the field's value:
+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:
 
 ```tsx
 'use client'
 import { useField } from '@payloadcms/ui'
 
-export const CustomTextField: React.FC = () => {
-  const { value, setValue } = useField() // highlight-line
+const CustomTextField: React.FC<{ path: string }> = ({ path }) => {
+  // highlight-start
+  const { value, setValue } = useField({ path })
+  // highlight-end
 
-  return (
-    <input
-      onChange={(e) => setValue(e.target.value)}
-      value={value}
-    />
-  )
+  return <input onChange={(e) => setValue(e.target.value)} value={value} />
 }
 ```
 
 <Banner type="success">
-  For a complete list of all available React hooks, see the [Payload React Hooks](./hooks) documentation. For additional help, see [Building Custom Components](./components#building-custom-components).
+  For more information regarding the hooks that are available to you while you build custom
+  components, including the <strong>useField</strong> hook, [click here](/docs/admin/hooks).
 </Banner>
 
-#### TypeScript
+## Label Component
 
-When building Custom Field Components, you can import the component type to ensure type safety. There is an explicit type for the Field Component, one for every [Field Type](../fields/overview) and for every client/server environment. The convention is to prepend the field type onto the target type, i.e. `TextFieldClientComponent`:
+These are the props that will be passed to your custom Label.
 
-```tsx
-import type {
-  TextFieldClientComponent,
-  TextFieldServerComponent,
-  TextFieldClientProps,
-  TextFieldServerProps,
-  // ...and so on for each Field Type
-} from 'payload'
-```
+| 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. |
 
-### The `field` Prop
-
-All Field Components are passed their own Field Config through a common `field` prop. Within Server Components, this is the original Field Config as written within your Payload Config. Within Client Components, however, this is a "Client Config", which is a sanitized, client-friendly version of the Field Config. This is because the original Field Config is [non-serializable](https://react.dev/reference/rsc/use-client#serializable-types), meaning it cannot be passed into Client Components without first being transformed.
-
-The Client Field Config is an exact copy of the original Field Config, minus all non-serializable properties, plus all evaluated functions such as field labels, [Custom Components](../components), etc.
-
-Server Component:
-
-```tsx
-import React from 'react'
-import type { TextFieldServerComponent } from 'payload'
-import { TextField } from '@payloadcms/ui'
-
-export const MyServerField: TextFieldServerComponent = ({ clientField }) => {
-  return <TextField field={clientField} />
-}
-```
-
-<Banner type="info">
-  <strong>Tip:</strong>
-  Server Components can still access the original Field Config through the `field` prop.
-</Banner>
-
-Client Component:
+#### Example
 
 ```tsx
 'use client'
 import React from 'react'
-import type { TextFieldClientComponent } from 'payload'
-import { TextField } from '@payloadcms/ui'
+import { useTranslation } from '@payloadcms/ui'
+import { getTranslation } from '@payloadcms/translations'
 
-export const MyTextField: TextFieldClientComponent = ({ field }) => {
-  return <TextField field={field} />
+type Props = {
+  htmlFor?: string
+  label?: Record<string, string> | false | string
+  required?: boolean
+}
+
+const CustomLabel: React.FC<Props> = (props) => {
+  const { htmlFor, label, required = false } = props
+
+  const { i18n } = useTranslation()
+
+  if (label) {
+    return (
+      <span>
+        {getTranslation(label, i18n)}
+        {required && <span className="required">*</span>}
+      </span>
+    )
+  }
+
+  return null
 }
 ```
 
-The following additional properties are also provided to the `field` prop:
+## Error Component
 
-| Property         | Description                                                                                                                                                                                                                      |
-| ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`_isPresentational`** | A boolean indicating that the field is purely visual and does not directly affect data or change data shape, i.e. the [UI Field](../fields/ui). |
-| **`_path`** | A string representing the direct, dynamic path to the field at runtime, i.e. `myGroup.myArray[0].myField`. |
-| **`_schemaPath`** | A string representing the direct, static path to the [Field Config](../fields/overview), i.e. `myGroup.myArray.myField` |
-
-<Banner type="info">
-  <strong>Note:</strong>
-  These properties are underscored to denote that they are not part of the original Field Config, and instead are attached during client sanitization to make fields easier to work with on the front-end.
-</Banner>
-
-#### TypeScript
-
-When building Custom Field Components, you can import the client field props to ensure type safety in your component. There is an explicit type for the Field Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to prepend the field type onto the target type, i.e. `TextFieldClientComponent`:
-
-```tsx
-import type {
-  TextFieldClientComponent,
-  TextFieldServerComponent,
-  TextFieldClientProps,
-  TextFieldServerProps,
-  // ...and so on for each Field Type
-} from 'payload'
-```
-
-### The Cell Component
-
-The Cell Component is rendered in the table of the List View. It represents the value of the field when displayed in a table cell.
-
-To easily swap in your own Cell Component, use the `admin.components.Cell` property in your [Field Config](../fields/overview):
-
-```ts
-import type { Field } from 'payload'
-
-export const myField: Field = {
-  name: 'myField',
-  type: 'text',
-  admin: {
-    components: {
-      Cell: '/path/to/MyCustomCellComponent', // highlight-line
-    },
-  },
-}
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
-
-All Cell Components receive the following props:
-
-| Property         | Description                                                       |
-| ---------------- | ----------------------------------------------------------------- |
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
-| **`link`** | A boolean representing whether this cell should be wrapped in a link. |
-| **`onClick`** | A function that is called when the cell is clicked. |
-
-<Banner type="info">
-  <strong>Tip:</strong>
-  Use the [`useTableCell`](./hooks#usetablecell) hook to subscribe to the field's `cellData` and `rowData`.
-</Banner>
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-### The Label Component
-
-The Label Component is rendered anywhere a field needs to be represented by a label. This is typically used in the Edit View, but can also be used in the List View and elsewhere.
-
-To easily swap in your own Label Component, use the `admin.components.Label` property in your [Field Config](../fields/overview):
-
-```ts
-import type { Field } from 'payload'
-
-export const myField: Field = {
-  name: 'myField',
-  type: 'text',
-  admin: {
-    components: {
-      Label: '/path/to/MyCustomLabelComponent', // highlight-line
-    },
-  },
-}
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
-
-Custom Label Components receive all [Field Component](#the-field-component) props, plus the following props:
-
-| Property       | Description                                                      |
-| -------------- | ---------------------------------------------------------------- |
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-#### TypeScript
-
-When building Custom Label Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Label Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `LabelServerComponent` or `LabelClientComponent` to the type of field, i.e. `TextFieldLabelClientComponent`.
-
-```tsx
-import type {
-  TextFieldLabelServerComponent,
-  TextFieldLabelClientComponent,
-  // ...and so on for each Field Type
-} from 'payload'
-```
-
-### The Error Component
-
-The Error Component is rendered when a field fails validation. It is typically displayed beneath the field input in a visually-compelling style.
-
-To easily swap in your own Error Component, use the `admin.components.Error` property in your [Field Config](../fields/overview):
-
-```ts
-import type { Field } from 'payload'
-
-export const myField: Field = {
-  name: 'myField',
-  type: 'text',
-  admin: {
-    components: {
-      Error: '/path/to/MyCustomErrorComponent', // highlight-line
-    },
-  },
-}
-```
-
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
-
-Custom Error Components receive all [Field Component](#the-field-component) props, plus the following props:
+These are the props that will be passed to your custom Error.
 
 | Property        | Description                                                   |
 | --------------- | ------------------------------------------------------------- |
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
+| **`message`**   | The error message.                                            |
+| **`showError`** | A boolean value that represents if the error should be shown. |
 
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-#### TypeScript
-
-When building Custom Error Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Error Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `ErrorServerComponent` or `ErrorClientComponent` to the type of field, i.e. `TextFieldErrorClientComponent`.
+#### Example
 
 ```tsx
-import type {
-  TextFieldErrorServerComponent,
-  TextFieldErrorClientComponent,
-  // And so on for each Field Type
-} from 'payload'
-```
+import React from 'react'
 
-### The Description Property
+type Props = {
+  message: string
+  showError?: boolean
+}
 
-Field Descriptions are used to provide additional information to the editor about a field, such as special instructions. Their placement varies from field to field, but typically are displayed with subtle style differences beneath the field inputs.
+const CustomError: React.FC<Props> = (props) => {
+  const { message, showError } = props
 
-A description can be configured in three ways:
-
-  - As a string.
-  - As a function which returns a string. [More details](#description-functions).
-  - As a React component. [More details](#the-description-component).
-
-To easily add a Custom Description to a field, use the `admin.description` property in your [Field Config](../fields/overview):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollectionConfig: SanitizedCollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      name: 'myField',
-      type: 'text',
-      admin: {
-        description: 'Hello, world!' // highlight-line
-      },
-    },
-  ]
+  if (showError) {
+    return <p style={{ color: 'red' }}>{message}</p>
+  } else return null
 }
 ```
 
-<Banner type="warning">
-  <strong>Reminder:</strong>
-  To replace the Field Description with a [Custom Component](./components), use the `admin.components.Description` property. [More details](#the-description-component).
-</Banner>
+## afterInput and beforeInput
 
-#### Description Functions
+With these properties you can add multiple components before and after the input element. For example, you can add an absolutely positioned button to clear the current field value.
 
-Custom Descriptions can also be defined as a function. Description Functions are executed on the server and can be used to format simple descriptions based on the user's current [Locale](../configuration/localization).
-
-To easily add a Description Function to a field, set the `admin.description` property to a _function_ in your [Field Config](../fields/overview):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollectionConfig: SanitizedCollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      name: 'myField',
-      type: 'text',
-      admin: {
-        description: ({ t }) => `${t('Hello, world!')}` // highlight-line
-      },
-    },
-  ]
-}
-```
-
-All Description Functions receive the following arguments:
-
-| Argument       | Description                                                      |
-| -------------- | ---------------------------------------------------------------- |
-| **`t`**        | The `t` function used to internationalize the Admin Panel. [More details](../configuration/i18n) |
-
-### The Description Component
-
-Alternatively to the [Description Property](#the-description-property), you can also use a [Custom Component](./components) as the Field Description. This can be useful when you need to provide more complex feedback to the user, such as rendering dynamic field values or other interactive elements.
-
-To easily add a Description Component to a field, use the `admin.components.Description` property in your [Field Config](../fields/overview):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollectionConfig: SanitizedCollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      name: 'myField',
-      type: 'text',
-      admin: {
-        components: {
-          Description: '/path/to/MyCustomDescriptionComponent', // highlight-line
-        }
-      }
-    }
-  ]
-}
-```
-
-_For details on how to build a Custom Description, see [Building Custom Components](./components#building-custom-components)._
-
-Custom Description Components receive all [Field Component](#the-field-component) props, plus the following props:
-
-| Property       | Description                                                      |
-| -------------- | ---------------------------------------------------------------- |
-| **`field`** | In Server Components, this is the original Field Config. In Client Components, this is the sanitized Client Field Config. [More details](#the-field-prop). |
-| **`clientField`** | Server components receive the Client Field Config through this prop. [More details](#the-field-prop). |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive the `payload` and `i18n` properties by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
-
-#### TypeScript
-
-When building Custom Description Components, you can import the component props to ensure type safety in your component. There is an explicit type for the Description Component, one for every [Field Type](../fields/overview) and server/client environment. The convention is to append `DescriptionServerComponent` or `DescriptionClientComponent` to the type of field, i.e. `TextFieldDescriptionClientComponent`.
+#### Example
 
 ```tsx
-import type {
-  TextFieldDescriptionServerComponent,
-  TextFieldDescriptionClientComponent,
-  // And so on for each Field Type
-} from 'payload'
-```
+import React from 'react'
+import type { Field } from 'payload/types'
 
-### afterInput and beforeInput
+import './style.scss'
 
-With these properties you can add multiple components _before_ and _after_ the input element, as their name suggests. This is useful when you need to render additional elements alongside the field without replacing the entire field component.
-
-To add components before and after the input element, use the `admin.components.beforeInput` and `admin.components.afterInput` properties in your [Field Config](../fields/overview):
-
-```ts
-import type { SanitizedCollectionConfig } from 'payload'
-
-export const MyCollectionConfig: SanitizedCollectionConfig = {
-  // ...
-  fields: [
-    // ...
-    {
-      name: 'myField',
-      type: 'text',
-      admin: {
-        components: {
-          // highlight-start
-          beforeInput: ['/path/to/MyCustomComponent'],
-          afterInput: ['/path/to/MyOtherCustomComponent'],
-          // highlight-end
-        }
-      }
-    }
-  ]
+const ClearButton: React.FC = () => {
+  return (
+    <button
+      onClick={() => {
+        /* ... */
+      }}
+    >
+      X
+    </button>
+  )
 }
-```
 
-_For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components)._
-
-## 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:
-
-- `data` - the entire document's data that is currently being edited
-- `siblingData` - only the fields that are direct siblings to the field with the condition
-- `{ user }` - the final argument is an object containing the currently authenticated user
-
-The `condition` function should return a boolean that will control if the field should be displayed or not.
-
-**Example:**
-
-```ts
-{
-  fields: [
-    {
-      name: 'enableGreeting',
-      type: 'checkbox',
-      defaultValue: false,
+const titleField: Field = {
+  name: 'title',
+  type: 'text',
+  admin: {
+    components: {
+      afterInput: [ClearButton],
     },
-    {
-      name: 'greeting',
-      type: 'text',
-      admin: {
-        // highlight-start
-        condition: (data, siblingData, { user }) => {
-          if (data.enableGreeting) {
-            return true
-          } else {
-            return false
-          }
-        },
-        // highlight-end
-      },
-    },
-  ]
+  },
 }
+
+export default titleField
 ```

docs/admin/globals.mdx

@@ -1,107 +0,0 @@
----
-title: Global Admin Config
-label: Globals
-order: 30
-desc:
-keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-The behavior of [Globals](../configuration/globals) within the [Admin Panel](./overview) can be fully customized to fit the needs of your application. This includes grouping or hiding their navigation links, adding [Custom Components](./components), setting page metadata, and more.
-
-To configure Admin Options for Globals, use the `admin` property in your Global Config:
-
-```ts
-import { GlobalConfig } from 'payload'
-
-export const MyGlobal: GlobalConfig = {
-  // ...
-  admin: { // highlight-line
-    // ...
-  },
-}
-```
-
-## Admin Options
-
-The following options are available:
-
-| 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 details](#components).                           |
-| **`preview`**     | Function to generate a preview URL within the Admin Panel for this Global that can point to your app. [More details](#preview).           |
-| **`livePreview`** | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).          |
-| **`hideAPIURL`**  | Hides the "API URL" meta field while editing documents within this collection.                                                    |
-| **`meta`**        | Page metadata overrides to apply to this Global within the Admin Panel. [More details](./metadata).                                                                           |
-
-### Components
-
-Globals can set their own [Custom Components](./components) which only apply to [Global](../configuration/globals)-specific UI within the [Admin Panel](./overview). This includes elements such as the Save Button, or entire layouts such as the Edit View.
-
-To override Global Components, use the `admin.components` property in your [Global Config](../configuration/globals):
-
-```ts
-import type { SanitizedGlobalConfig } from 'payload'
-
-export const MyGlobal: SanitizedGlobalConfig = {
-  // ...
-  admin: {
-    components: { // highlight-line
-      // ...
-    },
-  },
-}
-```
-
-The following options are available:
-
-| Path                           | Description                                                                                                            |
-| ------------------------------ | ---------------------------------------------------------------------------------------------------------------------- |
-| **`elements.SaveButton`**      | Replace the default Save Button with a Custom Component. [Drafts](../versions/drafts) must be disabled.                                    |
-| **`elements.SaveDraftButton`** | Replace the default Save Draft Button with a Custom Component. [Drafts](../versions/drafts) must be enabled and autosave must be disabled. |
-| **`elements.PublishButton`**   | Replace the default Publish Button with a Custom Component. [Drafts](../versions/drafts) must be enabled.                                  |
-| **`elements.PreviewButton`**   | Replace the default Preview Button with a Custom Component. [Preview](#preview) must be enabled.                                         |
-| **`views`**                    | Override or create new views within the Admin Panel. [More details](./views).                                     |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  For details on how to build Custom Components, see [Building Custom Components](./components#building-custom-components).
-</Banner>
-
-### Preview
-
-It is possible to display a Preview Button within the Edit View of the Admin Panel. This will allow editors to visit the frontend of your app the corresponds to the document they are actively editing. This way they can preview the latest, potentially unpublished changes.
-
-To configure the Preview Button, set the `admin.preview` property to a function in your Global Config:
-
-```ts
-import { GlobalConfig } from 'payload'
-
-export const MainMenu: GlobalConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    preview: (doc, { locale }) => {
-      if (doc?.slug) {
-        return `/${doc.slug}?locale=${locale}`
-      }
-
-      return null
-    },
-    // highlight-end
-  },
-}
-```
-
-The preview function receives two arguments:
-
-| Argument | Description |
-| --- | --- |
-| **`doc`** | The Document being edited. |
-| **`ctx`** | An object containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT. |
-
-<Banner type="success">
-  <strong>Note:</strong>
-  For fully working example of this, check of the official [Draft Preview Example](https://github.com/payloadcms/payload/tree/main/examples/draft-preview) in the [Examples Directory](https://github.com/payloadcms/payload/tree/main/examples).
-</Banner>

docs/admin/hooks.mdx

@@ -1,12 +1,12 @@
 ---
 title: React Hooks
 label: React Hooks
-order: 70
+order: 50
 desc: Make use of all of the powerful React hooks that Payload provides.
 keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Payload provides a variety of powerful [React Hooks](https://react.dev/reference/react-dom/hooks) that can be used within your own [Custom Components](./components), such as [Custom Fields](./fields). With them, you can interface with Payload itself to build just about any type of complex customization you can think of.
+Payload provides a variety of powerful [React Hooks](https://react.dev/reference/react-dom/hooks) that can be used within your own [Custom Components](./components), such as [Custom Fields](./fields). With them, you can interface with Payload itself and build just about any type of complex customization you can think of.
 
 <Banner type="warning">
   <strong>Reminder:</strong>
@@ -15,27 +15,24 @@ Payload provides a variety of powerful [React Hooks](https://react.dev/reference
 
 ## useField
 
-The `useField` hook is used internally within all field components. It manages sending and receiving a field's state from its parent form. When you build a [Custom Field Component](./fields), you will be responsible for sending and receiving the field's `value` to and from the form yourself.
+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.
 
-To do so, import the `useField` hook as follows:
+Outside of internal use, its most common use-case is in custom `Field` components. When you build a custom React `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:
 
 ```tsx
 'use client'
 import { useField } from '@payloadcms/ui'
 
-const CustomTextField: React.FC = () => {
-  const { value, setValue, path } = useField() // highlight-line
+const CustomTextField: React.FC = ({ name }) => {
+  // highlight-start
+  const { value, setValue, path } = useField({ path: name })
+  // highlight-end
 
   return (
-    <div>
-      <p>
-        {path}
-      </p>
-      <input
-        onChange={(e) => { setValue(e.target.value) }}
-        value={value}
-      />
-    </div>
+    <input
+      onChange={(e) => setValue(e.target.value)}
+      value={value.path}
+    />
   )
 }
 ```
@@ -44,15 +41,15 @@ The `useField` hook accepts the following arguments:
 
 | Property          | Description                                                                                                                                                                                                                   |
 | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `path`            | If you do not provide a `path` or a `name`, this hook will look for one using the [`useFieldProps`](#usefieldprops) hook.                                                                                                                         |
-| `validate`        | A validation function executed client-side _before_ submitting the form to the server. Different than [Field-level Validation](../fields/overview#validation) which runs strictly on the server. |
 | `disableFormData` | If `true`, the field will not be included in the form data when the form is submitted.                                                                                                                                         |
-| `hasRows` | If `true`, the field will be treated as a field with rows. This is useful for fields like `array` and `blocks`.                                                                                                                                         |
+| `hasRows`         |                                                                                                           |
+| `path`            | If you do not provide a `path` or a `name`, this hook will look for one using the `useFieldPath` hook.                                                                                                                         |
+| `validate`        | If you do not provide a `validate` function, the field will be validated _on the client_ before submitting to the server.                                                                                                     |
 
-The `useField` hook returns the following object:
+Here is what `useField` hook returns:
 
 ```ts
-type FieldType<T> = {
+type FieldResult<T> = {
   errorMessage?: string
   errorPaths?: string[]
   filterOptions?: FilterOptionsResult
@@ -65,39 +62,13 @@ type FieldType<T> = {
   readOnly?: boolean
   rows?: Row[]
   schemaPath: string
-  setValue: (val: unknown, disableModifyingForm?: boolean) => void
+  setValue: (val: unknown, disableModifyingForm?: boolean) => voi
   showError: boolean
   valid?: boolean
   value: T
 }
 ```
 
-## useFieldProps
-
-[Custom Field Components](./fields#the-field-component) can be rendered on the server. When using a server component as a custom field component, you can access dynamic props from within any client component rendered by your custom server component. This is done using the `useFieldProps` hook. This is important because some fields can be dynamic, such as when nested in an [`array`](../fields/array) or [`blocks`](../fields/block) field. For example, items can be added, re-ordered, or deleted on-the-fly.
-
-You can use the `useFieldProps` hooks to access dynamic props like `path`:
-
-```tsx
-'use client'
-import { useFieldProps } from '@payloadcms/ui'
-
-const CustomTextField: React.FC = () => {
-  const { path } = useFieldProps() // highlight-line
-
-  return (
-    <div>
-      {path}
-    </div>
-  )
-}
-```
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  The [`useField`](#usefield) hook calls the `useFieldProps` hook internally, so you don't need to use both in the same component unless explicitly needed.
-</Banner>
-
 ## 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.
@@ -113,7 +84,7 @@ You can pass a Redux-like selector into the hook, which will ensure that you ret
 
 ```tsx
 'use client'
-import { useFormFields } from '@payloadcms/ui'
+import type { useFormFields } from '@payloadcms/ui'
 
 const MyComponent: React.FC = () => {
   // Get only the `amount` field state, and only cause a rerender when that field changes
@@ -136,8 +107,7 @@ You can do lots of powerful stuff by retrieving the full form state, like using
 
 ```tsx
 'use client'
-import { useAllFormFields } from '@payloadcms/ui'
-import { reduceFieldsToValues, getSiblingData } from 'payload/shared'
+import { useAllFormFields, reduceFieldsToValues, getSiblingData } from '@payloadcms/ui'
 
 const ExampleComponent: React.FC = () => {
   // the `fields` const will be equal to all fields' state,
@@ -463,7 +433,7 @@ export const CustomArrayManager = () => {
       name: "customArrayManager",
       admin: {
         components: {
-          Field: '/path/to/CustomArrayManagerField',
+          Field: CustomArrayManager,
         },
       },
     },
@@ -560,7 +530,7 @@ export const CustomArrayManager = () => {
       name: "customArrayManager",
       admin: {
         components: {
-          Field: '/path/to/CustomArrayManagerField',
+          Field: CustomArrayManager,
         },
       },
     },
@@ -670,7 +640,7 @@ export const CustomArrayManager = () => {
       name: "customArrayManager",
       admin: {
         components: {
-          Field: '/path/to/CustomArrayManagerField',
+          Field: CustomArrayManager,
         },
       },
     },
@@ -760,7 +730,7 @@ const LinkFromCategoryToPosts: React.FC = () => {
 
 ## 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:
+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:
 
 ```tsx
 'use client'
@@ -818,7 +788,7 @@ import { useConfig } from '@payloadcms/ui'
 
 const MyComponent: React.FC = () => {
   // highlight-start
-  const { config } = useConfig()
+  const config = useConfig()
   // highlight-end
 
   return <span>{config.serverURL}</span>
@@ -900,27 +870,6 @@ const MyComponent: React.FC = () => {
 }
 ```
 
-## useTableCell
-
-Similar to [`useFieldProps`](#usefieldprops), all [Custom Cell Components](./fields#the-cell-component) are rendered on the server, and as such, only have access to static props at render time. But, some props need to be dynamic, such as the field value itself.
-
-For this reason, dynamic props like `cellData` are managed in their own React context, which can be accessed using the `useTableCell` hook.
-
-```tsx
-'use client'
-import { useTableCell } from '@payloadcms/ui'
-
-const MyComponent: React.FC = () => {
-  const { cellData } = useTableCell() // highlight-line
-
-  return (
-    <div>
-      {cellData}
-    </div>
-  )
-}
-```
-
 ## 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:

docs/admin/locked-documents.mdx

@@ -1,79 +0,0 @@
----
-title: Document Locking
-label: Document Locking
-order: 90
-desc: Ensure your documents are locked during editing to prevent concurrent changes from multiple users and maintain data integrity.
-keywords: locking, document locking, edit locking, document, concurrency, Payload, headless, Content Management System, cms, javascript, react, node, nextjs
----
-
-Document locking in Payload ensures that only one user at a time can edit a document, preventing data conflicts and accidental overwrites. When a document is locked, other users are prevented from making changes until the lock is released, ensuring data integrity in collaborative environments.
-
-The lock is automatically triggered when a user begins editing a document within the Admin Panel and remains in place until the user exits the editing view or the lock expires due to inactivity.
-
-## How it works
-
-When a user starts editing a document, Payload locks it for that user. If another user attempts to access the same document, they will be notified that it is currently being edited. They can then choose one of the following options:
-
-- View in Read-Only: View the document without the ability to make any changes.
-- Take Over: Take over editing from the current user, which locks the document for the new editor and notifies the original user.
-- Return to Dashboard: Navigate away from the locked document and continue with other tasks.
-
-The lock will automatically expire after a set period of inactivity, configurable using the `duration` property in the `lockDocuments` configuration, after which others can resume editing.
-
-<Banner type="info"> <strong>Note:</strong> If your application does not require document locking, you can disable this feature for any collection or global by setting the <code>lockDocuments</code> property to <code>false</code>. </Banner>
-
-### Config Options
-
-The `lockDocuments` property exists on both the Collection Config and the Global Config. Document locking is enabled by default, but you can customize the lock duration or turn off the feature for any collection or global.
-
-Here’s an example configuration for document locking:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Posts: CollectionConfig = {
-  slug: 'posts',
-  fields: [
-    {
-      name: 'title',
-      type: 'text',
-    },
-    // other fields...
-  ],
-  lockDocuments: {
-    duration: 600, // Duration in seconds
-  },
-}
-```
-
-#### Locking Options
-
-| Option              | Description                                                                                                                                                                    |
-| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **`lockDocuments`** | Enables or disables document locking for the collection or global. By default, document locking is enabled. Set to an object to configure, or set to false to disable locking. |
-| **`duration`**      | Specifies the duration (in seconds) for how long a document remains locked without user interaction. The default is 300 seconds (5 minutes).                                   |
-
-### Impact on APIs
-
-Document locking affects both the Local and REST APIs, ensuring that if a document is locked, concurrent users will not be able to perform updates or deletes on that document (including globals). If a user attempts to update or delete a locked document, they will receive an error.
-
-Once the document is unlocked or the lock duration has expired, other users can proceed with updates or deletes as normal.
-
-#### Overriding Locks
-
-For operations like `update` and `delete`, Payload includes an `overrideLock` option. This boolean flag, when set to `false`, enforces document locks, ensuring that the operation will not proceed if another user currently holds the lock.
-
-By default, `overrideLock` is set to `true`, which means that document locks are ignored, and the operation will proceed even if the document is locked. To enforce locks and prevent updates or deletes on locked documents, set `overrideLock: false`.
-
-```ts
-const result = await payload.update({
-  collection: 'posts',
-  id: '123',
-  data: {
-    title: 'New title',
-  },
-  overrideLock: false, // Enforces the document lock, preventing updates if the document is locked
-})
-```
-
-This option is particularly useful in scenarios where administrative privileges or specific workflows require you to override the lock and ensure the operation is completed.

docs/admin/metadata.mdx

@@ -1,216 +0,0 @@
----
-title: Page Metadata
-label: Metadata
-order: 70
-desc: Customize the metadata of your pages within the Admin Panel
-keywords: admin, components, custom, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-Every page within the Admin Panel automatically receives dynamic, auto-generated metadata derived from live document data, the user's current locale, and more, without any additional configuration. This includes the page title, description, og:image and everything in between. Metadata is fully configurable at the root level and cascades down to individual collections, documents, and custom views, allowing for the ability to control metadata on any page with high precision.
-
-Within the Admin Panel, metadata can be customized at the following levels:
-
-- [Root Metadata](#root-metadata)
-- [Collection Metadata](#collection-metadata)
-- [Global Metadata](#global-metadata)
-- [View Metadata](#view-metadata)
-
-All of these types of metadata share a similar structure, with a few key differences on the Root level. To customize metadata, consult the list of available scopes. Determine the scope that corresponds to what you are trying to accomplish, then author your metadata within the Payload Config accordingly.
-
-## Root Metadata
-
-Root Metadata is the metadata that is applied to all pages within the Admin Panel. This is where you can control things like the suffix appended onto each page's title, the favicon displayed in the browser's tab, and the Open Graph data that is used when sharing the Admin Panel on social media.
-
-To customize Root Metadata, use the `admin.meta` key in your Payload Config:
-
-```ts
-{
-  // ...
-  admin: {
-    // highlight-start
-    meta: {
-    // highlight-end
-      title: 'My Admin Panel',
-      description: 'The best admin panel in the world',
-      icons: [
-        {
-          rel: 'icon',
-          type: 'image/png',
-          url: '/favicon.png',
-        },
-      ],
-    },
-  },
-}
-```
-
-The following options are available for Root Metadata:
-
-| Key | Type | Description |
-| --- | --- | --- |
-| **`title`** | `string` | The title of the Admin Panel. |
-| **`description`** | `string` | The description of the Admin Panel. |
-| **`defaultOGImageType`** | `dynamic` (default), `static`, or `off` | The type of default OG image to use. If set to `dynamic`, Payload will use Next.js image generation to create an image with the title of the page. If set to `static`, Payload will use the `defaultOGImage` URL. If set to `off`, Payload will not generate an OG image. |
-| **`icons`** | `IconConfig[]` | An array of icon objects. [More details](#icons) |
-| **`keywords`** | `string` | A comma-separated list of keywords to include in the metadata of the Admin Panel. |
-| **`openGraph`** | `OpenGraphConfig` | An object containing Open Graph metadata. [More details](#open-graph) |
-| **`titleSuffix`** | `string` | A suffix to append to the end of the title of every page. Defaults to "- Payload". |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  These are the _root-level_ options for the Admin Panel. You can also customize [Collection Metadata](./collections), [Global Metadata](./globals), and [Document Metadata](./documents) in their respective configs.
-</Banner>
-
-### Icons
-
-The Icons Config corresponds to the `<link>` tags that are used to specify icons for the Admin Panel. The `icons` key is an array of objects, each of which represents an individual icon. Icons are differentiated from one another by their `rel` attribute, which specifies the relationship between the document and the icon.
-
-The most common icon type is the favicon, which is displayed in the browser tab. This is specified by the `rel` attribute `icon`. Other common icon types include `apple-touch-icon`, which is used by Apple devices when the Admin Panel is saved to the home screen, and `mask-icon`, which is used by Safari to mask the Admin Panel icon.
-
-To customize icons, use the `icons` key within the `admin.meta` object in your Payload Config:
-
-```ts
-{
-  // ...
-  admin: {
-    meta: {
-      // highlight-start
-      icons: [
-      // highlight-end
-        {
-          rel: 'icon',
-          type: 'image/png',
-          url: '/favicon.png',
-        },
-        {
-          rel: 'apple-touch-icon',
-          type: 'image/png',
-          url: '/apple-touch-icon.png',
-        },
-      ],
-    },
-  },
-}
-```
-
-The following options are available for Icons:
-
-| Key | Type | Description |
-| --- | --- | --- |
-| **`rel`** | `string` | The HTML `rel` attribute of the icon. |
-| **`type`** | `string` | The MIME type of the icon. |
-| **`color`** | `string` | The color of the icon. |
-| **`fetchPriority`** | `string` | The [fetch priority](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/fetchPriority) of the icon. |
-| **`media`** | `string` | The [media query](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_media_queries/Using_media_queries) of the icon. |
-| **`sizes`** | `string` | The [sizes](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement/sizes) of the icon. |
-| **`url`** | `string` | The URL pointing the resource of the icon. |
-
-### Open Graph
-
-Open Graph metadata is a set of tags that are used to control how URLs are displayed when shared on social media platforms. Open Graph metadata is automatically generated by Payload, but can be customized at the Root level.
-
-To customize Open Graph metadata, use the `openGraph` key within the `admin.meta` object in your Payload Config:
-
-```ts
-{
-  // ...
-  admin: {
-    meta: {
-      // highlight-start
-      openGraph: {
-      // highlight-end
-        description: 'The best admin panel in the world',
-        images: [
-          {
-            url: 'https://example.com/image.jpg',
-            width: 800,
-            height: 600,
-          },
-        ],
-        siteName: 'Payload',
-        title: 'My Admin Panel',
-      },
-    },
-  },
-}
-```
-
-The following options are available for Open Graph Metadata:
-
-| Key | Type | Description |
-| --- | --- | --- |
-| **`description`** | `string` | The description of the Admin Panel. |
-| **`images`** | `OGImageConfig` or `OGImageConfig[]` | An array of image objects. |
-| **`siteName`** | `string` | The name of the site. |
-| **`title`** | `string` | The title of the Admin Panel. |
-
-## Collection Metadata
-
-Collection Metadata is the metadata that is applied to all pages within any given Collection within the Admin Panel. This metadata is used to customize the title and description of all views within any given Collection, unless overridden by the view itself.
-
-To customize Collection Metadata, use the `admin.meta` key within your Collection Config:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const MyCollection: CollectionConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    meta: {
-    // highlight-end
-      title: 'My Collection',
-      description: 'The best collection in the world',
-    },
-  },
-}
-```
-
-The Collection Meta config has the same options as the [Root Metadata](#root-metadata) config.
-
-## Global Metadata
-
-Global Metadata is the metadata that is applied to all pages within any given Global within the Admin Panel. This metadata is used to customize the title and description of all views within any given Global, unless overridden by the view itself.
-
-To customize Global Metadata, use the `admin.meta` key within your Global Config:
-
-```ts
-import { GlobalConfig } from 'payload'
-
-export const MyGlobal: GlobalConfig = {
-  // ...
-  admin: {
-    // highlight-start
-    meta: {
-    // highlight-end
-      title: 'My Global',
-      description: 'The best
-    },
-  },
-}
-```
-
-The Global Meta config has the same options as the [Root Metadata](#root-metadata) config.
-
-## View Metadata
-
-View Metadata is the metadata that is applied to specific [Views](./views) within the Admin Panel. This metadata is used to customize the title and description of a specific view, overriding any metadata set at the [Root](#root-metadata), [Collection](#collection-metadata), or [Global](#global-metadata) level.
-
-To customize View Metadata, use the `meta` key within your View Config:
-
-```ts
-{
-  // ...
-  admin: {
-    views: {
-      dashboard: {
-        // highlight-start
-        meta: {
-        // highlight-end
-          title: 'My Dashboard',
-          description: 'The best dashboard in the world',
-        }
-      },
-    },
-  },
-}

docs/admin/overview.mdx

@@ -6,11 +6,11 @@ desc: Manage your data and customize the Payload Admin Panel by swapping in your
 keywords: admin, components, custom, customize, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Payload dynamically generates a beautiful, [fully type-safe](../typescript/overview) Admin Panel to manage your users and data. It is highly performant, even with 100+ fields, and is translated in over 30 languages. Within the Admin Panel you can manage content, [render your site](../live-preview/overview), preview drafts, [diff versions](../versions/overview), and so much more.
+Payload dynamically generates a beautiful, [fully type-safe](../typescript/overview) admin panel to manage your users and data. It is highly performant, even with 100+ fields, and is translated in over 30 languages. Within the Admin Panel you can manage content, [render your site](../live-preview/overview), preview drafts, [diff versions](../versions/overview), and so much more.
 
-The Admin Panel is designed to [white-label your brand](https://payloadcms.com/blog/white-label-admin-ui). You can endlessly customize and extend the Admin UI by swapping in your own [Custom Components](./components)—everything from simple field labels to entire views can be modified or replaced to perfectly tailor the interface for your editors.
+The Admin Panel is designed to [white-label your brand](https://payloadcms.com/blog/white-label-admin-ui). You can endlessly customize and extend the Admin UI by swapping in your own [Custom Components](./components)—everything from simple field labels to entire views can be modified or replaced to meet the needs of your editors.
 
-The Admin Panel is written in [TypeScript](https://www.typescriptlang.org) and built with [React](https://react.dev) using the [Next.js App Router](https://nextjs.org/docs/app). It supports [React Server Components](https://react.dev/reference/rsc/server-components), enabling the use of the [Local API](/docs/local-api/overview) on the front-end. You can install Payload into any [existing Next.js app in just one line](../getting-started/installation) and [deploy it anywhere](../production).
+The Admin Panel is written in [TypeScript](https://www.typescriptlang.org) and built with [React](https://react.dev) using the [Next.js App Router](https://nextjs.org/docs/app). It supports [React Server Components](https://react.dev/reference/rsc/server-components) and the use of the [Local API](/docs/local-api/overview) on the front-end. You can install Payload into any [existing Next.js app in just one line](../getting-started/installation) and [deploy it anywhere](../production).
 
 <Banner type="success">
   The Payload Admin Panel is designed to be as minimal and straightforward as possible to allow easy customization and control. [Learn more](./components).
@@ -25,7 +25,7 @@ The Admin Panel is written in [TypeScript](https://www.typescriptlang.org) and b
 
 ## Project Structure
 
-The Admin Panel serves as the entire HTTP layer for Payload, providing a full CRUD interface for your app. This means that both the [REST](../rest-api/overview) and [GraphQL](../graphql/overview) APIs are simply [Next.js Routes](https://nextjs.org/docs/app/building-your-application/routing) that exist directly alongside your front-end application.
+The Admin Panel serves as the entire HTTP layer for Payload, providing a full CRUD interface for your app. This means that both the [REST](../rest-api/overview) and [GraphQL](../graphql/overview) APIs are Next.js routes that exist directly alongside your front-end application.
 
 Once you [install Payload](../getting-started/installation), the following files and directories will be created in your app:
 
@@ -51,16 +51,11 @@ app/
   If you are not familiar with Next.js project structure, you can [learn more about it here](https://nextjs.org/docs/getting-started/project-structure).
 </Banner>
 
-As shown above, all Payload routes are nested within the `(payload)` route group. This creates a boundary between the Admin Panel and the rest of your application by scoping all layouts and styles. The `layout.tsx` file within this directory, for example, is where Payload manages the `html` tag of the document to set proper [`lang`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang) and [`dir`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) attributes, etc.
+As shown above, all Payload routes are nested within the `(payload)` route group. This creates a boundary between the Admin Panel and the rest of your application by scoping all layouts and styles. The `layout.tsx` file within this directory, for example, is where Payload manages the `html` tag of the document to set proper `lang` and `dir` attributes, etc.
 
-The `admin` directory contains all the _pages_ related to the interface itself, whereas the `api` and `graphql` directories contains all the _routes_ related to the [REST API](../rest-api/overview) and [GraphQL API](../graphql/overview). All admin routes are [easily configurable](#customizing-routes) to meet your application's exact requirements.
+The `admin` directory contains all the _pages_ related to the interface itself, whereas the `api` and `graphql` directories contains all the _routes_ related to the [REST API](../rest-api/overview) and [GraphQL API](../graphql/overview). All admin routes are [easily configurable](#customizing-routes) to meet your application's requirements.
 
-<Banner type="warning">
-  <strong>Note:</strong>
-  If you don't use the [REST API](../rest/overview) or [GraphQL API](../graphql/overview), you can delete the [Next.js files corresponding to those routes](../admin/overview#project-structure), however, the overhead of this API is completely constrained to these endpoints, and will not slow down or affect Payload outside of the endpoints.
-</Banner>
-
-Finally, the `custom.scss` file is where you can add or override globally-oriented styles in the Admin Panel, such as modify the color palette. Customizing the look and feel through CSS alone is a powerful feature of the Admin Panel, [more on that here](./customizing-css).
+Finally, the `custom.scss` file is where you can add or override globally-oriented styles in the Admin Panel, such as the color palette. Customizing the look and feel through CSS alone is a powerful feature of the Admin Panel, [more on that here](./customizing-css).
 
 All auto-generated files will contain the following comments at the top of each file:
 
@@ -71,7 +66,7 @@ All auto-generated files will contain the following comments at the top of each
 
 ## Admin Options
 
-All options for the Admin Panel are defined in your [Payload Config](../configuration/overview) under the `admin` property:
+All options for the Admin Panel are defined in your [Payload Config](../configuration/overview) under the `admin` key.
 
 ```ts
 import { buildConfig } from 'payload'
@@ -84,26 +79,25 @@ const config = buildConfig({
 })
 ```
 
-The following options are available:
+The following options are available for the Admin Panel:
 
-| Option        | Description                                                                                                                                                           |
-|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`avatar`**      | Set account profile picture. Options: `gravatar`, `default` or a custom React component.                                                                              |
-| **`autoLogin`**   | Used to automate log-in for dev and demonstration convenience. [More details](../authentication/overview).                                                            |
-| **`buildPath`**   | Specify an absolute path for where to store the built Admin bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                            |
-| **`components`**  | Component overrides that affect the entirety of the Admin Panel. [More details](./components).                                                                        |
-| **`custom`**      | Any custom properties you wish to pass to the Admin Panel.                                                                                                            |
-| **`dateFormat`**  | The date format that will be used for all dates within the Admin Panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used.                       |
-| **`disable`**     | If set to `true`, the entire Admin Panel will be disabled.                                                                                                            |
-| **`livePreview`** | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).                                         |
-| **`meta`**        | Base metadata to use for the Admin Panel. [More details](./metadata). |
-| **`routes`**      | Replace built-in Admin Panel routes with your own custom routes. [More details](#customizing-routes).                                                                 |
-| **`theme`**       | Restrict the Admin Panel theme to use only one of your choice. Default is `all`.
-| **`user`**        | The `slug` of the Collection that you want to allow to login to the Admin Panel. [More details](#the-admin-user-collection).                                          |
+| Option            | Description                                                                                                                                                                                                                                                                 |
+| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `user`            | The `slug` of the Collection that you want to allow to login to the Admin Panel. [More details](#the-admin-user-collection).                                                                                                                                                        |
+| `buildPath`       | Specify an absolute path for where to store the built Admin bundle used in production. Defaults to `path.resolve(process.cwd(), 'build')`.                                                                                                                                  |
+| `meta`            | Base metadata to use for the Admin Panel. Included properties are `titleSuffix`, `icons`, and `openGraph`. Can be overridden on a per Collection or per Global basis.                                                                                                       |
+| `disable`         | If set to `true`, the entire Admin Panel will be disabled.                                                                                                                                                                                                                  |
+| `dateFormat`      | The date format that will be used for all dates within the Admin Panel. Any valid [date-fns](https://date-fns.org/) format pattern can be used.                                                                                                                             |
+| `avatar`          | Set account profile picture. Options: `gravatar`, `default` or a custom React component.                                                                                                                                                                                    |
+| `autoLogin`       | Used to automate admin log-in for dev and demonstration convenience. [More details](../authentication/config).                                                                                                                                                                      |
+| `livePreview`     | Enable real-time editing for instant visual feedback of your front-end application. [More details](../live-preview/overview).                                                                                                                                                       |
+| `components`      | Component overrides that affect the entirety of the Admin Panel. [More details](./components).                                                                                                                                                                                      |
+| `routes`          | Replace built-in Admin Panel routes with your own custom routes. [More details](#customizing-routes).                                                                                                                                                                               |
+| `custom`          | Any custom properties you wish to pass to the Admin Panel.                                                                                                                                                                                                                  |
 
 <Banner type="success">
-  <strong>Reminder:</strong>
-  These are the _root-level_ options for the Admin Panel. You can also customize [Collection Admin Options](./collections) and [Global Admin Options](./globals) through their respective `admin` keys.
+  <strong>Note:</strong>
+  These are the _root-level_ options for the Admin Panel. You can also customize the admin options of any Collection or Global through their respective `admin` keys.
 </Banner>
 
 ### The Admin User Collection
@@ -138,7 +132,7 @@ To do this, specify `admin: { user: 'admins' }` in your config. This will provid
 
 ### Role-based Access Control
 
-It is also possible to allow multiple user types into the Admin Panel with limited permissions, known as role-based access control (RBAC). For example, you may wish to have two roles within the `admins` Collection:
+It is also possible to allow multiple user types into the Admin Panel with limited permissions. For example, you may wish to have two roles within the `admins` Collection:
 
 - `super-admin` - full access to the Admin Panel to perform any action
 - `editor` - limited access to the Admin Panel to only manage content
@@ -153,7 +147,7 @@ You have full control over the routes that Payload binds itself to. This include
 
 Root-level routes are those that are not behind the `/admin` path, such as the [REST API](../rest-api/overview) and [GraphQL API](../graphql/overview), or the root path of the Admin Panel itself.
 
-To customize root-level routes, use the `routes` property in your [Payload Config](../configuration/overview):
+Here is an example of how you might modify root-level routes:
 
 ```ts
 import { buildConfig } from 'payload'
@@ -166,43 +160,30 @@ const config = buildConfig({
 })
 ```
 
-The following options are available:
+You can configure custom paths for the following root-level routes through the `routes` property of your [Payload Config](../configuration/overview):
 
-| Option              | Default route         | Description                                       |
-|---------------------|-----------------------|---------------------------------------------------|
-| `admin`             | `/admin`              | The Admin Panel itself.                           |
-| `api`               | `/api`                | The [REST API](../rest-api/overview) base path.   |
-| `graphQL`           | `/graphql`            | The [GraphQL API](../graphql/overview) base path. |
-| `graphQLPlayground` | `/graphql-playground` | The GraphQL Playground.                           |
-
-<Banner type="success">
-  <strong>Tip:</strong>
-   You can easily add _new_ routes to the Admin Panel through [Custom Endpoints](../rest-api/overview#custom-endpoints) and [Custom Views](./views).
-</Banner>
-
-#### Customizing Root-level Routes
-
-You can change the Root-level Routes as needed, such as to mount the Admin Panel at the root of your application.
-
-Changing Root-level Routes also requires a change to [Project Structure](#project-structure) to match the new route. For example, if you set `routes.admin` to `/`, you would need to completely remove the `admin` directory from the project structure:
-
-```plaintext
-app/
-├─ (payload)/
-├── [[...segments]]/
-├──── ...
-```
+| Option             | Default route           | Description                           |
+| ------------------ | ----------------------- | ------------------------------------- |
+| `admin`            | `/admin`                | The Admin Panel itself.               |
+| `api`              | `/api`                  | The REST API base path.               |
+| `graphQL`          | `/graphql`              | The GraphQL API base path.            |
+| `graphQLPlayground`| `/graphql-playground`   | The GraphQL Playground.               |
 
 <Banner type="warning">
+  <strong>Reminder:</strong>
+  The `routes` key is defined in the _top-level_ of your [Payload Config](../configuration/overview), _outside_ the `admin` key. To customize the Admin Panel routes, use [admin-level routes](#admin-level-routes) instead.
+</Banner>
+
+<Banner type="success">
   <strong>Note:</strong>
-  If you set Root-level Routes _before_ auto-generating the Admin Panel, your [Project Structure](#project-structure) will already be set up correctly.
+   You can easily add _new_ routes to the Admin Panel through the `endpoints` property of the Payload Config. See [Custom Endpoints](../rest-api/overview#custom-endpoints) for more information.
 </Banner>
 
 ### Admin-level Routes
 
 Admin-level routes are those behind the `/admin` path. These are the routes that are part of the Admin Panel itself, such as the user's account page, the login page, etc.
 
-To customize admin-level routes, use the `admin.routes` property in your [Payload Config](../configuration/overview):
+Here is an example of how you might modify admin-level routes:
 
 ```ts
 import { buildConfig } from 'payload'
@@ -217,7 +198,7 @@ const config = buildConfig({
 })
 ```
 
-The following options are available:
+You can configure custom paths for the following admin-level routes through the `admin.routes` property of your [Payload Config](../configuration/overview):
 
 | Option            | Default route           | Description                                     |
 | ----------------- | ----------------------- | ----------------------------------------------- |
@@ -239,6 +220,12 @@ The following options are available:
 
 The Payload Admin Panel is translated in over [30 languages and counting](https://github.com/payloadcms/payload/tree/beta/packages/translations). Languages are automatically detected based on the user's browser and used by the Admin Panel to display all text in that language. If no language was detected, or if the user's language is not yet supported, English will be chosen. Users can easily specify their language by selecting one from their account page. See [I18n](../configuration/i18n) for more information.
 
+<Banner>
+  <strong>Note:</strong>
+  If there is a language that Payload does not yet support, we accept code
+  [contributions](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md).
+</Banner>
+
 ## Light and Dark Modes
 
 Users in the Admin Panel have the ability to choose between light mode and dark mode for their editing experience. Users can select their preferred theme from their account page. Once selected, it is saved to their user's preferences and persisted across sessions and devices. If no theme was selected, the Admin Panel will automatically detect the operation system's theme and use that as the default.

docs/admin/preferences.mdx

@@ -1,7 +1,7 @@
 ---
 title: Managing User Preferences
 label: Preferences
-order: 70
+order: 50
 desc: Store the preferences of your users as they interact with the Admin Panel.
 keywords: admin, preferences, custom, customize, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
@@ -22,7 +22,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:
 

docs/admin/views.mdx

@@ -1,27 +1,27 @@
 ---
 title: Customizing Views
 label: Customizing Views
-order: 50
+order: 30
 desc:
 keywords:
 ---
 
-Views are the individual pages that make up the [Admin Panel](./overview), such as the Dashboard, List, and Edit views. One of the most powerful ways to customize the Admin Panel is to create Custom Views. These are [Custom Components](./components) that can either replace built-in views or can be entirely new.
+Views are the individual pages that make up the [Admin Panel](./overview), such as the Dashboard, List, and Edit views. One of the most powerful ways to customize the Admin Panel is to create Custom Views. These are [Custom Components](./components) that can either replace built-in views or be entirely new.
 
-There are four types of views within the Admin Panel:
+To swap in your own Custom Views, consult the list of available components below. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-views) accordingly.
 
-- [Root Views](#root-views)
-- [Collection Views](#collection-views)
-- [Global Views](#global-views)
-- [Document Views](#document-views)
+There are four types of views in Payload:
 
-To swap in your own Custom Views, consult the list of available components. Determine the scope that corresponds to what you are trying to accomplish, then [author your React component(s)](#building-custom-views) accordingly.
+- [Root Views](#custom-root-views)
+- [Collection Views](#custom-collection-views)
+- [Global Views](#custom-global-views)
+- [Document Views](#custom-document-views)
 
-## Root Views
+## Custom Root Views
 
-Root Views are the main views of the [Admin Panel](./overview). These are views that are scoped directly under the `/admin` route, such as the Dashboard or Account views.
+Root Views are the main views of the [Admin Panel](./overview). These are views that are scoped directly under the `/admin` route, such as the Dashboard or Account views. You can easily swap Root Views with your own or [create entirely new ones](#adding-new-root-views) through the `admin.components.views` property of your [Payload Config](../configuration/overview).
 
-To easily swap Root Views with your own, or to [create entirely new ones](#adding-new-root-views), use the `admin.components.views` property of your root [Payload Config](../configuration/overview):
+Here is an example showing what it might look like to swap out Root Views for your own Custom Views. See [Building Custom Views](#building-custom-views) for exact details on how to build them:
 
 ```ts
 import { buildConfig } from 'payload'
@@ -31,70 +31,29 @@ const config = buildConfig({
   admin: {
     components: {
       views: {
-        customView: {
-          Component: '/path/to/MyCustomView#MyCustomView', // highlight-line
-          path: '/my-custom-view',
-        }
+        Dashboard: MyCustomDashboardView, // highlight-line
       },
     },
   },
 })
 ```
 
-Your Custom Root Views can optionally use one of the templates that Payload provides. The most common of these is the Default Template which provides the basic layout and navigation. Here is an example of what that might look like:
-
-```tsx
-import type { AdminViewProps } from 'payload'
-
-import { DefaultTemplate } from '@payloadcms/next/templates'
-import { Gutter } from '@payloadcms/ui'
-import React from 'react'
-
-export const MyCustomView: React.FC<AdminViewProps> = ({
-  initPageResult,
-  params,
-  searchParams,
-}) => {
-  return (
-    <DefaultTemplate
-      i18n={initPageResult.req.i18n}
-      locale={initPageResult.locale}
-      params={params}
-      payload={initPageResult.req.payload}
-      permissions={initPageResult.permissions}
-      searchParams={searchParams}
-      user={initPageResult.req.user || undefined}
-      visibleEntities={initPageResult.visibleEntities}
-    >
-      <Gutter>
-        <h1>Custom Default Root View</h1>
-        <br />
-        <p>This view uses the Default Template.</p>
-      </Gutter>
-    </DefaultTemplate>
-  )
-}
-```
-
-_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
-
 The following options are available:
 
 | 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](./overview).                                     |
+| **`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](./overview).                                     |
 
 For more granular control, pass a configuration object instead. Payload exposes the following properties for each view:
 
 | Property           | Description                                                                                                                                                                                |
 | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| **`Component`** \* | Pass in the component path that should be rendered when a user navigates to this route.                                                                                                         |
+| **`Component`** \* | Pass in the component that should be rendered when a user navigates to this route.                                                                                                         |
 | **`path`** \*      | Any valid URL path or array of paths that [`path-to-regexp`](https://www.npmjs.com/package/path-to-regex) understands.                                                                     |
 | **`exact`**        | Boolean. When true, will only match if the path matches the `usePathname()` exactly.                                                                                                     |
 | **`strict`**       | When true, a path that has a trailing slash will only match a `location.pathname` with a trailing slash. This has no effect when there are additional URL segments in the pathname. |
-| **`sensitive`**    | When true, will match if the path is case sensitive.|
-| **`meta`**         | Page metadata overrides to apply to this view within the Admin Panel. [More details](./metadata).                                                                           |
+| **`sensitive`**    | When true, will match if the path is case sensitive.                                                                                                                                       |
 
 _\* An asterisk denotes that a property is required._
 
@@ -111,9 +70,9 @@ const config = buildConfig({
     components: {
       views: {
         // highlight-start
-        myCustomView: {
+        MyCustomView: {
         // highlight-end
-          Component: '/path/to/MyCustomView#MyCustomViewComponent',
+          Component: MyCustomView,
           path: '/my-custom-view',
         },
       },
@@ -122,7 +81,7 @@ const config = buildConfig({
 })
 ```
 
-The above example shows how to add a new [Root View](#root-views), but the pattern is the same for [Collection Views](#collection-views), [Global Views](#global-views), and [Document Views](#document-views). For help on how to build your own Custom Views, see [Building Custom Views](#building-custom-views).
+The above example shows how to add a new [Root View](#custom-root-views), but the pattern is the same for [Collection Views](#custom-collection-views), [Global Views](#custom-global-views), and [Document Views](#custom-document-views). For help on how to build your own Custom Views, see [Building Custom Views](#building-custom-views).
 
 <Banner type="warning">
   <strong>Note:</strong>
@@ -133,185 +92,146 @@ The above example shows how to add a new [Root View](#root-views), but the patte
   route.
 </Banner>
 
-<Banner type="warning">
-  <strong>Custom views are public</strong>
-  <br />
-  Custom views are public by default. If your view requires a user to be logged in or to have certain access rights, you should handle that within your view component yourself.
-</Banner>
+## Custom Collection Views
 
-## Collection Views
+Collection Views are views that are scoped under the `/collections` route, such as the Collection List and Document Edit views. You can easily swap out Collection Views with your own or [create entirely new ones](#adding-new-views), through the `admin.components.views` property of your [Collection Config](../collections/overview).
 
-Collection Views are views that are scoped under the `/collections` route, such as the Collection List and Document Edit views.
-
-To easily swap out Collection Views with your own, or to [create entirely new ones](#adding-new-views), use the `admin.components.views` property of your [Collection Config](../collections/overview):
+Here is an example showing what it might look like to swap out Collection Views for your own Custom Views. See [Building Custom Views](#building-custom-views) for exact details on how to build them:
 
 ```ts
-import type { SanitizedCollectionConfig } from 'payload'
+import type { SanitizedCollectionConfig } from 'payload/types'
 
 export const MyCollectionConfig: SanitizedCollectionConfig = {
   // ...
   admin: {
     components: {
       views: {
-        edit: {
-          root: {
-            Component: '/path/to/MyCustomEditView', // highlight-line
-          }
-          // other options include:
-          // default
-          // versions
-          // version
-          // api
-          // livePreview
-          // [key: string]
-          // See "Document Views" for more details
-        },
-        list: {
-          Component: '/path/to/MyCustomListView',
-        }
+        Edit: MyCustomEditView, // highlight-line
       },
     },
   },
 }
 ```
 
-_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
-
 <Banner type="warning">
   <strong>Note:</strong>
-  The `root` property will replace the _entire_ Edit View, including the title, tabs, etc., _as well as all nested [Document Views](#document-views)_, such as the API, Live Preview, and Version views. To replace only the Edit View precisely, use the `edit.default` key instead.
+  The `Edit` property will replace the _entire_ Edit View, including the title, tabs, etc., _as well as all nested [Document Views](#custom-document-views)_, such as the API, Live Preview, and Version views. To replace only the Edit View precisely, use the `Edit.Default` key instead.
 </Banner>
 
 The following options are available:
 
 | Property   | Description                                                                                                       |
 | ---------- | ----------------------------------------------------------------------------------------------------------------- |
-| **`edit`** | The Edit View is used to edit a single document for any given Collection. [More details](#document-views).     |
-| **`list`** | The List View is used to show a list of documents for any given Collection.                                         |
+| **`Edit`** | The Edit View is used to edit a single document for any given Collection. [More details](#custom-document-views).     |
+| **`List`** | The List View is used to show a list of documents for any given Collection.                                         |
 
 <Banner type="success">
   <strong>Note:</strong>
   You can also add _new_ Collection Views to the config by adding a new key to the `views` object with at least a `path` and `Component` property. See [Adding New Views](#adding-new-views) for more information.
 </Banner>
 
-## Global Views
+## Custom Global Views
 
-Global Views are views that are scoped under the `/globals` route, such as the Document Edit View.
+Global Views are views that are scoped under the `/globals` route, such as the Document Edit View. You can easily swap out Global Views with your own or [create entirely new ones](#adding-new-views), through the `admin.components.views` property of your [Global Config](../globals/overview).
 
-To easily swap out Global Views with your own or [create entirely new ones](#adding-new-views), use the `admin.components.views` property in your [Global Config](../globals/overview):
+Here is an example showing what it might look like to swap out Global Views for your own Custom Views. See [Building Custom Views](#building-custom-views) for exact details on how to build them:
 
 ```ts
-import type { SanitizedGlobalConfig } from 'payload'
+import type { SanitizedGlobalConfig } from 'payload/types'
 
 export const MyGlobalConfig: SanitizedGlobalConfig = {
   // ...
   admin: {
     components: {
       views: {
-        edit: {
-          root: {
-            Component: '/path/to/MyCustomEditView', // highlight-line
-          }
-          // other options include:
-          // default
-          // versions
-          // version
-          // api
-          // livePreview
-          // [key: string]
-        },
+        Edit: MyCustomEditView, // highlight-line
       },
     },
   },
-}
+})
 ```
 
-_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
-
 <Banner type="warning">
   <strong>Note:</strong>
-  The `root` property will replace the _entire_ Edit View, including the title, tabs, etc., _as well as all nested [Document Views](#document-views)_, such as the API, Live Preview, and Version views. To replace only the Edit View precisely, use the `edit.default` key instead.
+  The `Edit` property will replace the _entire_ Edit View, including the title, tabs, etc., _as well as all nested [Document Views](#custom-document-views)_, such as the API, Live Preview, and Version views. To replace only the Edit View precisely, use the `Edit.Default` key instead.
 </Banner>
 
 The following options are available:
 
 | Property   | Description                                                         |
 | ---------- | ------------------------------------------------------------------- |
-| **`edit`** | The Edit View is used to edit a single document for any given Global. [More details](#document-views). |
+| **`Edit`** | The Edit View is used to edit a single document for any given Global. [More details](#custom-document-views). |
 
 <Banner type="success">
   <strong>Note:</strong>
   You can also add _new_ Global Views to the config by adding a new key to the `views` object with at least a `path` and `Component` property. See [Adding New Views](#adding-new-views) for more information.
 </Banner>
 
-## Document Views
+## Custom Document Views
 
-Document Views are views that are scoped under the `/collections/:collectionSlug/:id` or the `/globals/:globalSlug` route, such as the Edit View or the API View. All Document Views keep their overall structure across navigation changes, such as their title and tabs, and replace only the content below.
+Document Views are views that are scoped under the `/collections/:collectionSlug/:id` or the `/globals/:globalSlug` route, such as the Edit View. You can easily swap out Document Views with your own or [create entirely new ones](#adding-new-document-views) through the `admin.components.views.Edit[key]` property of either your [Collection Config](../collections/overview) or [Global Config](../globals/overview).
 
-To easily swap out Document Views with your own, or to [create entirely new ones](#adding-new-document-views), use the `admin.components.views.Edit[key]` property in your [Collection Config](../collections/overview) or [Global Config](../globals/overview):
+This approach allows you to replace specific nested views while keeping the overall structure of the Edit View intact, including the title, tabs, etc. If you need to replace the _entire_ Edit View, including the nested Document Views, use the `Edit` key itself. See [Custom Collection Views](#custom-collection-views) or [Custom Global Views](#custom-global-views) for more information.
+
+Here's an example showing what it might look like to swap out Document Views for your own Custom Views. See [Building Custom Views](#building-custom-views) for exact details on how to build them:
 
 ```ts
-import type { SanitizedCollectionConfig } from 'payload'
+import type { SanitizedCollectionConfig } from 'payload/types'
 
-export const MyCollectionOrGlobalConfig: SanitizedCollectionConfig = {
+export const MyCollectionConfig: SanitizedCollectionConfig = {
   // ...
   admin: {
     components: {
       views: {
-        edit: {
-          api: {
-            Component: '/path/to/MyCustomAPIViewComponent', // highlight-line
+        Edit: {
+          API: {
+            Component: MyCustomAPIView, // highlight-line
           },
         },
       },
     },
   },
-}
+})
 ```
 
-_For details on how to build Custom Views, including all available props, see [Building Custom Views](#building-custom-views)._
-
 <Banner type="warning">
  <strong>Note:</strong>
- If you need to replace the _entire_ Edit View, including _all_ nested Document Views, use the `root` key. See [Custom Collection Views](#collection-views) or [Custom Global Views](#global-views) for more information.
+ This applies to _both_ Collection _and_ Global configs.
 </Banner>
 
 The following options are available:
 
 | Property          | Description                                                                                                                 |
 | ----------------- | --------------------------------------------------------------------------------------------------------------------------- |
-| **`root`**        | The Root View overrides all other nested views and routes. No document controls or tabs are rendered when this key is set.  |
-| **`default`**     | The Default View is the primary view in which your document is edited. It is rendered within the "Edit" tab.     |
-| **`versions`**    | The Versions View is used to navigate the version history of a single document. It is rendered within the "Versions" tab. [More details](../versions).                    |
-| **`version`**     | The Version View is used to edit a single version of a document. It is rendered within the "Version" tab. [More details](../versions). |
-| **`api`**         | The API View is used to display the REST API JSON response for a given document. It is rendered within the "API" tab.                                            |
-| **`livePreview`** | The LivePreview view is used to display the Live Preview interface. It is rendered within the "Live Preview" tab. [More details](../live-preview).                        |
+| **`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).                        |
 
 ### Document Tabs
 
-Each Document View can be given a new tab in the Edit View, if desired. Tabs are highly configurable, from as simple as changing the label to swapping out the entire component, they can be modified in any way. To add or customize tabs in the Edit View, use the `tab` key:
+Each Document View can be given a new tab in the Edit View, if desired. Tabs are highly configurable, from as simple as changing the label to swapping out the entire component, they can be modified in any way. To add or customize tabs in the Edit View, use the `Component.Tab` key:
 
 ```ts
-import type { SanitizedCollectionConfig } from 'payload'
+import type { SanitizedCollectionConfig } from 'payload/types'
 
 export const MyCollection: SanitizedCollectionConfig = {
   slug: 'my-collection',
   admin: {
     components: {
       views: {
-        edit: {
-          myCustomTab: {
-            Component: '/path/to/MyCustomTab',
+        Edit: {
+          MyCustomTab: {
+            Component: MyCustomTab,
             path: '/my-custom-tab',
-            tab: {
-              Component: '/path/to/MyCustomTabComponent' // highlight-line
-            }
+            Tab: MyCustomTab // highlight-line
           },
-          anotherCustomTab: {
-            Component: '/path/to/AnotherCustomView',
+          AnotherCustomView: {
+            Component: AnotherCustomView,
             path: '/another-custom-view',
             // highlight-start
-            tab: {
+            Tab: {
               label: 'Another Custom View',
               href: '/another-custom-view',
             }
@@ -329,21 +249,20 @@ export const MyCollection: SanitizedCollectionConfig = {
  This applies to _both_ Collections _and_ Globals.
 </Banner>
 
-## Building Custom Views
+### Building Custom Views
 
 Custom Views are just [Custom Components](./components) rendered at the page-level. To understand how to build Custom Views, first review the [Building Custom Components](./components#building-custom-components) guide. Once you have a Custom Component ready, you can use it as a Custom View.
 
 ```ts
-import type { SanitizedCollectionConfig } from 'payload'
+import type { SanitizedCollectionConfig } from 'payload/types'
+import { MyCustomView } from './MyCustomView'
 
 export const MyCollectionConfig: SanitizedCollectionConfig = {
   // ...
   admin: {
     components: {
       views: {
-        edit: {
-          Component: '/path/to/MyCustomView' // highlight-line
-        }
+        Edit: MyCustomView, // highlight-line
       },
     },
   },
@@ -354,19 +273,19 @@ Your Custom Views will be provided with the following props:
 
 | Prop                      | Description                                                                                                                            |
 | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
-| **`initPageResult`**      | An object containing `req`, `payload`, `permissions`, etc.                                                                  |
-| **`clientConfig`**        | The Client Config object. [More details](../components#accessing-the-payload-config).                                                             |
-| **`importMap`**           | The import map object.                                                        |
-| **`params`**              | An object containing the [Dynamic Route Parameters](https://nextjs.org/docs/app/building-your-application/routing/dynamic-routes).     |
-| **`searchParams`**        | An object containing the [Search Parameters](https://developer.mozilla.org/docs/Learn/Common_questions/What_is_a_URL#parameters).      |
-
-<Banner type="success">
-  <strong>Reminder:</strong>
-  All [Custom Server Components](./components) receive `payload` and `i18n` by default. See [Building Custom Components](./components#building-custom-components) for more details.
-</Banner>
+| `payload`                 | The [Payload](../local-api/overview) class.                                                                                            |
+| `i18n`                    | The [i18n](../configuration/i18n) object.                                                                                              |
+| `user`                    | The currently logged in user.                                                                                                          |
+| `locale`                  | The current [Locale](../configuration/localization) of the [Admin Panel](./overview).                                                  |
+| `navGroups`               | The grouped navigation items according to `admin.group` in your [Collection Config](../collections/overview) or [Global Config](../globals/overview). |
+| `params`                  | An object containing the [Dynamic Route Parameters](https://nextjs.org/docs/app/building-your-application/routing/dynamic-routes).     |
+| `permissions`             | The permissions of the currently logged in user.                                                                                       |
+| `searchParams`            | An object containing the [Search Parameters](https://developer.mozilla.org/docs/Learn/Common_questions/What_is_a_URL#parameters).      |
+| `visibleEntities`         | The current user's visible entities according to your [Access Control](../access-control/overview).                                    |
 
 <Banner type="warning">
-  <strong>Important:</strong>
+  <strong>Note:</strong>
+  <br />
   It's up to you to secure your custom views. If your view requires a user to be logged in or to
   have certain access rights, you should handle that within your view component yourself.
 </Banner>

docs/authentication/api-keys.mdx

@@ -21,7 +21,7 @@ For example, if you have a third-party service or external app that needs to be
 
 Technically, both of these options will work for third-party integrations but the second option with API key is simpler, because it reduces the amount of work that your integrations need to do to be authenticated properly.
 
-To enable API keys on a collection, set the `useAPIKey` auth option to `true`. From there, a new interface will appear in the [Admin Panel](../admin/overview) for each document within the collection that allows you to generate an API key for each user in the Collection.
+To enable API keys on a collection, set the `useAPIKey` auth option to `true`. From there, a new interface will appear in the Admin panel for each document within the collection that allows you to generate an API key for each user in the Collection.
 
 ```ts
 import type { CollectionConfig } from 'payload'
@@ -48,7 +48,7 @@ your API keys will not be.
 
 ### HTTP Authentication
 
-To authenticate REST or GraphQL API requests using an API key, set the `Authorization` header. The header is case-sensitive and needs the slug of the `auth.useAPIKey` enabled collection, then " API-Key ", followed by the `apiKey` that has been assigned. Payload's built-in middleware will then assign the user document to `req.user` and handle requests with the proper [Access Control](../access-control/overview). By doing this, Payload recognizes the request being made as a request by the user associated with that API key.
+To authenticate REST or GraphQL API requests using an API key, set the `Authorization` header. The header is case-sensitive and needs the slug of the `auth.useAPIKey` enabled collection, then " API-Key ", followed by the `apiKey` that has been assigned. Payload's built-in middleware will then assign the user document to `req.user` and handle requests with the proper access control. By doing this, Payload recognizes the request being made as a request by the user associated with that API key.
 
 **For example, using Fetch:**
 
@@ -62,7 +62,7 @@ const response = await fetch('http://localhost:3000/api/pages', {
 })
 ```
 
-Payload ensures that the same, uniform [Access Control](../access-control/overview) is used across all authentication strategies. This enables you to utilize your existing Access Control configurations with both API keys and the standard email/password authentication. This consistency can aid in maintaining granular control over your API keys.
+Payload ensures that the same, uniform access control is used across all authentication strategies. This enables you to utilize your existing access control configurations with both API keys and the standard email/password authentication. This consistency can aid in maintaining granular control over your API keys.
 
 ### API Key Only Auth
 

docs/authentication/config.mdx

@@ -0,0 +1,206 @@
+---
+title: Authentication Config
+label: Config
+order: 20
+desc: Enable and customize options in the Authentication config for features including Forgot Password, Login Attempts, API key usage and more.
+keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
+---
+
+Payload's Authentication is extremely powerful and gives you everything you need when you go to build a new app or site in a secure and responsible manner.
+
+To enable Authentication on a collection, define an `auth` property and set it to either `true` or to an object containing the options below.
+
+## 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.                                                                       |
+| **`lockTime`**             | Set the time (in milliseconds) that a user should be locked out if they fail authentication more times than `maxLoginAttempts` allows for.                                                                                          |
+| **`depth`**                | How many levels deep a `user` document should be populated when creating the JWT and binding the `user` to the `req`. Defaults to `0` and should only be modified if absolutely necessary, as this will affect performance. |
+| **`cookies`**              | Set cookie options, including `secure`, `sameSite`, and `domain`. For advanced users.                                                                                                                                               |
+| **`forgotPassword`**       | Customize the way that the `forgotPassword` operation functions. [More](/docs/authentication/config#forgot-password)                                                                                                                |
+| **`verify`**               | Set to `true` or pass an object with verification options to require users to verify by email before they are allowed to log into your app. [More](/docs/authentication/config#email-verification)                                  |
+| **`disableLocalStrategy`** | Advanced - disable Payload's built-in local auth strategy. Only use this property if you have replaced Payload's auth mechanisms with your own.                                                                                     |
+| **`strategies`**           | Advanced - an array of custom authentification strategies to extend this collection's authentication with. [More](/docs/authentication/custom-strategies)                                                                         |
+
+### Forgot Password
+
+You can customize how the Forgot Password workflow operates with the following options on the `auth.forgotPassword` property:
+
+**`generateEmailHTML`**
+
+Function that accepts one argument, containing `{ req, token, user }`, that allows for overriding the HTML within emails that are sent to users attempting to reset their password. The function should return a string that supports HTML, which can be a full HTML email.
+
+<Banner type="success">
+  <strong>Tip:</strong>
+  <br />
+  HTML templating can be used to create custom email templates, inline CSS automatically, and more.
+  You can make a reusable function that standardizes all email sent from Payload, which makes
+  sending custom emails more DRY. Payload doesn't ship with an HTML templating engine, so you are
+  free to choose your own.
+</Banner>
+
+Example:
+
+```ts
+import { CollectionConfig } from 'payload/types'
+
+export const Customers: CollectionConfig = {
+  slug: 'customers',
+  auth: {
+    forgotPassword: {
+      // highlight-start
+      generateEmailHTML: ({ req, token, user }) => {
+        // Use the token provided to allow your user to reset their password
+        const resetPasswordURL = `https://yourfrontend.com/reset-password?token=${token}`
+
+        return `
+          <!doctype html>
+          <html>
+            <body>
+              <h1>Here is my custom email template!</h1>
+              <p>Hello, ${user.email}!</p>
+              <p>Click below to reset your password.</p>
+              <p>
+                <a href="${resetPasswordURL}">${resetPasswordURL}</a>
+              </p>
+            </body>
+          </html>
+        `
+      },
+      // highlight-end
+    },
+  },
+}
+```
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  <br />
+  If you specify a different URL to send your users to for resetting their password, such as a page
+  on the frontend of your app or similar, you need to handle making the call to the Payload REST or
+  GraphQL reset-password operation yourself on your frontend, using the token that was provided for
+  you. Above, it was passed via query parameter.
+</Banner>
+
+**`generateEmailSubject`**
+
+Similarly to the above `generateEmailHTML`, you can also customize the subject of the email. The function argument are the same but you can only return a string - not HTML.
+
+Example:
+
+```ts
+{
+  slug: 'customers',
+  auth: {
+    forgotPassword: {
+      // highlight-start
+      generateEmailSubject: ({ req, user }) => {
+        return `Hey ${user.email}, reset your password!`;
+      }
+      // highlight-end
+    }
+  }
+}
+```
+
+### Email Verification
+
+If you'd like to require email verification before a user can successfully log in, you can enable it by passing `true` or an `options` object to `auth.verify`. The following options are available:
+
+**`generateEmailHTML`**
+
+Function that accepts one argument, containing `{ req, token, user }`, that allows for overriding the HTML within emails that are sent to users indicating how to validate their account. The function should return a string that supports HTML, which can optionally be a full HTML email.
+
+Example:
+
+```ts
+import { CollectionConfig } from 'payload/types'
+
+export const Customers: CollectionConfig = {
+  slug: 'customers',
+  auth: {
+    verify: {
+      // highlight-start
+      generateEmailHTML: ({ req, token, user }) => {
+        // Use the token provided to allow your user to verify their account
+        const url = `https://yourfrontend.com/verify?token=${token}`
+
+        return `Hey ${user.email}, verify your email by clicking here: ${url}`
+      },
+      // highlight-end
+    },
+  },
+}
+```
+
+<Banner type="warning">
+  <strong>Important:</strong>
+  <br />
+  If you specify a different URL to send your users to for email verification, such as a page on the
+  frontend of your app or similar, you need to handle making the call to the Payload REST or GraphQL
+  verification operation yourself on your frontend, using the token that was provided for you.
+  Above, it was passed via query parameter.
+</Banner>
+
+**`generateEmailSubject`**
+
+Similarly to the above `generateEmailHTML`, you can also customize the subject of the email. The function argument are the same but you can only return a string - not HTML.
+
+Example:
+
+```ts
+{
+  slug: 'customers',
+  auth: {
+    forgotPassword: {
+      // highlight-start
+      generateEmailSubject: ({ req, user }) => {
+        return `Hey ${user.email}, reset your password!`;
+      }
+      // highlight-end
+    }
+  }
+}
+```
+
+### Admin autologin
+
+For testing and demo purposes you may want to skip forcing the admin user to login in order to access the panel.
+The `admin.autologin` property is used to configure the how visitors are handled when accessing the admin panel.
+The default is that all users will have to login and this should not be enabled for environments where data needs to protected.
+
+#### autoLogin Options
+
+| Option            | Description                                                                                                     |
+| ----------------- | --------------------------------------------------------------------------------------------------------------- |
+| **`email`**       | The email address of the user to login as                                                                       |
+| **`password`**    | The password of the user to login as                                                                            |
+| **`prefillOnly`** | If set to true, the login credentials will be prefilled but the user will still need to click the login button. |
+
+The recommended way to use this feature is behind an environment variable to ensure it is disabled when in production.
+
+**Example:**
+
+```ts
+export default buildConfig({
+  admin: {
+    user: 'users',
+    // highlight-start
+    autoLogin:
+      process.env.PAYLOAD_PUBLIC_ENABLE_AUTOLOGIN === 'true'
+        ? {
+            email: 'test@example.com',
+            password: 'test',
+            prefillOnly: true,
+          }
+        : false,
+    // highlight-end
+  },
+  collections: [
+    /** */
+  ],
+})
+```

docs/authentication/custom-strategies.mdx

@@ -13,7 +13,7 @@ keywords: authentication, config, configuration, overview, documentation, Conten
 
 ### Creating a strategy
 
-At the core, a strategy is a way to authenticate a user making a request. As of `3.0` we moved away from [Passport](https://www.passportjs.org) in favor of pulling back the curtain and putting you in full control.
+At the core, a strategy is a way to authenticate a user making a request. As of `3.0` we moved away from passportJS in favor of pulling back the curtain and putting you in full control.
 
 A strategy is made up of the following:
 
@@ -38,7 +38,7 @@ At its core a strategy simply takes information from the incoming request and re
 Your `authenticate` method should return an object containing a Payload user document and any optional headers that you'd like Payload to set for you when we return a response.
 
 ```ts
-import type { CollectionConfig } from 'payload'
+import { CollectionConfig } from 'payload'
 
 export const Users: CollectionConfig = {
   slug: 'users',

docs/authentication/email.mdx

@@ -1,203 +0,0 @@
----
-title: Authentication Emails
-label: Email Verification
-order: 30
-desc: Email Verification allows users to verify their email address before they're account is fully activated. Email Verification ties directly into the Email functionality that Payload provides.
-keywords: authentication, email, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
----
-
-[Authentication](./overview) ties directly into the [Email](../email) functionality that Payload provides. This allows you to send emails to users for verification, password resets, and more. While Payload provides default email templates for these actions, you can customize them to fit your brand.
-
-## Email Verification
-
-Email Verification forces users to prove they have access to the email address they can authenticate. This will help to reduce spam accounts and ensure that users are who they say they are.
-
-To enable Email Verification, use the `auth.verify` property on your [Collection Config](../configuration/collections):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    verify: true // highlight-line
-  },
-}
-```
-
-<Banner type="info">
-  <strong>Tip:</strong>
-  Verification emails are fully customizable. [More details](#generateEmailHTML).
-</Banner>
-
-The following options are available:
-
-| Option               | Description                                                                                                                                                                                                                         |
-|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`generateEmailHTML`** | Allows for overriding the HTML within emails that are sent to users indicating how to validate their account. [More details](#generateEmailHTML). |
-| **`generateEmailSubject`** | Allows for overriding the subject of the email that is sent to users indicating how to validate their account. [More details](#generateEmailSubject). |
-
-#### generateEmailHTML
-
-Function that accepts one argument, containing `{ req, token, user }`, that allows for overriding the HTML within emails that are sent to users indicating how to validate their account. The function should return a string that supports HTML, which can optionally be a full HTML email.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    verify: {
-      // highlight-start
-      generateEmailHTML: ({ req, token, user }) => {
-        // Use the token provided to allow your user to verify their account
-        const url = `https://yourfrontend.com/verify?token=${token}`
-
-        return `Hey ${user.email}, verify your email by clicking here: ${url}`
-      },
-      // highlight-end
-    },
-  },
-}
-```
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  If you specify a different URL to send your users to for email verification, such as a page on the
-  frontend of your app or similar, you need to handle making the call to the Payload REST or GraphQL
-  verification operation yourself on your frontend, using the token that was provided for you.
-  Above, it was passed via query parameter.
-</Banner>
-
-#### generateEmailSubject
-
-Similarly to the above `generateEmailHTML`, you can also customize the subject of the email. The function argument are the same but you can only return a string - not HTML.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    verify: {
-      // highlight-start
-      generateEmailSubject: ({ req, user }) => {
-        return `Hey ${user.email}, reset your password!`;
-      }
-      // highlight-end
-    }
-  }
-}
-```
-
-## Forgot Password
-
-You can customize how the Forgot Password workflow operates with the following options on the `auth.forgotPassword` property:
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    forgotPassword: { // highlight-line
-      // ...
-    },
-  },
-}
-```
-
-The following options are available:
-
-| Option               | Description                                                                                                                                                                                                                         |
-|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`generateEmailHTML`** | Allows for overriding the HTML within emails that are sent to users attempting to reset their password. [More details](#generateEmailHTML). |
-| **`generateEmailSubject`** | Allows for overriding the subject of the email that is sent to users attempting to reset their password. [More details](#generateEmailSubject). |
-
-#### generateEmailHTML
-
-This function allows for overriding the HTML within emails that are sent to users attempting to reset their password. The function should return a string that supports HTML, which can be a full HTML email.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    forgotPassword: {
-      // highlight-start
-      generateEmailHTML: ({ req, token, user }) => {
-        // Use the token provided to allow your user to reset their password
-        const resetPasswordURL = `https://yourfrontend.com/reset-password?token=${token}`
-
-        return `
-          <!doctype html>
-          <html>
-            <body>
-              <h1>Here is my custom email template!</h1>
-              <p>Hello, ${user.email}!</p>
-              <p>Click below to reset your password.</p>
-              <p>
-                <a href="${resetPasswordURL}">${resetPasswordURL}</a>
-              </p>
-            </body>
-          </html>
-        `
-      },
-      // highlight-end
-    },
-  },
-}
-```
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  If you specify a different URL to send your users to for resetting their password, such as a page
-  on the frontend of your app or similar, you need to handle making the call to the Payload REST or
-  GraphQL reset-password operation yourself on your frontend, using the token that was provided for
-  you. Above, it was passed via query parameter.
-</Banner>
-
-<Banner type="success">
-  <strong>Tip:</strong>
-  HTML templating can be used to create custom email templates, inline CSS automatically, and more.
-  You can make a reusable function that standardizes all email sent from Payload, which makes
-  sending custom emails more DRY. Payload doesn't ship with an HTML templating engine, so you are
-  free to choose your own.
-</Banner>
-
-The following arguments are passed to the `generateEmailHTML` function:
-
-| Argument | Description                                                                                   |
-|----------|-----------------------------------------------------------------------------------------------|
-| `req`    | The request object.                                                                           |
-| `token`  | The token that is generated for the user to reset their password.                             |
-| `user`   | The user document that is attempting to reset their password.                                 |
-
-#### generateEmailSubject
-
-Similarly to the above `generateEmailHTML`, you can also customize the subject of the email. The function argument are the same but you can only return a string - not HTML.
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Customers: CollectionConfig = {
-  // ...
-  auth: {
-    forgotPassword: {
-      // highlight-start
-      generateEmailSubject: ({ req, user }) => {
-        return `Hey ${user.email}, reset your password!`;
-      }
-      // highlight-end
-    }
-  }
-}
-```
-
-The following arguments are passed to the `generateEmailSubject` function:
-
-| Argument | Description                                                                                   |
-|----------|-----------------------------------------------------------------------------------------------|
-| `req`    | The request object.                                                                           |
-| `user`   | The user document that is attempting to reset their password.                                 |

docs/authentication/http-only-cookies.mdx

@@ -1,16 +1,19 @@
 ---
 title: Cookie Strategy
 label: Cookie Strategy
-order: 40
+order: 30
 desc: Enable HTTP Cookie based authentication to interface with Payload.
 keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Payload offers the ability to [Authenticate](./overview) via HTTP-only cookies. These can be read from the responses of `login`, `logout`, `refresh`, and `me` auth operations.
+Payload `login`, `logout`, and `refresh` operations make use of HTTP-only cookies for authentication purposes.
 
 <Banner type="success">
   <strong>Tip:</strong>
-  You can access the logged-in user from within [Access Control](../access-control/overview) and [Hooks](../hooks/overview) through the `req.user` argument. [More details](./token-data).
+  <br />
+  You can access the logged-in user from access control functions and hooks from the `req.user` property.
+  <br />
+  [Learn more about token data](/docs/authentication/token-data).
 </Banner>
 
 ### Automatic browser inclusion
@@ -35,6 +38,7 @@ For more about including cookies in requests from your app to your Payload API,
 
 <Banner type="success">
   <strong>Tip:</strong>
+  <br />
   To make sure you have a Payload cookie set properly in your browser after logging in, you can use
   the browsers Developer Tools > Application > Cookies > [your-domain-here]. The Developer tools
   will still show HTTP-only cookies.
@@ -61,7 +65,7 @@ In this scenario, if your cookie was still valid, malicious-intent.com would be
 
 ### CSRF Prevention
 
-Define domains that your trust and are willing to accept Payload HTTP-only cookie based requests from. Use the `csrf` option on the base Payload Config to do this:
+Define domains that your trust and are willing to accept Payload HTTP-only cookie based requests from. Use the `csrf` option on the base Payload config to do this:
 
 ```ts
 // payload.config.ts
@@ -85,47 +89,3 @@ const config = buildConfig({
 
 export default config
 ```
-
-#### Cross domain authentication
-
-If your frontend is on a different domain than your Payload API then you will not be able to use HTTP-only cookies for authentication by default as they will be considered third-party cookies by the browser.
-There are a few strategies to get around this:
-
-##### 1. Use subdomains
-
-Cookies can cross subdomains without being considered third party cookies, for example if your API is at api.example.com then you can authenticate from example.com.
-
-##### 2. Configure cookies
-
-If option 1 isn't possible, then you can get around this limitation by [configuring your cookies](./overview#config-options) on your authentication collection to achieve the following setup:
-
-```
-SameSite: None // allows the cookie to cross domains
-Secure: true // ensures its sent over HTTPS only
-HttpOnly: true // ensures its not accessible via client side JavaScript
-```
-
-Configuration example:
-
-```ts
-{
-  slug: 'users',
-  auth: {
-    cookies: {
-      sameSite: 'None',
-      secure: true,
-    }
-  },
-  fields: [
-    // your auth fields here
-  ]
-},
-```
-
-If you're configuring [cors](../production/preventing-abuse#cross-origin-resource-sharing-cors) in your Payload config, you won't be able to use a wildcard anymore, you'll need to specify the list of allowed domains.
-
-
-<Banner type="success">
-  <strong>Good to know:</strong>
-  Setting up <code>secure: true</code> will not work if you're developing on <code>http://localhost</code> or any non-https domain. For local development you should conditionally set this to <code>false</code> based on the environment.
-</Banner>

docs/authentication/jwt.mdx

@@ -6,11 +6,14 @@ desc: Enable JSON Web Token based authentication to interface with Payload.
 keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Payload offers the ability to [Authenticate](./overview) via JSON Web Tokens (JWT). These can be read from the responses of `login`, `logout`, `refresh`, and `me` auth operations.
+Payload offers the ability to authenticate via `JWT` (JSON web token). These can be read from the responses of `login`, `refresh`, and `me` auth operations.
 
 <Banner type="success">
   <strong>Tip:</strong>
-  You can access the logged-in user from within [Access Control](../access-control/overview) and [Hooks](../hooks/overview) through the `req.user` argument. [More details](./token-data).
+  <br />
+  You can access the logged-in user from access control functions and hooks from the `req.user` property.
+  <br />
+  [Learn more about token data](/docs/authentication/token-data).
 </Banner>
 
 ### Identifying Users Via The Authorization Header

docs/authentication/operations.mdx

@@ -1,16 +1,16 @@
 ---
 title: Authentication Operations
 label: Operations
-order: 20
+order: 80
 desc: Enabling Authentication automatically makes key operations available such as Login, Logout, Verify, Unlock, Reset Password and more.
 keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Enabling [Authentication](./overview) on a [Collection](../configuration/collections) automatically exposes additional auth-based operations in the [Local API](../local-api/overview), [REST API](../rest-api/overview), and [GraphQL API](../graphql/overview).
+Enabling Authentication on a Collection automatically exposes additional auth-based operations in the Local, REST, and GraphQL APIs.
 
 ## 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](../access-control/overview), just as the [Admin Panel](../admin/overview) does.
+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.
 
 **REST API endpoint**:
 
@@ -271,9 +271,9 @@ const result = await payload.verifyEmail({
 
 ## Unlock
 
-If a user locks themselves out and you wish to deliberately unlock them, you can utilize the Unlock operation. The [Admin Panel](../admin/overview) 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.
+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.
 
-To restrict who is allowed to unlock users, you can utilize the [`unlock`](../access-control/overview#unlock) access control function.
+To restrict who is allowed to unlock users, you can utilize the [`unlock`](/docs/access-control/overview#unlock) access control function.
 
 **Example REST API unlock**:
 
@@ -308,7 +308,7 @@ Payload comes with built-in forgot password functionality. Submitting an email a
 
 The link to reset the user's password contains a token which is what allows the user to securely reset their password.
 
-By default, the Forgot Password operations send users to the [Admin Panel](../admin/overview) to reset their password, but you can customize the generated email to send users to the frontend of your app instead by [overriding the email HTML](/docs/authentication/overview#forgot-password).
+By default, the Forgot Password operations send users to the Payload Admin panel to reset their password, but you can customize the generated email to send users to the frontend of your app instead by [overriding the email HTML](/docs/authentication/config#forgot-password).
 
 **Example REST API Forgot Password**:
 

docs/authentication/overview.mdx

@@ -11,47 +11,38 @@ keywords: authentication, config, configuration, overview, documentation, Conten
   title="Simplified Authentication for Headless CMS: Unlocking Reusability in One Line"
 />
 
-Authentication is a critical part of any application. Payload provides a secure, portable way to manage user accounts out of the box. Payload Authentication is designed to be used in both the [Admin Panel](../admin/overview), all well as your own external applications, completely eliminating the need for paid, third-party platforms and services.
-
-Here are some common use cases of Authentication in your own applications:
-
-- Customer accounts for an e-commerce app
-- User accounts for a SaaS product
-- P2P apps or social sites where users need to log in and manage their profiles
-- Online games where players need to track their progress over time
-
-When Authentication is enabled on a [Collection](../configuration/collections), Payload injects all necessary functionality to support the entire user flow. This includes all [auth-related operations](./operations) like account creation, logging in and out, and resetting passwords, all [auth-related emails](./email) like email verification and password reset, as well as any necessary UI to manage users from the Admin Panel.
-
-To enable Authentication on a Collection, use the `auth` property in the [Collection Config](../configuration/collection#auth):
-
-```ts
-import type { CollectionConfig } from 'payload'
-
-export const Users: CollectionConfig = {
-  // ...
-  auth: true, // highlight-line
-}
-```
-
-![Authentication Admin Panel functionality](https://payloadcms.com/images/docs/auth-admin.jpg)
-_Admin Panel screenshot depicting an Admins Collection with Auth enabled_
-
-## Config Options
-
-Any [Collection](../configuration/collections) can opt-in to supporting Authentication. Once enabled, each Document that is created within the Collection can be thought of as a "user". This enables a complete authentication workflow on your Collection, such as logging in and out, resetting their password, and more.
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  By default, Payload provides an auth-enabled `User` Collection which is used to access the Admin Panel. [More details](../admin/overview#the-admin-user-collection).
+<Banner>
+  Payload provides for highly secure and customizable user Authentication out of the box, which
+  allows for users to identify themselves to Payload.
 </Banner>
 
-To enable Authentication on a Collection, use the `auth` property in the [Collection Config](../configuration/collections):
+Authentication is used within the Payload Admin panel itself as well as throughout your app(s) themselves however you determine necessary.
+
+![Authentication admin panel functionality](https://payloadcms.com/images/docs/auth-admin.jpg)
+_Admin panel screenshot depicting an Admins Collection with Auth enabled_
+
+**Here are some common use cases of Authentication outside of Payload's dashboard itself:**
+
+- Customer accounts for an ecommerce app
+- Customer accounts for a SaaS product
+- P2P app or social site where users need to log in and manage their profiles
+- Online game where players need to track their progress over time
+
+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
+
+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.
+
+**For a full list of all `auth` options, [click here](/docs/authentication/config).**
+
+Simple example collection:
 
 ```ts
-import type { CollectionConfig } from 'payload'
+import { CollectionConfig } from 'payload/types'
 
 export const Admins: CollectionConfig = {
-  // ...
+  slug: 'admins',
   // highlight-start
   auth: {
     tokenExpiration: 7200, // How many seconds to keep the user logged in
@@ -61,137 +52,53 @@ export const Admins: CollectionConfig = {
     // More options are available
   },
   // highlight-end
-}
-```
-
-<Banner type="info">
-  <strong>Tip:</strong>
-  For default auth behavior, set `auth: true`. This is a good starting point for most applications.
-</Banner>
-
-<Banner type="warning">
-  <strong>Note:</strong>
-  Auth-enabled Collections with be automatically injected with the `hash`, `salt`, and `email` fields. [More details](../fields/overview#field-names).
-</Banner>
-
-The following options are available:
-
-| Option                     | Description                                                                                                                                                                                                                         |
-|----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`cookies`**              | Set cookie options, including `secure`, `sameSite`, and `domain`. For advanced users.                                                                                                                                               |
-| **`depth`**                | How many levels deep a `user` document should be populated when creating the JWT and binding the `user` to the `req`. Defaults to `0` and should only be modified if absolutely necessary, as this will affect performance. |
-| **`disableLocalStrategy`** | Advanced - disable Payload's built-in local auth strategy. Only use this property if you have replaced Payload's auth mechanisms with your own.                                                                                     |
-| **`forgotPassword`**       | Customize the way that the `forgotPassword` operation functions. [More details](./email#forgot-password).                                                                                                             |
-| **`lockTime`**             | Set the time (in milliseconds) that a user should be locked out if they fail authentication more times than `maxLoginAttempts` allows for.                                                                                          |
-| **`loginWithUsername`**    | Ability to allow users to login with username/password. [More](/docs/authentication/overview#login-with-username)                                                                                                                     |
-| **`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.                                                                       |
-| **`removeTokenFromResponses`** | Set to true if you want to remove the token from the returned authentication API responses such as login or refresh.                                                                                                                                                            |
-| **`strategies`**           | Advanced - an array of custom authentication strategies to extend this collection's authentication with. [More details](./custom-strategies).                                                                         |
-| **`tokenExpiration`**      | How long (in seconds) to keep the user logged in. JWTs and HTTP-only cookies will both expire at the same time.                                                                                                                     |
-| **`useAPIKey`**            | Payload Authentication provides for API keys to be set on each user within an Authentication-enabled Collection. [More details](./api-keys).                                                                       |
-| **`verify`**               | Set to `true` or pass an object with verification options to require users to verify by email before they are allowed to log into your app. [More details](./email#email-verification).                                  |
-
-### Login With Username
-
-You can allow users to login with their username instead of their email address by setting the `loginWithUsername` property to `true`.
-
-Example:
-
-```ts
-{
-  slug: 'customers',
-  auth: {
-    loginWithUsername: true,
-  },
-}
-```
-
-Or, you can pass an object with additional options:
-
-```ts
-{
-  slug: 'customers',
-  auth: {
-    loginWithUsername: {
-      allowEmailLogin: true, // default: false
-      requireEmail: false, // default: false
+  fields: [
+    {
+      name: 'role',
+      type: 'select',
+      required: true,
+      options: ['user', 'admin', 'editor', 'developer'],
     },
-  },
+  ],
 }
 ```
 
-**`allowEmailLogin`**
+**By enabling Authentication on a config, the following modifications will automatically be made to your Collection:**
 
-If set to `true`, users can log in with either their username or email address. If set to `false`, users can only log in with their username.
+1. `email` as well as password `salt` & `hash` fields will be added to your Collection's schema
+1. The Admin panel will feature a new set of corresponding UI to allow for changing password and editing email
+1. [A new set of `operations`](/docs/authentication/operations) will be exposed via Payload's REST, Local, and GraphQL APIs
 
-**`requireEmail`**
+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.
 
-If set to `true`, an email address is required when creating a new user. If set to `false`, email is not required upon creation.
+## Authentication Strategies
 
-## Auto-Login
-
-For testing and demo purposes you may want to skip forcing the user to login in order to access your application. Typically, all users should be required to login, however, you can speed up local development time by enabling auto-login.
-
-To enable auto-login, set the `autoLogin` property in the [Admin Config](../configuration/admin):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  // highlight-start
-  autoLogin:
-    process.env.NEXT_PUBLIC_ENABLE_AUTOLOGIN === 'true'
-      ? {
-          email: 'test@example.com',
-          password: 'test',
-          prefillOnly: true,
-        }
-      : false,
-  // highlight-end
-})
-```
-
-<Banner type="warning">
-  <strong>Warning:</strong>
-  The recommended way to use this feature is behind an [Environment Variable](../configuration/environment-vars). This will ensure it is _disabled_ in production.
-</Banner>
-
-The following options are available:
-
-| Option            | Description                                                                                                     |
-|-------------------|-----------------------------------------------------------------------------------------------------------------|
-| **`username`**    | The username of the user to login as                                                                            |
-| **`email`**       | The email address of the user to login as                                                                       |
-| **`password`**    | The password of the user to login as. This is only needed if `prefillOnly` is set to true                       |
-| **`prefillOnly`** | If set to true, the login credentials will be prefilled but the user will still need to click the login button. |
-
-## Operations
-
-All auth-related operations are available via Payload's REST, Local, and GraphQL APIs. These operations are automatically added to your Collection when you enable Authentication. [More details](./operations).
-
-## Strategies
-
-Out of the box Payload ships with a three powerful Authentication strategies:
-
-- [HTTP-Only Cookies](./cookies)
-- [JSON Web Tokens (JWT)](./jwt)
-- [API-Keys](./api-keys)
-
-Each of these strategies can work together or independently. You can also create your own custom strategies to fit your specific needs. [More details](./custom-strategies).
+Out of the box Payload ships with a few powerful authentication strategies. HTTP-Only Cookies, JWT's and API-Keys, they can work together or individually. You can also have multiple collections that have auth enabled, but only 1 of them can be used to log into the admin panel.
 
 ### HTTP-Only Cookies
 
-[HTTP-only cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/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 <strong>cannot be read by JavaScript in the browser</strong>, unlike JWT's. [More details](./cookies).
+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 <strong>cannot be read by JavaScript in the browser</strong>, unlike JWT's.
+
+You can learn more about this strategy from the [HTTP-Only Cookies](/docs/authentication/http-only-cookies) docs.
 
 ### JSON Web Tokens
 
-JWT (JSON Web Tokens) can also be utilized to perform authentication. Tokens are generated on `login`, `refresh` and `me` operations and can be attached to future requests to authenticate users. [More details](./jwt).
+JWT (JSON Web Tokens) can also be utilized to perform authentication. Tokens are generated on `login`, `refresh` and `me` operations and can be attached to future requests to authenticate users.
+
+You can learn more about this strategy from the [JWT](/docs/authentication/jwt) docs.
 
 ### API Keys
 
-API Keys can be enabled on auth collections. These are particularly useful when you want to authenticate against Payload from a third party service. [More details](./api-keys).
+API Keys can be enabled on auth collections. These are particularly useful when you want to authenticate against Payload from a third party service.
+
+You can learn more about this strategy from the [API Keys](/docs/authentication/api-keys) docs.
 
 ### Custom Strategies
 
-There are cases where these may not be enough for your application. Payload is extendable by design so you can wire up your own strategy when you need to. [More details](./custom-strategies).
+There are cases where these may not be enough for your application. Payload is extendable by design so you can wire up your own strategy when you need to.
+
+You can learn more about custom strategies from the [Custom Strategies](/docs/authentication/custom-strategies) docs.
+
+## 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.

docs/authentication/token-data.mdx

@@ -6,7 +6,7 @@ desc: Storing data for read on the request object.
 keywords: authentication, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-During the lifecycle of a request you will be able to access the data you have configured to be stored in the JWT by accessing `req.user`. The user object is automatically appended to the request for you.
+During the lifecycle of a request you will be able to access the data you have configured to be stored in the JWT by accessing `req.user`. The user object is automatically appeneded to the request for you.
 
 ### Definining Token Data
 
@@ -78,7 +78,7 @@ export const Users: CollectionConfig = {
 
 ### Using Token Data
 
-This is especially helpful when writing [Hooks](../hooks/overview) and [Access Control](../access-control/overview) that depend on user defined fields.
+This is especially helful when writing hooks and access control that depend on user defined fields.
 
 ```ts
 import type { CollectionConfig } from 'payload'

docs/cloud/configuration.mdx

@@ -44,9 +44,9 @@ If you are deploying a new project from a template, the following settings will
 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.
 
 <Banner type="warning">
-  Note: For security reasons, any variables you wish to provide to the [Admin Panel](../admin/overview) must be prefixed
+  Note: For security reasons, any variables you wish to provide to the Admin panel must be prefixed
   with `NEXT_PUBLIC_`.  Learn more
-  [here](../configuration/environment-vars).
+  [here](https://payloadcms.com/docs/admin/environment-vars).
 </Banner>
 
 ## Payment

docs/cloud/projects.mdx

@@ -59,7 +59,9 @@ You can update settings from your Project’s Settings tab. Changes to your buil
 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.
 
 <Banner>
-  Note: For security reasons, any variables you wish to provide to the [Admin Panel](../admin/overview) must be prefixed with `NEXT_PUBLIC_`. [More details](../configuration/environment-vars).
+  Note: For security reasons, any variables you wish to provide to the Admin panel must be prefixed
+  with `PAYLOAD_PUBLIC_`.  Learn more
+  [here](https://payloadcms.com/docs/admin/environment-vars).
 </Banner>
 
 ## Custom Domains
@@ -84,7 +86,7 @@ export default buildConfig({
 
 ## 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](../email/overview) overview.
+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.
 
@@ -96,30 +98,25 @@ From there, you are ready to make updates to your project. When you are ready to
 
 ## 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:
+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:
 
-`yarn add @payloadcms/payload-cloud`
+`yarn add @payloadcms/plugin-cloud`
 
 ```js
-import { payloadCloudPlugin } from '@payloadcms/payload-cloud'
-import { buildConfig } from 'payload'
+import { payloadCloud } from '@payloadcms/plugin-cloud'
+import { buildConfig } from 'payload/config'
 
 export default buildConfig({
-  plugins: [payloadCloudPlugin()],
+  plugins: [payloadCloud()],
   // rest of config
 })
 ```
 
 <Banner type="warning">
-  **Note:** If your Payload Config already has an email with transport, this will take precedence
+  **Note:** If your Payload config already has an email with transport, this will take precedence
   over Payload Cloud's email service.
 </Banner>
 
-<Banner type="info">
-  Good to know: the Payload Cloud Plugin was previously named `@payloadcms/plugin-cloud`. If you are
-  using this plugin, you should update to the new package name.
-</Banner>
-
 #### **Optional configuration**
 
 If you wish to opt-out of any Payload cloud features, the plugin also accepts options to do so.

docs/configuration/collections.mdx

@@ -6,103 +6,184 @@ desc: Structure your Collections for your needs by defining fields, adding slugs
 keywords: collections, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-A Collection is a group of records, called Documents, that all share a common schema. You can define as many Collections as your application needs. Each Document in a Collection is stored in the [Database](../database/overview) based on the [Fields](../fields/overview) that you define, and automatically generates a [Local API](../local-api/overview), [REST API](../rest-api/overview), and [GraphQL API](../graphql/overview) used to manage your Documents.
+Payload Collections are defined through configs of their own, and you can define as many as your application needs. Each Collection will scaffold a new collection automatically in your database of choice, based on fields that you define.
 
-Collections are also used to achieve [Authentication](../authentication/overview) in Payload. By defining a Collection with `auth` options, that Collection receives additional operations to support user authentication.
+It's often best practice to write your Collections in separate files and then import them into the main Payload config.
 
-Collections are the primary way to structure recurring data in your application, such as users, products, pages, posts, and other types of content that you might want to manage. Each Collection can have its own unique [Access Control](../access-control/overview), [Hooks](../hooks/overview), [Admin Options](#admin-options), and more.
+## Options
 
-To define a Collection Config, use the `collection` property in your [Payload Config](./overview):
+| 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.                                                               |
+| **`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
 
 ```ts
-import { buildConfig } from 'payload'
+import { CollectionConfig } from 'payload'
 
-export default buildConfig({
-  // ...
-  collections: [ // highlight-line
-    // Your Collections go here
+export const Orders: CollectionConfig = {
+  slug: 'orders',
+  fields: [
+    {
+      name: 'total',
+      type: 'number',
+      required: true,
+    },
+    {
+      name: 'placedBy',
+      type: 'relationship',
+      relationTo: 'customers',
+      required: true,
+    },
   ],
-})
+}
 ```
 
-<Banner type="success">
-  <strong>Tip:</strong>
-  If your Collection is only ever meant to contain a single Document, consider using a [Global](./globals) instead.
-</Banner>
+### More collection config examples
 
-## Config Options
+You can find an assortment
+of [example collection configs](https://github.com/payloadcms/public-demo/tree/master/src/payload/collections) in the Public
+Demo source code on GitHub.
 
-It's often best practice to write your Collections in separate files and then import them into the main [Payload Config](../overview).
+You can also find full, ready-to-go [Ecommerce](https://github.com/payloadcms/payload/tree/main/templates/ecommerce) and [Website](https://github.com/payloadcms/payload/tree/main/templates/website) templates on our GitHub repo.
 
-Here is what a simple Collection Config might look like:
+## 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.                                                                                              |
+| `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
+
+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.
+
+If the function is specified, a Preview button will automatically appear in the corresponding collection's Edit view.
+Clicking the Preview button will link to the URL that is generated by the function.
+
+**The preview function accepts two arguments:**
+
+1. The document being edited
+1. An `options` object, containing `locale`, `req` and `token` properties. The `token` is the currently logged-in user's JWT.
+
+**Example collection with preview function:**
 
 ```ts
-import type { CollectionConfig } from 'payload'
+import { CollectionConfig } from 'payload'
 
 export const Posts: CollectionConfig = {
   slug: 'posts',
   fields: [
     {
-      name: 'title',
+      name: 'slug',
       type: 'text',
-    }
-  ]
+      required: true,
+    },
+  ],
+  admin: {
+    preview: (doc, { locale }) => {
+      if (doc?.slug) {
+        return `https://bigbird.com/preview/posts/${doc.slug}?locale=${locale}`
+      }
+
+      return null
+    },
+  },
 }
 ```
 
-<Banner type="success">
-  <strong>Reminder:</strong>
-  For a more complex example, see the [Public Demo](https://github.com/payloadcms/public-demo) source code on GitHub, or the [Templates](https://github.com/payloadcms/payload/tree/main/templates) and [Examples](https://github.com/payloadcms/payload/tree/main/examples) directories in the Payload repository.
+## 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
+
+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 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
+
+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
+
+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
+define more than one field to search to make it easier on your admin editors to find the data they need.
+
+For example, let's say you have a Posts collection with `title`, `metaDescription`, and `tags` fields - and you want all
+three of those fields to be searchable in the List view. You can simply
+add `admin.listSearchableFields: ['title', 'metaDescription', 'tags']` - and the admin UI will automatically search on
+those three fields plus the ID field.
+
+<Banner type="warning">
+  <strong>Note:</strong>
+  <br />
+  If you are adding <strong>listSearchableFields</strong>, make sure you index each of these fields
+  so your admin queries can remain performant.
 </Banner>
 
-The following options are available:
-
-| Option                 | Description                                                                                                                                                                                                          |
-| ---------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`admin`**            | The configuration options for the Admin Panel. [More details](../admin/collections).                                                                                                                                 |
-| **`access`**           | Provide Access Control functions to define exactly who should be able to do what with Documents in this Collection. [More details](../access-control/collections).                                                   |
-| **`auth`**             | Specify options if you would like this Collection to feature authentication. [More details](../authentication/overview).                                                                                             |
-| **`custom`**           | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                            |
-| **`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. Multiple fields can be specified by using a string array. |
-| **`dbName`**           | Custom table or Collection name depending on the Database Adapter. Auto-generated from slug if not defined.                                                                                                          |
-| **`endpoints`**        | Add custom routes to the REST API. Set to `false` to disable routes. [More details](../rest-api/overview#custom-endpoints).                                                                                          |
-| **`fields`** \*        | Array of field types that will determine the structure and functionality of the data stored within this Collection. [More details](../fields/overview).                                                              |
-| **`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.                                                        |
-| **`hooks`**            | Entry point for Hooks. [More details](../hooks/overview#collection-hooks).                                                                                                                                           |
-| **`labels`**           | Singular and plural labels for use in identifying this Collection throughout Payload. Auto-generated from slug if not defined.                                                                                       |
-| **`lockDocuments`**    | Enables or disables document locking. By default, document locking is enabled. Set to an object to configure, or set to `false` to disable locking. [More details](../admin/locked-documents).                       |
-| **`slug`** \*          | Unique, URL-friendly string that will act as an identifier for this Collection.                                                                                                                                      |
-| **`timestamps`**       | Set to false to disable documents' automatically generated `createdAt` and `updatedAt` timestamps.                                                                                                                   |
-| **`typescript`**       | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                  |
-| **`upload`**           | Specify options if you would like this Collection to support file uploads. For more, consult the [Uploads](../upload/overview) documentation.                                                                        |
-| **`versions`**         | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#collection-config).                                                                                  |
-| **`defaultPopulate`**  | Specify which fields to select when this Collection is populated from another document. [More Details](../queries/select#defaultpopulate-collection-config-property).                                                  |
-
-_\* An asterisk denotes that a property is required._
-
-### Fields
-
-Fields define the schema of the Documents within a Collection. To learn more, go to the [Fields](../fields/overview) documentation.
-
-### Access Control
-
-[Collection Access Control](../access-control/overview) determines what a user can and cannot do with any given Document within a Collection. To learn more, go to the [Access Control](../access-control/overview) documentation.
-
-### Hooks
-
-[Collection Hooks](../hooks/collections) allow you to tie into the lifecycle of your Documents so you can execute your own logic during specific events. To learn more, go to the [Hooks](../hooks/overview) documentation.
-
-### Admin Options
-
-You can customize the way that the [Admin Panel](../admin/overview) behaves on a Collection-by-Collection basis. To learn more, go to the [Collection Admin Options](../admin/collections) documentation.
-
 ## TypeScript
 
-You can import types from Payload to help make writing your Collection configs easier and type-safe. There are two main types that represent the Collection Config, `CollectionConfig` and `SanitizeCollectionConfig`.
-
-The `CollectionConfig` type represents a raw Collection Config in its full form, where only the bare minimum properties are marked as required. The `SanitizedCollectionConfig` type represents a Collection Config after it has been fully sanitized. Generally, this is only used internally by Payload.
+You can import collection types as follows:
 
 ```ts
-import type { CollectionConfig, SanitizedCollectionConfig } from 'payload'
+import { CollectionConfig } from 'payload'
+
+// This is the type used for incoming collection configs.
+// Only the bare minimum properties are marked as required.
+```
+
+```ts
+import { SanitizedCollectionConfig } from 'payload'
+
+// This is the type used after an incoming collection config is fully sanitized.
+// Generally, this is only used internally by Payload.
 ```

docs/configuration/environment-vars.mdx

@@ -1,101 +0,0 @@
----
-title: Environment Variables
-label: Environment Variables
-order: 100
-desc: Learn how to use Environment Variables in your Payload project
----
-
-Environment Variables are a way to store sensitive information that your application needs to function. This could be anything from API keys to [Database](../database/overview) credentials. Payload allows you to easily use Environment Variables within your config and throughout your application.
-
-## Next.js Applications
-
-If you are using Next.js, no additional setup is required other than creating your `.env` file.
-
-To use Environment Variables, add a `.env` file to the root of your project:
-
-```plaintext
-project-name/
-├─ .env
-├─ package.json
-├─ payload.config.ts
-```
-
-Here is an example of what an `.env` file might look like:
-
-```plaintext
-SERVER_URL=localhost:3000
-DATABASE_URI=mongodb://localhost:27017/my-database
-```
-
-To use Environment Variables in your Payload Config, you can access them directly from `process.env`:
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  serverURL: process.env.SERVER_URL, // highlight-line
-  // ...
-})
-```
-
-## Client-side Environments
-
-For security and safety reasons, the [Admin Panel](../admin/overview) does **not** include Environment Variables in its _client-side_ bundle by default. But, Next.js provides a mechanism to expose Environment Variables to the client-side bundle when needed.
-
-If you are building a [Custom Component](../admin/components) and need to access Environment Variables from the client-side, you can do so by prefixing them with `NEXT_PUBLIC_`.
-
-<Banner type="warning">
-  <strong>Important:</strong>
-  Be careful about what variables you provide to your client-side code. Analyze every single one to make sure that you're not accidentally leaking sensitive information. Only ever include keys that are safe for the public to read in plain text.
-</Banner>
-
-For example, if you've got the following Environment Variable:
-
-```bash
-NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXX
-```
-
-This key will automatically be made available to the client-side Payload bundle and can be referenced in your Custom Component as follows:
-
-```tsx
-'use client'
-import React from 'react'
-
-const stripeKey = process.env.NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY // highlight-line
-
-const MyClientComponent = () => {
-  // do something with the key
-
-  return (
-    <div>
-      My Client Component
-    </div>
-  )
-}
-```
-
-For more information, check out the [Next.js Documentation](https://nextjs.org/docs/app/building-your-application/configuring/environment-variables).
-
-## Outside of Next.js
-
-If you are using Payload outside of Next.js, we suggest using the [`dotenv`](https://www.npmjs.com/package/dotenv) package to handle Environment Variables from `.env` files. This will automatically load your Environment Variables into `process.env`.
-
-To do this, import the package as high up in your application as possible:
-
-```ts
-import dotenv from 'dotenv'
-dotenv.config() // highlight-line
-
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  serverURL: process.env.SERVER_URL,
-  // ...
-})
-```
-
-<Banner type="warning">
-  <strong>Tip:</strong>
-  Be sure that `dotenv` can find your `.env` file. By default, it will look for a file named `.env` in the root of your project. If you need to specify a different file, pass the path into the config options.
-</Banner>
-

docs/configuration/globals.mdx

@@ -6,38 +6,36 @@ 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, nextjs
 ---
 
-Globals are in many ways similar to [Collections](../configuration/collections), except they correspond to only a single Document. You can define as many Globals as your application needs. Each Global Document is stored in the [Database](../database/overview) based on the [Fields](../fields/overview) that you define, and automatically generates a [Local API](../local-api/overview), [REST API](../rest-api/overview), and [GraphQL API](../graphql/overview) used to manage your Documents.
+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.
 
-Globals are the primary way to structure singletons in Payload, such as a header navigation, site-wide banner alerts, or app-wide localized strings. Each Global can have its own unique [Access Control](../access-control/overview), [Hooks](../hooks/overview), [Admin Options](#admin-options), and more.
+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.
 
-To define a Global Config, use the `globals` property in your [Payload Config](./overview):
+## Options
 
-```ts
-import { buildConfig } from 'payload'
+| 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.                                                                                              |
+| **`description`**  | Text or React component to display below the Global header to give editors more information.                                                                                                                         |
+| **`admin`**        | Admin-specific configuration. See below for [more detail](/docs/configuration/globals#admin-options).                                                                                                                |
+| **`hooks`**        | Entry points to "tie in" to collection actions at specific points. [More](/docs/hooks/overview#global-hooks)                                                                                                         |
+| **`access`**       | Provide access control functions to define exactly who should be able to do what with this Global. [More](/docs/access-control/overview/#globals)                                                                    |
+| **`versions`**     | Set to true to enable default options, or configure with object properties. [More](/docs/versions/overview#globals-config)                                                                                           |
+| **`endpoints`**    | Add custom routes to the REST API. [More](/docs/rest-api/overview#custom-endpoints)                                                                                                                                  |
+| **`graphQL.name`** | Text used in schema generation. Auto-generated from slug if not defined.                                                                                                                                             |
+| **`typescript`**   | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                                                  |
+| **`custom`**       | Extension point for adding custom data (e.g. for plugins)                                                                                                                                                            |
+| **`dbName`**       | Custom table or collection name for this global depending on the database adapter. Auto-generated from slug if not defined.
 
-export default buildConfig({
-  // ...
-  globals: [ // highlight-line
-    // Your Globals go here
-  ],
-})
-```
+_\* An asterisk denotes that a property is required._
 
-<Banner type="success">
-  <strong>Tip:</strong>
-  If you have more than one Global that share the same structure, consider using a [Collection](../configuration/collections) instead.
-</Banner>
-
-## Config Options
-
-It's often best practice to write your Globals in separate files and then import them into the main [Payload Config](./overview).
-
-Here is what a simple Global Config might look like:
+### Simple Global example
 
 ```ts
 import { GlobalConfig } from 'payload'
 
-export const Nav: GlobalConfig = {
+const Nav: GlobalConfig = {
   slug: 'nav',
   fields: [
     {
@@ -56,56 +54,91 @@ export const Nav: GlobalConfig = {
     },
   ],
 }
+
+export default Nav
 ```
 
-<Banner type="success">
-  <strong>Reminder:</strong>
-  For a more complex example, see the [Public Demo](https://github.com/payloadcms/public-demo) source code on GitHub, or the [Templates](https://github.com/payloadcms/payload/tree/main/templates) and [Examples](https://github.com/payloadcms/payload/tree/main/examples) directories in the Payload repository.
-</Banner>
+### Global config example
 
-The following options are available:
+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.
 
-| Option              | Description                                                                                                                                                                                    |
-| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **`access`**        | Provide Access Control functions to define exactly who should be able to do what with this Global. [More details](../access-control/globals).                                                  |
-| **`admin`**         | The configuration options for the Admin Panel. [More details](../admin/globals).                                                                                                               |
-| **`custom`**        | Extension point for adding custom data (e.g. for plugins)                                                                                                                                      |
-| **`dbName`**        | Custom table or collection name for this Global depending on the Database Adapter. Auto-generated from slug if not defined.                                                                    |
-| **`description`**   | Text or React component to display below the Global header to give editors more information.                                                                                                   |
-| **`endpoints`**     | Add custom routes to the REST API. [More details](../rest-api/overview#custom-endpoints).                                                                                                      |
-| **`fields`** \*     | Array of field types that will determine the structure and functionality of the data stored within this Global. [More details](../fields/overview).                                            |
-| **`graphQL.name`**  | Text used in schema generation. Auto-generated from slug if not defined.                                                                                                                       |
-| **`hooks`**         | Entry point for Hooks. [More details](../hooks/overview#global-hooks).                                                                                                                         |
-| **`label`**         | Text for the name in the Admin Panel or an object with keys for each language. Auto-generated from slug if not defined.                                                                        |
-| **`lockDocuments`** | Enables or disables document locking. By default, document locking is enabled. Set to an object to configure, or set to `false` to disable locking. [More details](../admin/locked-documents). |
-| **`slug`** \*       | Unique, URL-friendly string that will act as an identifier for this Global.                                                                                                                    |
-| **`typescript`**    | An object with property `interface` as the text used in schema generation. Auto-generated from slug if not defined.                                                                            |
-| **`versions`**      | Set to true to enable default options, or configure with object properties. [More details](../versions/overview#globals-config).                                                               |
+## Admin options
 
-_\* An asterisk denotes that a property is required._
+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.
 
-### Fields
+| 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`.       |
 
-Fields define the schema of the Global. To learn more, go to the [Fields](../fields/overview) documentation.
+## Preview
 
-### Access Control
+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 Access Control](../access-control/globals) determines what a user can and cannot do with any given Global Document. To learn more, go to the [Access Control](../access-control/overview) documentation.
+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.
 
-### Hooks
+**The preview function accepts two arguments:**
 
-[Global Hooks](../hooks/globals) allow you to tie into the lifecycle of your Documents so you can execute your own logic during specific events. To learn more, go to the [Hooks](../hooks/overview) documentation.
+1. The document being edited
+1. An `options` object, containing `locale` and `token` properties. The `token` is the currently logged-in user's JWT.
 
-### Admin Options
+**Example global with preview function:**
 
-You can customize the way that the [Admin Panel](../admin/overview) behaves on a Global-by-Global basis. To learn more, go to the [Global Admin Options](../admin/globals) documentation.
+```ts
+import { GlobalConfig } from 'payload'
+
+export const MyGlobal: GlobalConfig = {
+  slug: 'my-global',
+  fields: [
+    {
+      name: 'slug',
+      type: 'text',
+      required: true,
+    },
+  ],
+  admin: {
+    preview: (doc, { locale }) => {
+      if (doc?.slug) {
+        return `https://bigbird.com/preview/${doc.slug}?locale=${locale}`
+      }
+
+      return null
+    },
+  },
+}
+```
+
+## 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.
+
+## Hooks
+
+Globals also fully support a smaller subset of Hooks. To learn more, go to the [Hooks](/docs/hooks/overview) documentation.
+
+## 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
 
-You can import types from Payload to help make writing your Global configs easier and type-safe. There are two main types that represent the Global Config, `GlobalConfig` and `SanitizeGlobalConfig`.
-
-The `GlobalConfig` type represents a raw Global Config in its full form, where only the bare minimum properties are marked as required. The `SanitizedGlobalConfig` type represents a Global Config after it has been fully sanitized. Generally, this is only used internally by Payload.
+You can import global types as follows:
 
 ```ts
-import type { GlobalConfig, SanitizedGlobalConfig } from 'payload'
+import { GlobalConfig } from 'payload'
+
+// This is the type used for incoming global configs.
+// Only the bare minimum properties are marked as required.
+```
+
+```ts
+import { SanitizedGlobalConfig } from 'payload/types'
+
+// This is the type used after an incoming global config is fully sanitized.
+// Generally, this is only used internally by Payload.
 ```

docs/configuration/i18n.mdx

@@ -6,84 +6,135 @@ 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, nextjs
 ---
 
-The [Admin Panel](../admin/overview) is translated in over [30 languages and counting](https://github.com/payloadcms/payload/tree/beta/packages/translations). With I18n, editors can navigate the interface and read API error messages in their preferred language. This is similar to [Localization](./localization), but instead of managing translations for the data itself, you are managing translations for your application's interface.
+Not only does Payload support managing localized content, it also has internationalization support so that admin users can work in their preferred language. 
 
-By default, Payload comes with preinstalled with English, but you can easily load other languages into your own application. Languages are automatically detected based on the request. If no language was detected, or if the user's language is not yet supported by your application, English will be chosen.
+By default, Payload comes with English installed as the language it uses. But, you can import and pass other languages to the Payload config as well. It's best to only support the languages that you need, because that way, the bundled JavaScript is kept to a minimum for your project.
 
-To configure I18n, use the `i18n` key in your [Payload Config](./overview):
+Here's an example for how to pass additional languages to Payload for use in translating:
 
 ```ts
 import { buildConfig } from 'payload'
+import { en } from 'payload/i18n/en'
+import { de } from 'payload/i18n/de'
 
 export default buildConfig({
-  // ...
-  i18n: { // highlight-line
-    // ...
-  },
-})
-```
-
-<Banner type="success">
-  <strong>Note:</strong>
-  If there is a language that Payload does not yet support, we accept [code contributions](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md).
-</Banner>
-
-## Config Options
-
-You can easily customize and override any of the i18n settings that Payload provides by default. Payload will use your custom options and merge them in with its own.
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  // highlight-start
-  i18n: {
-    fallbackLanguage: 'en', // default
-  }
-  // highlight-end
-})
-```
-
-The following options are available:
-
-| Option                | Description                                                                                                                                                                                                                   |
-| --------------------- | --------------------------------|
-| **`fallbackLanguage`**     | The language to fall back to if the user's preferred language is not supported. Default is `'en'`.                                                                                                                           |
-| **`translations`**    | An object containing the translations. The keys are the language codes and the values are the translations.                                                                                                                |
-| **`supportedLanguages`** | An object containing the supported languages. The keys are the language codes and the values are the translations.                                                                                                         |
-
-## Adding Languages
-
-You can easily add new languages to your Payload app by providing the translations for the new language. Payload maintains a number of built-in translations that can be imported from `@payloadcms/translations`, but you can also provide your own [Custom Translations](#custom-translations) to support any language.
-
-To add a new language, use the `i18n.supportedLanguages` key in your [Payload Config](./overview):
-
-```ts
-import { buildConfig } from 'payload'
-import { en } from '@payloadcms/translations/languages/en'
-import { de } from '@payloadcms/translations/languages/de'
-
-export default buildConfig({
-  // ...
-  // highlight-start
+  /**
+   * Payload accepts specific translations to use.
+   * This is completely optional and will default to English if not provided
+   */
   i18n: {
+    // Payload will support either English or German,
+    // able to be specified in preferences on a user-by-user basis
     supportedLanguages: { en, de },
   },
-  // highlight-end
+
+  // .. the rest of your config
 })
 ```
 
-<Banner type="warning">
- <strong>Tip:</strong>
- It's best to only support the languages that you need so that the bundled JavaScript is kept to a minimum for your project.
+
+### 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.
+
+**Example Payload config extending i18n:**
+
+```ts
+import { buildConfig } from 'payload/config'
+
+export default buildConfig({
+  //...
+  i18n: {
+    fallbackLng: 'en', // default
+    debug: false, // default
+    resources: {
+      en: {
+        custom: {
+          // namespace can be anything you want
+          key1: 'Translation with {{variable}}', // translation
+        },
+        // override existing translation keys
+        general: {
+          dashboard: 'Home',
+        },
+      },
+    },
+  },
+  //...
+})
+```
+
+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.
+
+Here is an example of a simple collection supporting both English and Spanish editors:
+
+```ts
+import { CollectionConfig } from 'payload'
+
+export const Articles: CollectionConfig = {
+  slug: 'articles',
+  labels: {
+    singular: {
+      en: 'Article',
+      es: 'Artículo',
+    },
+    plural: {
+      en: 'Articles',
+      es: 'Artículos',
+    },
+  },
+  admin: {
+    group: { en: 'Content', es: 'Contenido' },
+  },
+  fields: [
+    {
+      name: 'title',
+      type: 'text',
+      label: {
+        en: 'Title',
+        es: 'Título',
+      },
+      admin: {
+        placeholder: { en: 'Enter title', es: 'Introduce el título' },
+      },
+    },
+    {
+      name: 'type',
+      type: 'radio',
+      options: [
+        {
+          value: 'news',
+          label: { en: 'News', es: 'Noticias' },
+        }, // etc...
+      ],
+    },
+  ],
+}
+```
+
+## Admin UI
+
+The [Admin Panel](../admin/overview) 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.
+
+<Banner>
+  <strong>Note:</strong>
+  <br />
+  If there is a language that Payload does not yet support, we accept code
+  [contributions](https://github.com/payloadcms/payload/blob/main/CONTRIBUTING.md). You can also make and import your own translation files.
 </Banner>
 
-### Custom Translations
+## Node
 
-You can customize Payload's built-in translations either by extending existing languages or by adding new languages entirely. This can be done by injecting new translation strings into existing languages, or by providing an entirely new language keys altogether.
+Payload's backend sets 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.
 
-To add Custom Translations, use the `i18n.translations` key in your [Payload Config](./overview):
+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')`.
+
+## 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.
+
+**Example Payload config extending i18n:**
 
 ```ts
 import { buildConfig } from 'payload'
@@ -91,7 +142,7 @@ import { buildConfig } from 'payload'
 export default buildConfig({
   //...
   i18n: {
-    // highlight-start
+    fallbackLanguage: 'en', // default
     translations: {
       en: {
         custom: {
@@ -104,152 +155,67 @@ export default buildConfig({
         },
       },
     },
-    // highlight-end
   },
   //...
 })
 ```
 
-### Project Translations
+## Types for custom translations
 
-While Payload's built-in features come fully translated, you may also want to translate parts of your own project. This is possible in places like [Collections](./collections) and [Globals](./globals), such as on their labels and groups, field labels, descriptions or input placeholder text.
-
-To do this, provide the translations wherever applicable, keyed to the language code:
+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
-import type { CollectionConfig } from 'payload'
-
-export const Articles: CollectionConfig = {
-  slug: 'articles',
-  labels: {
-    singular: {
-      // highlight-start
-      en: 'Article',
-      es: 'Artículo',
-      // highlight-end
-    },
-    plural: {
-      // highlight-start
-      en: 'Articles',
-      es: 'Artículos',
-      // highlight-end
-    },
-  },
-  admin: {
-    group: {
-      // highlight-start
-      en: 'Content',
-      es: 'Contenido',
-      // highlight-end
-    },
-  },
-  fields: [
-    {
-      name: 'title',
-      type: 'text',
-      label: {
-        // highlight-start
-        en: 'Title',
-        es: 'Título',
-        // highlight-end
-      },
-      admin: {
-        placeholder: {
-          // highlight-start
-          en: 'Enter title',
-          es: 'Introduce el título'
-          // highlight-end
-        },
-      },
-    },
-  ],
-}
-```
-
-## Node
-
-Payload's backend sets 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')`.
-
-## TypeScript
-
-In order to use custom translations in your project, you need to provide the types for the translations.
-
-Here we create a shareable translations object. We will import this in both our custom components and in our Payload config.
-
-```ts
-// <rootDir>/custom-translations.ts
-
-import type { Config } from 'payload'
+'use client'
 import type { NestedKeysStripped } from '@payloadcms/translations'
+import type React from 'react'
 
-export const customTranslations: Config['i18n']['translations'] = {
+import { useTranslation } from '@payloadcms/ui/providers/Translation'
+
+const customTranslations = {
   en: {
     general: {
-      myCustomKey: 'My custom english translation',
+      test: 'Custom Translation',
     },
-    fields: {
-      addLabel: 'Add!',
-    }
   },
 }
 
-export type CustomTranslationsObject = typeof customTranslations.en
-export type CustomTranslationsKeys = NestedKeysStripped<CustomTranslationsObject>
-```
-
-Import the shared translations object into our Payload config so they are available for use:
-
-```ts
-// <rootDir>/payload.config.ts
-
-import { buildConfig } from 'payload'
-
-import { customTranslations } from './custom-translations'
-
-export default buildConfig({
-  //...
-  i18n: {
-    translations: customTranslations,
-  },
-  //...
-})
-```
-
-Import the shared translation types to use in your [Custom Component](../admin/components):
-
-```ts
-// <rootDir>/components/MyComponent.tsx
-
-'use client'
-import type React from 'react'
-import { useTranslation } from '@payloadcms/ui'
-
-import type { CustomTranslationsObject, CustomTranslationsKeys } from '../custom-translations'
+type CustomTranslationObject = typeof customTranslations.en
+type CustomTranslationKeys = NestedKeysStripped<CustomTranslationObject>
 
 export const MyComponent: React.FC = () => {
-  const { i18n, t } = useTranslation<CustomTranslationsObject, CustomTranslationsKeys>() // These generics merge your custom translations with the default client translations
+  const { i18n, t } = useTranslation<CustomTranslationObject, CustomTranslationKeys>() // These generics merge your custom translations with the default client translations
 
-  return t('general:myCustomKey')
+  return t('general:test')
 }
+
 ```
 
-Additionally, Payload exposes the `t` function in various places, for example in labels. Here is how you would type those:
+Additionally, payload exposes the `t` function in various places, for example in labels. Here is how you would type those:
 
 ```ts
-// <rootDir>/fields/myField.ts
+import type {
+  DefaultTranslationKeys,
+  NestedKeysStripped,
+  TFunction,
+} from '@payloadcms/translations'
+import type { Field } from 'payload/types'
 
-import type { DefaultTranslationKeys, TFunction } from '@payloadcms/translations'
-import type { Field } from 'payload'
+const customTranslations = {
+  en: {
+    general: {
+      test: 'Custom Translation',
+    },
+  },
+}
 
-import { CustomTranslationsKeys } from '../custom-translations'
+type CustomTranslationObject = typeof customTranslations.en
+type CustomTranslationKeys = NestedKeysStripped<CustomTranslationObject>
 
 const field: Field = {
   name: 'myField',
   type: 'text',
   label: (
-    { t }: { t: TFunction<CustomTranslationsKeys | 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 }: { 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'),
 }
 ```

docs/configuration/localization.mdx

@@ -2,46 +2,36 @@
 title: Localization
 label: Localization
 order: 50
-desc: Add and maintain as many locales as you need by adding Localization to your Payload Config, set options for default locale, fallbacks, fields and more.
+desc: Add and maintain as many locales as you need by adding Localization to your Payload config, set options for default locale, fallbacks, fields and more.
 keywords: localization, internationalization, i18n, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Localization is one of the most important features of a modern CMS. It allows you to manage content in multiple languages, then serve it to your users based on their requested language. This is similar to [I18n](./i18n), but instead of managing translations for your application's interface, you are managing translations for the data itself.
+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.
 
-With Localization, you can begin to serve personalized content to your users based on their specific language preferences, such as a multilingual website or multi-site application. There are no limits to the number of locales you can add to your Payload project.
+## Enabling in the Payload config
 
-To configure Localization, use the `localization` key in your [Payload Config](./overview):
+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.
+
+**Example Payload config set up for localization:**
 
 ```ts
 import { buildConfig } from 'payload'
 
 export default buildConfig({
-  // ...
-  localization: { // highlight-line
-    // ...
-  },
-})
-```
-
-## Config Options
-
-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.
-
-To configure locales, use the `localization.locales` property in your [Payload Config](./overview):
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
+  collections: [
+    // collections go here
+  ],
   localization: {
-    locales: ['en', 'es', 'de'] // required
-    defaultLocale: 'en', // required
+    locales: ['en', 'es', 'de'],
+    defaultLocale: 'en',
+    fallback: true,
   },
 })
 ```
 
-You can also define locales using [full configuration objects](#locale-object):
+**Example Payload config set up for localization with full locales objects:**
 
 ```ts
 import { buildConfig } from 'payload'
@@ -64,32 +54,56 @@ export default buildConfig({
         rtl: true,
       },
     ],
-    defaultLocale: 'en', // required
+    defaultLocale: 'en',
     fallback: true,
   },
 })
 ```
 
-<Banner type="success">
-  <strong>Tip:</strong>
-  Localization works very well alongside [I18n](/docs/configuration/i18n).
-</Banner>
+**Example Payload config set up for localization with full locales objects (
+including [internationalization](/docs/configuration/i18n) support):**
 
-The following options are available:
+```ts
+import { buildConfig } from 'payload'
 
-| Option         | Description                                                                                                                    |
-| -------------- | ------------------------------------------------------------------------------------------------------------------------------ |
-| **`locales`**  | Array of all the languages that you would like to support. [More details](#locales)                                            |
-| **`defaultLocale`** | Required string that matches one of the locale codes from the array provided. By default, if no locale is specified, documents will be returned in this locale. |
-| **`fallback`** | Boolean enabling "fallback" locale functionality. If a document is requested in a locale, but a field does not have a 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. |
+export default buildConfig({
+  collections: [
+    // collections go here
+  ],
+  localization: {
+    locales: [
+      {
+        label: {
+          en: 'English', // English label
+          nb: 'Engelsk', // Norwegian label
+        },
+        code: 'en',
+      },
+      {
+        label: {
+          en: 'Norwegian', // English label
+          nb: 'Norsk', // Norwegian label
+        },
+        code: 'nb',
+      },
+    ],
+    defaultLocale: 'en',
+    fallback: true,
+  },
+})
+```
 
-### Locales
+**Here is a brief explanation of each of the options available within the `localization` property:**
 
-The locales array is a list of all the languages that you would like to support. This can be strings for each language code, or [full configuration objects](#locale-object) for more advanced options.
+**`locales`**
 
-The locale codes do not need to be in any specific format. It's up to you 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.
+Array-based list of all the languages that you would like to support. This can be an array containing strings for each
+language code you want your project to store and serve or objects with a `label`, a locale `code`, `rtl` (
+right-to-left), and `fallbackLocale` property. The locale codes do not need to be in any specific format. It's up to you
+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
+## Locale Object Properties
 
 | Option               | Description                                                                                                                    |
 | -------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
@@ -100,11 +114,23 @@ The locale codes do not need to be in any specific format. It's up to you to def
 
 _\* An asterisk denotes that a property is required._
 
-## Field Localization
+**`defaultLocale`**
 
-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.
+Required string that matches one of the locale codes from the array provided. By default, if no locale is specified,
+documents will be returned in this locale.
 
-**Here is an example of how to enable Localization for a field:**
+**`fallback`**
+
+Boolean enabling "fallback" locale functionality. If a document is requested in a locale, but a field does not have a
+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
+
+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.
+
+**Here is an example of how to enable localization for a field:**
 
 ```js
 {
@@ -116,27 +142,31 @@ Payload Localization works on a **field** level—not a document level. In addit
 }
 ```
 
-With the above configuration, the `title` field will now be saved in the database as an object of all locales instead of a single string.
+With the above configuration, the `title` field will now be saved in the database as an object of all locales instead of
+a single string.
 
-All field types with a `name` property support the `localized` property—even the more complex field types like `array`s and `block`s.
+All field types with a `name` property support the `localized` property—even the more complex field types like `array`s
+and `block`s.
 
-<Banner type="info">
+<Banner>
   <strong>Note:</strong>
-  Enabling Localization for field types that support nested fields will automatically create
+  <br />
+  Enabling localization for field types that support nested fields will automatically create
   localized "sets" of all fields contained within the field. For example, if you have a page layout
   using a blocks field type, you have the choice of either localizing the full layout, by enabling
-  Localization on the top-level blocks field, or only certain fields within the layout.
+  localization on the top-level blocks field, or only certain fields within the layout.
 </Banner>
 
 <Banner type="warning">
   <strong>Important:</strong>
+  <br />
   When converting an existing field to or from `localized: true` the data structure in the document
   will change for this field and so existing data for this field will be lost. Before changing the
-  Localization setting on fields with existing data, you may need to consider a field migration
+  localization setting on fields with existing data, you may need to consider a field migration
   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.
@@ -152,7 +182,7 @@ Specify your desired locale by providing the `locale` query parameter directly i
 **`?fallback-locale=`**
 
 Specify fallback locale to be used by providing the `fallback-locale` query parameter. This can be provided as either a
-valid locale as provided to your base Payload Config, or `'null'`, `'false'`, or `'none'` to disable falling back.
+valid locale as provided to your base Payload config, or `'null'`, `'false'`, or `'none'` to disable falling back.
 
 **Example:**
 
@@ -204,9 +234,10 @@ const posts = await payload.find({
 })
 ```
 
-<Banner type="success">
+<Banner type="alert">
   <strong>Tip:</strong>
-  The REST and Local APIs can return all Localization data in one request by passing 'all' or '*' as
+  <br />
+  The REST and Local APIs can return all localization data in one request by passing 'all' or '*' as
   the <strong>locale</strong> parameter. The response will be structured so that field values come
   back as the full objects keyed for each locale instead of the single, translated value.
 </Banner>

docs/configuration/overview.mdx

@@ -2,188 +2,155 @@
 title: The Payload Config
 label: Overview
 order: 10
-desc: The Payload Config is central to everything that Payload does, from adding custom React components, to modifying collections, controlling localization and much more.
+desc: The Payload config is central to everything that Payload does, from adding custom React components, to modifying collections, controlling localization and much more.
 keywords: overview, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
 ---
 
-Payload is a _config-based_, code-first CMS and application framework. The Payload Config is central to everything that Payload does, allowing for deep configuration of your application through a simple and intuitive API. The Payload Config is a fully-typed JavaScript object that can be infinitely extended upon.
+Payload is a _config-based_, code-first CMS and application framework. The Payload config is central to everything that Payload does. It scaffolds the data that Payload stores as well as maintains custom React components, hook logic, custom validations, and much more.
 
-Everything from your [Database](../database/overview) choice, to the appearance of the [Admin Panel](../admin/overview), is fully controlled through the Payload Config. From here you can define [Fields](../fields/overview), add [Localization](./localization), enable [Authentication](../authentication/overview), configure [Access Control](../access-control/overview), and so much more.
+**Also, because the Payload source code is fully written in TypeScript, its configs are strongly typed—meaning that even if you aren't using TypeScript, your IDE (such as VSCode) may still provide helpful information like type-ahead suggestions while you write your config.**
 
-The Payload Config is a `payload.config.ts` file typically located in the root of your project:
+## Options
 
-```ts
-import { buildConfig } from 'payload'
+| Option                 | Description                                                                                                                                                                        |
+| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `admin`                | Base Payload admin configuration. Specify custom components, control metadata, set the Admin user collection, and [more](/docs/admin/overview#admin-options). |
+| `bin`                  | Register custom bin scripts with the `payload` bin function. |
+| `editor`               | Rich Text Editor which will be used by richText fields. |
+| `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) |
+| `defaultMaxTextLength` | The maximum allowed string length to be permitted application-wide. Helps to prevent malicious public document creation. |
+| `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`                | Cofigure the email adapter for Payload to use. |
+| `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) |
+| `i18n`                 | Internationalization configuration. Pass all i18n languages you'd like the admin UI to support. Defaults to English-only. [More](/docs/beta/configuration/i18n) |
+| `secret` \*            | A secure, unguessable string that Payload will use for any encryption workflows - for example, password salt / hashing. Required. |
+| `sharp`                | If you would like Payload to offer cropping, focal point selection, and automatic media resizing, install and pass the Sharp module to the config here. |
+| `typescript`           | Configure TypeScript settings here. [More](#typescript) |
 
-export default buildConfig({
-  // Your config goes here
-})
-```
 
-The Payload Config is strongly typed and ties directly into Payload's TypeScript codebase. This means your IDE (such as VSCode) will provide helpful information like type-ahead suggestions while you write your config.
+_\* An asterisk denotes that a property is required._
 
-<Banner type="success">
-  <strong>Tip:</strong>
-  The location of your Payload Config can be customized. [More details](#customizing--automating-config-location-detection).
-</Banner>
-
-## Config Options
-
-To author your Payload Config, first determine which [Database](../database/overview) you'd like to use, then use [Collections](./collections) or [Globals](./globals) to define the schema of your data.
-
-Here is one of the simplest possible Payload configs:
+### Simple example
 
 ```ts
 import { buildConfig } from 'payload'
 import { mongooseAdapter } from '@payloadcms/db-mongodb'
+import { postgresAdapter } from '@payloadcms/db-postgres'
+
+import { lexicalEditor } from '@payloadcms/richtext-lexical'
 
 export default buildConfig({
-  secret: process.env.PAYLOAD_SECRET,
+  secret: process.env.PAYLOAD_SECRET || '',
   db: mongooseAdapter({
     url: process.env.DATABASE_URI,
-  }),
+  }), // or postgresAdapter({}),
+  editor: lexicalEditor({}),
   collections: [
     {
       slug: 'pages',
       fields: [
         {
           name: 'title',
-          type: 'text'
-        }
-      ]
-    }
+          type: 'text',
+          required: true,
+        },
+        {
+          name: 'content',
+          type: 'richText',
+          required: true,
+        },
+      ],
+    },
+  ],
+  globals: [
+    {
+      slug: 'header',
+      fields: [
+        {
+          name: 'nav',
+          type: 'array',
+          fields: [
+            {
+              name: 'page',
+              type: 'relationship',
+              relationTo: 'pages',
+            },
+          ],
+        },
+      ],
+    },
   ],
 })
 ```
 
-<Banner type="success">
-  <strong>Note:</strong>
-  For a more complex example, see the [Public Demo](https://github.com/payloadcms/public-demo) source code on GitHub, or the [Templates](https://github.com/payloadcms/payload/tree/main/templates) and [Examples](https://github.com/payloadcms/payload/tree/main/examples) directories in the Payload repository.
-</Banner>
+### Full example config
 
-The following options are available:
+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.
 
-| Option                     | Description                                                                                                                                                                                    |
-|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| **`admin`**                | The configuration options for the Admin Panel, including Custom Components, Live Preview, etc. [More details](../admin/overview#admin-options).                                                |
-| **`bin`**                  | Register custom bin scripts for Payload to execute.                                                                                                                                            |
-| **`editor`**               | The Rich Text Editor which will be used by `richText` fields. [More details](../rich-text/overview).                                                                                           |
-| **`db`** \*                | The Database Adapter which will be used by Payload. [More details](../database/overview).                                                                                                      |
-| **`serverURL`**            | A string used to define the absolute URL of your app. This includes the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port.            |
-| **`collections`**          | An array of Collections for Payload to manage. [More details](./collections).                                                                                                                  |
-| **`compatibility`**        | Compatibility flags for earlier versions of Payload. [More details](#compatibility-flags).                                                                                                     |
-| **`globals`**              | An array of Globals for Payload to manage. [More details](./globals).                                                                                                                          |
-| **`cors`**                 | Cross-origin resource sharing (CORS) is a mechanism that accept incoming requests from given domains. You can also customize the `Access-Control-Allow-Headers` header. [More details](#cors). |
-| **`localization`**         | Opt-in to translate your content into multiple locales. [More details](./localization).                                                                                                        |
-| **`logger`**               | Logger options, logger options with a destination stream, or an instantiated logger instance. [More details](https://getpino.io/#/docs/api?id=options).                                        |
-| **`graphQL`**              | Manage GraphQL-specific functionality, including custom queries and mutations, query complexity limits, etc. [More details](../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 to accept cookies from. [More details](../authentication/overview#csrf-protection).                                                                 |
-| **`defaultDepth`**         | If a user does not specify `depth` while requesting a resource, this depth will be used. [More details](../queries/depth).                                                                     |
-| **`defaultMaxTextLength`** | The maximum allowed string length to be permitted application-wide. Helps to prevent malicious public document creation.                                                                       |
-| **`maxDepth`**             | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`. [More details](../queries/depth).                          |
-| **`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 details](../upload/overview#payload-wide-upload-options).                                                                                             |
-| **`routes`**               | Control the routing structure that Payload binds itself to. [More details](../admin/overview#root-level-routes).                                                                               |
-| **`email`**                | Configure the Email Adapter for Payload to use. [More details](../email/overview).                                                                                                             |
-| **`debug`**                | Enable to expose more detailed error information.                                                                                                                                              |
-| **`telemetry`**            | Disable Payload telemetry by passing `false`. [More details](#telemetry).                                                                                                                      |
-| **`rateLimit`**            | Control IP-based rate limiting for all Payload resources. Used to prevent DDoS attacks, etc. [More details](../production/preventing-abuse#rate-limiting-requests).                            |
-| **`hooks`**                | An array of Root Hooks. [More details](../hooks/overview).                                                                                                                                     |
-| **`plugins`**              | An array of Plugins. [More details](../plugins/overview).                                                                                                                                      |
-| **`endpoints`**            | An array of Custom Endpoints added to the Payload router. [More details](../rest-api/overview#custom-endpoints).                                                                               |
-| **`custom`**               | Extension point for adding custom data (e.g. for plugins).                                                                                                                                     |
-| **`i18n`**                 | Internationalization configuration. Pass all i18n languages you'd like the admin UI to support. Defaults to English-only. [More details](./i18n).                                              |
-| **`secret`** \*            | A secure, unguessable string that Payload will use for any encryption workflows - for example, password salt / hashing.                                                                        |
-| **`sharp`**                | If you would like Payload to offer cropping, focal point selection, and automatic media resizing, install and pass the Sharp module to the config here.                                        |
-| **`typescript`**           | Configure TypeScript settings here. [More details](#typescript).                                                                                                                               |
+## Using environment variables in your config
 
-_\* An asterisk denotes that a property is required._
+By default, Next.js will load `.env` files based on your `NODE_ENV`. If you are using Payload outside of Next.js, we suggest using the `dotenv` package to handle environment variables from `.env` files. 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 `payload.config.ts` file), and ensure that it can find an `.env` file that you create.
 
-<Banner type="warning">
-  <strong>Note:</strong>
-  Some properties are removed from the client-side bundle. [More details](../admin/components#accessing-the-payload-config).
-</Banner>
-
-
-### Typescript Config
-
-Payload exposes a variety of TypeScript settings that you can leverage. These settings are used to auto-generate TypeScript interfaces for your [Collections](../configuration/collections) and [Globals](../configuration/globals), and to ensure that Payload uses your [Generated Types](../typescript/overview) for all [Local API](../local-api/overview) methods.
-
-To customize the TypeScript settings, use the `typescript` property in your Payload Config:
+**If necessary, you can add this code to the top of your Payload config:**
 
 ```ts
-import { buildConfig } from 'payload'
+import dotenv from 'dotenv'
+dotenv.config()
 
-export default buildConfig({
-  // ...
-  typescript: { // highlight-line
-    // ...
-  }
-})
+// ...
+// the rest of your `payload.config.ts` file goes here
 ```
 
-The following options are available:
+**Here is an example project structure w/ `dotenv` and an `.env` file:**
 
-| Option          | Description                                                                                                                                                                                                 |
-| --------------- | --------------------- |
-| **`autoGenerate`** | By default, Payload will auto-generate TypeScript interfaces for all collections and globals that your config defines. Opt out by setting `typescript.autoGenerate: false`. [More details](../typescript/overview). |
-| **`declare`**     | By default, Payload adds a `declare` block to your generated types, which makes sure that Payload uses your generated types for all Local API methods. Opt out by setting `typescript.declare: false`. |
-| **`outputFile`**  | Control the output path and filename of Payload's auto-generated types by defining the `typescript.outputFile` property to a full, absolute path. |
-
-## Config Location
-
-For Payload command-line scripts, we need to be able to locate your Payload Config. We'll check a variety of locations for the presence of `payload.config.ts` by default, including:
-
-1. The root current working directory
-1. The `compilerOptions` in your `tsconfig`*
-1. The `dist` directory*
-
-_\* Config location detection is different between development and production environments. See below for more details._
+```
+project-name
+---- .env
+---- package.json
+---- payload.config.ts
+```
 
 <Banner type="warning">
   <strong>Important:</strong>
-  Ensure your `tsconfig.json` is properly configured for Payload to auto-detect your config location. If if does not exist, or does not specify the proper `compilerOptions`, Payload will default to the current working directory.
+  <br />
+  If you use an environment variable to configure any properties that are required for the Admin
+  panel to function (ex. serverURL or any routes), you need to make sure that your Admin panel code
+  can access it. [Click here](/docs/admin/environment-vars) for more info.
 </Banner>
 
-**Development Mode**
+## Customizing & Automating Config Location Detection
 
-In development mode, if the configuration file is not found at the root, Payload will attempt to read your `tsconfig.json`, and attempt to find the config file specified in the `rootDir`:
+For Payload command-line scripts, we need to be able to locate your Payload config. We'll check a variety of locations for the presence of `payload.config.ts` by default, including the root current working directory, your `tsconfig`'s `rootDir`, and your `tsconfig`'s `outDir`.
 
-```json
-{
-  // ...
-  // highlight-start
-  "compilerOptions": {
-    "rootDir": "src"
-  }
-  // highlight-end
-}
-```
+In development mode, if the configuration file is not found at the root, Payload will attempt to read your `tsconfig.json`, and search in the directory specified in `compilerOptions.rootDir` (typically "src").
 
-**Production Mode**
+In production mode, Payload will first attempt to find the config file in the output directory specified in `compilerOptions.outDir` of your `tsconfig.json`, then fallback to the source directory (`compilerOptions.rootDir`), and finally will check the 'dist' directory.
 
-In production mode, Payload will first attempt to find the config file in the `outDir` of your `tsconfig.json`, and if not found, will fallback to the `rootDir` directory:
+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.
 
-```json
-{
-  // ...
-  // highlight-start
-  "compilerOptions": {
-    "outDir": "dist",
-    "rootDir": "src"
-  }
-  // highlight-end
-}
-```
+### Overriding the Config Location
 
-If none was in either location, Payload will finally check the `dist` directory.
+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.
 
-### Customizing the Config Location
-
-In addition to the above automated detection, you can specify your own location for the Payload Config. This can be useful in situations where your config is not in a standard location, or you wish to switch between multiple configurations. To do this, Payload exposes an [Environment Variable](..environment-variables) to bypass all automatic config detection.
-
-To use a custom config location, set the `PAYLOAD_CONFIG_PATH` environment variable:
+**Example in package.json:**
 
 ```json
 {
@@ -193,75 +160,71 @@ To use a custom config location, set the `PAYLOAD_CONFIG_PATH` environment varia
 }
 ```
 
-<Banner type="info">
-  <strong>Tip:</strong>
-  `PAYLOAD_CONFIG_PATH` can be either an absolute path, or path relative to your current working directory.
-</Banner>
-
-## 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.
-
-For more information about what we track, take a look at our [privacy policy](/privacy).
-
-## Cross-origin resource sharing (CORS)
-
-Cross-origin resource sharing (CORS) can be configured with either a whitelist array of URLS to allow CORS requests from, a wildcard string (`*`) to accept incoming requests from any domain, or a object with the following properties:
-
-| Option    | Description                                                                                                                                                                        |
-| --------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| **`origins`** | Either a whitelist array of URLS to allow CORS requests from, or a wildcard string (`'*'`) to accept incoming requests from any domain. |
-| **`headers`**  | A list of allowed headers that will be appended in `Access-Control-Allow-Headers`. |
-
-Here's an example showing how to allow incoming requests from any domain:
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  cors: '*' // highlight-line
-})
-```
-
-Here's an example showing how to append a new header (`x-custom-header`) in `Access-Control-Allow-Headers`:
-
-```ts
-import { buildConfig } from 'payload'
-
-export default buildConfig({
-  // ...
-  // highlight-start
-  cors: {
-    origins: ['http://localhost:3000']
-    headers: ['x-custom-header']
-  }
-  // highlight-end
-})
-```
+When `PAYLOAD_CONFIG_PATH` is set, Payload will use this path to load the configuration, bypassing all automated detection.
 
 ## TypeScript
 
-You can import types from Payload to help make writing your config easier and type-safe. There are two main types that represent the Payload Config, `Config` and `SanitizedConfig`.
+Payload exposes a variety of TypeScript settings that you can leverage on your Config's `typescript` property.
 
-The `Config` type represents a raw Payload Config in its full form. Only the bare minimum properties are marked as required. The `SanitizedConfig` type represents a Payload Config after it has been fully sanitized. Generally, this is only used internally by Payload.
+**`autoGenerate`**
+
+By default, in Next.js development mode, Payload will auto-generate TypeScript interfaces for all collections and globals that your config defines. 
+
+You can opt out by setting `typescript.autoGenerate: false`.
+
+**`declare`**
+
+By default, Payload adds a `declare` block to your generated types, which makes sure that Payload uses your generated types for all Local API methods. This promotes strong typing across all of Payload's APIs. However, if you are using your Payload config in a monorepo sub-package, and you are using it in multiple applications, you might want to disable this automatic declaration and then manually add the `declare` block to a file that you control.
+
+In these cases, you can set `typescript.declare: false` to opt out.
+
+**`outputFile`**
+
+You can control the output path and filename of Payload's auto-generated types by defining the `typescript.outputFile` property to a full, absolute path.
+
+### Importing Payload config types
+
+You can import config types as follows:
 
 ```ts
-import type { Config, SanitizedConfig } from 'payload'
+import { Config } from 'payload'
+
+// This is the type used for an incoming Payload config.
+// Only the bare minimum properties are marked as required.
 ```
 
-## Server vs. Client
+```ts
+import { SanitizedConfig } from 'payload'
 
-The Payload Config only lives on the server and is not allowed to contain any client-side code. That way, you can load up the Payload Config in any server environment or standalone script, without having to use Bundlers or Node.js loaders to handle importing client-only modules (e.g. scss files or React Components) without any errors.
+// This is the type used after an incoming Payload config is fully sanitized.
+// Generally, this is only used internally by Payload.
+```
 
-Behind the curtains, the Next.js-based Admin Panel generates a ClientConfig, which strips away any server-only code and enriches the config with React Components.
+### Server config vs. client config
 
-## Compatibility flags
+Payload's full config is only available on the server, but Payload dynamically reduces your config down to only what is safe to send to the client-side admin panel. All server-only properties are removed as well as all functions (hooks, validations, conditional logic, access control, etc). 
 
-The Payload Config can accept compatibility flags for running the newest versions but with older databases. You should only use these flags if you need to, and should confirm that you need to prior to enabling these flags.
+Anywhere within the client-side admin UI, you can access your client-safe config which is typed as `ClientConfig`. The client config is JSON-serializable.
 
-`allowLocalizedWithinLocalized`
+Here's an example showing how to access your config on the client-side:
 
-Payload localization works on a field-by-field basis. As you can nest fields within other fields, you could potentially nest a localized field within a localized field—but this would be redundant and unnecessary. There would be no reason to define a localized field within a localized parent field, given that the entire data structure from the parent field onward would be localized.
+```ts
+'use client'
+import React from 'react'
+import { useConfig } from '@payloadcms/ui'
 
-By default, Payload will remove the `localized: true` property from sub-fields if a parent field is localized. Set this compatibility flag to `true` only if you have an existing Payload MongoDB database from pre-3.0, and you have nested localized fields that you would like to maintain without migrating.
+const MyClientComponent: React.FC = () => {
+  // Get access to your config
+  const config = useConfig()
+
+  return (
+    // ..
+  )
+}
+```
+
+## 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.
+
+For more information about what we track, take a look at our [privacy policy](/privacy).