docs: improve docs about beforeSync in searchPlugin

payloadcms · Oct 30, 2024 · 3f5f528 · 3f5f528
1 parent 8970c6b
commit 3f5f528
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/docs/plugins/search.mdx b/docs/plugins/search.mdx
@@ -143,7 +143,8 @@ Before creating or updating a search record, the `beforeSync` function runs. Thi
   searchPlugin({
     beforeSync: ({ originalDoc, searchDoc }) => ({
       ...searchDoc,
-      // Modify your docs in any way here, this can be async
+      // - Modify your docs in any way here, this can be async
+      // - You also need to add the `excerpt` field in the `searchOverrides` config
       excerpt: originalDoc?.excerpt || 'This is a fallback excerpt',
     }),
   }),