From 13aea74e9f0d55136bd1ee210e4a1aaafdae30da Mon Sep 17 00:00:00 2001 From: "devin-ai-integration[bot]" <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Thu, 16 Jul 2026 16:23:56 +0100 Subject: [PATCH 1/2] docs: link matching example above quickstart in get-started guides (#3585) Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Chris Nicholas --- docs/pages/get-started/nextjs-ai-chat.mdx | 6 ++++++ docs/pages/get-started/nextjs-ai-react-flow.mdx | 6 ++++++ docs/pages/get-started/nextjs-blocknote.mdx | 6 ++++++ docs/pages/get-started/nextjs-chat-sdk-bot.mdx | 6 ++++++ docs/pages/get-started/nextjs-comments-ai.mdx | 6 ++++++ docs/pages/get-started/nextjs-comments-canvas.mdx | 6 ++++++ docs/pages/get-started/nextjs-comments-handsontable.mdx | 6 ++++++ docs/pages/get-started/nextjs-comments.mdx | 6 ++++++ docs/pages/get-started/nextjs-lexical.mdx | 6 ++++++ docs/pages/get-started/nextjs-multiplayer-handsontable.mdx | 6 ++++++ .../pages/get-started/nextjs-notifications-custom-email.mdx | 2 +- .../nextjs-notifications-custom-microsoft-teams.mdx | 2 +- .../pages/get-started/nextjs-notifications-custom-slack.mdx | 2 +- .../get-started/nextjs-notifications-custom-web-push.mdx | 2 +- .../get-started/nextjs-notifications-custom-webhooks.mdx | 2 +- docs/pages/get-started/nextjs-notifications-email.mdx | 2 +- .../get-started/nextjs-notifications-microsoft-teams.mdx | 2 +- docs/pages/get-started/nextjs-notifications-slack.mdx | 2 +- docs/pages/get-started/nextjs-notifications-web-push.mdx | 2 +- docs/pages/get-started/nextjs-notifications-webhooks.mdx | 2 +- docs/pages/get-started/nextjs-react-flow.mdx | 6 ++++++ docs/pages/get-started/nextjs-tiptap.mdx | 6 ++++++ docs/pages/get-started/react-comments.mdx | 6 ++++++ docs/pages/get-started/yjs-superdoc-nextjs.mdx | 6 ++++++ 24 files changed, 94 insertions(+), 10 deletions(-) diff --git a/docs/pages/get-started/nextjs-ai-chat.mdx b/docs/pages/get-started/nextjs-ai-chat.mdx index 4110d0752b1..0300d50f929 100644 --- a/docs/pages/get-started/nextjs-ai-chat.mdx +++ b/docs/pages/get-started/nextjs-ai-chat.mdx @@ -13,6 +13,12 @@ from [`@liveblocks/react`](/docs/api-reference/liveblocks-react) and the components from [`@liveblocks/react-ui`](/docs/api-reference/liveblocks-react-ui). + + +See the finished result in the [AI Chats](/examples/ai-chats/nextjs-ai-chats) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-ai-react-flow.mdx b/docs/pages/get-started/nextjs-ai-react-flow.mdx index a49fdf1a03b..98254db0359 100644 --- a/docs/pages/get-started/nextjs-ai-react-flow.mdx +++ b/docs/pages/get-started/nextjs-ai-react-flow.mdx @@ -15,6 +15,12 @@ from your Next.js `/app` directory application using [`@liveblocks/react-flow`](/docs/api-reference/liveblocks-react-flow), the [Vercel AI SDK](https://ai-sdk.dev), and [OpenAI](https://platform.openai.com). + + +See the finished result in the [Collaborative Flowchart AI](/examples/collaborative-flowchart-ai/nextjs-react-flow-ai) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-blocknote.mdx b/docs/pages/get-started/nextjs-blocknote.mdx index 3b6e3944ce9..102bcbd068d 100644 --- a/docs/pages/get-started/nextjs-blocknote.mdx +++ b/docs/pages/get-started/nextjs-blocknote.mdx @@ -13,6 +13,12 @@ collaboration to your Next.js application using the APIs from the [`@liveblocks/react-blocknote`](/docs/api-reference/liveblocks-react-blocknote) package. + + +See the finished result in the [Collaborative Text Editor](/examples/collaborative-text-editor/nextjs-blocknote) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-chat-sdk-bot.mdx b/docs/pages/get-started/nextjs-chat-sdk-bot.mdx index b5cd9a4c337..709315b5046 100644 --- a/docs/pages/get-started/nextjs-chat-sdk-bot.mdx +++ b/docs/pages/get-started/nextjs-chat-sdk-bot.mdx @@ -13,6 +13,12 @@ that reads and responds to Liveblocks comment threads using the [`@liveblocks/chat-sdk-adapter`](/docs/api-reference/liveblocks-chat-sdk-adapter) in your Next.js `/app` directory application. + + +See the finished result in the [Chat SDK Bot](/examples/chat-sdk-bot/nextjs-chat-sdk-bot) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-comments-ai.mdx b/docs/pages/get-started/nextjs-comments-ai.mdx index acdff9b8fed..14eae9ebb00 100644 --- a/docs/pages/get-started/nextjs-comments-ai.mdx +++ b/docs/pages/get-started/nextjs-comments-ai.mdx @@ -14,6 +14,12 @@ thread, using [`@liveblocks/node`](/docs/api-reference/liveblocks-node), the [Vercel AI SDK](https://ai-sdk.dev), and [Anthropic](https://anthropic.com), in your Next.js `/app` directory application. + + +See the finished result in the [AI Comments](/examples/ai-comments/nextjs-comments-ai) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-comments-canvas.mdx b/docs/pages/get-started/nextjs-comments-canvas.mdx index b1d5eb9aa98..93d8fdc2d19 100644 --- a/docs/pages/get-started/nextjs-comments-canvas.mdx +++ b/docs/pages/get-started/nextjs-comments-canvas.mdx @@ -13,6 +13,12 @@ hooks from [`@liveblocks/react`](/docs/api-reference/liveblocks-react) and the components from [`@liveblocks/react-ui`](/docs/api-reference/liveblocks-react-ui). + + +See the finished result in the [Canvas Comments](/examples/canvas-comments/nextjs-comments-canvas) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-comments-handsontable.mdx b/docs/pages/get-started/nextjs-comments-handsontable.mdx index e18e8bccdf3..be6b68c1ec4 100644 --- a/docs/pages/get-started/nextjs-comments-handsontable.mdx +++ b/docs/pages/get-started/nextjs-comments-handsontable.mdx @@ -13,6 +13,12 @@ hooks from [`@liveblocks/react`](/docs/api-reference/liveblocks-react) and the components from [`@liveblocks/react-ui`](/docs/api-reference/liveblocks-react-ui). + + +See the finished result in the [Handsontable Comments](/examples/handsontable-comments/nextjs-comments-handsontable) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-comments.mdx b/docs/pages/get-started/nextjs-comments.mdx index 67c13fc2886..415a8edfe5f 100644 --- a/docs/pages/get-started/nextjs-comments.mdx +++ b/docs/pages/get-started/nextjs-comments.mdx @@ -13,6 +13,12 @@ hooks from [`@liveblocks/react`](/docs/api-reference/liveblocks-react) and the components from [`@liveblocks/react-ui`](/docs/api-reference/liveblocks-react-ui). + + +See the finished result in the [Comments](/examples/comments/nextjs-comments) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-lexical.mdx b/docs/pages/get-started/nextjs-lexical.mdx index dce138ac1b3..084b891d104 100644 --- a/docs/pages/get-started/nextjs-lexical.mdx +++ b/docs/pages/get-started/nextjs-lexical.mdx @@ -13,6 +13,12 @@ collaboration to your Next.js application using the APIs from the [`@liveblocks/react-lexical`](/docs/api-reference/liveblocks-react-lexical) package. + + +See the finished result in the [Collaborative Text Editor](/examples/collaborative-text-editor/nextjs-lexical) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-multiplayer-handsontable.mdx b/docs/pages/get-started/nextjs-multiplayer-handsontable.mdx index 3eb577e8dc6..c4c083891f9 100644 --- a/docs/pages/get-started/nextjs-multiplayer-handsontable.mdx +++ b/docs/pages/get-started/nextjs-multiplayer-handsontable.mdx @@ -15,6 +15,12 @@ multiplayer to a Handsontable spreadsheet in your Next.js `/app` directory application using the hooks from [`@liveblocks/react`](/docs/api-reference/liveblocks-react). + + +See the finished result in the [Multiplayer Handsontable](/examples/multiplayer-handsontable/nextjs-multiplayer-handsontable) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-notifications-custom-email.mdx b/docs/pages/get-started/nextjs-notifications-custom-email.mdx index 8618ca04390..63f7b3068cb 100644 --- a/docs/pages/get-started/nextjs-notifications-custom-email.mdx +++ b/docs/pages/get-started/nextjs-notifications-custom-email.mdx @@ -132,7 +132,7 @@ Congratulations! You've set up Email notifications in your Next.js application. + +See the finished result in the [Collaborative Flowchart](/examples/collaborative-flowchart/nextjs-react-flow) example. + + + ## Quickstart diff --git a/docs/pages/get-started/nextjs-tiptap.mdx b/docs/pages/get-started/nextjs-tiptap.mdx index 140b2f629cb..d3a5bf3e740 100644 --- a/docs/pages/get-started/nextjs-tiptap.mdx +++ b/docs/pages/get-started/nextjs-tiptap.mdx @@ -12,6 +12,12 @@ collaboration to your Next.js application using the APIs from the [`@liveblocks/react-tiptap`](/docs/api-reference/liveblocks-react-tiptap) package. + + +See the finished result in the [Collaborative Text Editor](/examples/collaborative-text-editor/nextjs-tiptap) example. + + + ## Quickstart diff --git a/docs/pages/get-started/react-comments.mdx b/docs/pages/get-started/react-comments.mdx index feeb1069dee..484b4556c0d 100644 --- a/docs/pages/get-started/react-comments.mdx +++ b/docs/pages/get-started/react-comments.mdx @@ -13,6 +13,12 @@ commenting experience to your React application using the hooks from [`@liveblocks/react`](/docs/api-reference/liveblocks-react) and the components from [`@liveblocks/react-ui`](/docs/api-reference/liveblocks-react-ui). + + +See the finished result in the [Comments](/examples/comments/react-comments) example. + + + ## Quickstart diff --git a/docs/pages/get-started/yjs-superdoc-nextjs.mdx b/docs/pages/get-started/yjs-superdoc-nextjs.mdx index 31d9dc0b5d3..addc3e49f57 100644 --- a/docs/pages/get-started/yjs-superdoc-nextjs.mdx +++ b/docs/pages/get-started/yjs-superdoc-nextjs.mdx @@ -12,6 +12,12 @@ collaboration to your Next.js application using the APIs from the [`@liveblocks/yjs`](/docs/api-reference/liveblocks-yjs) package, and [SuperDoc](https://superdoc.dev), a collaborative DOCX editor for the web. + + +See the finished result in the [Collaborative DOCX Editor](/examples/collaborative-text-editor/nextjs-yjs-superdoc) example. + + + ## Quickstart From 7cd4fe6f7cd623eb8a4accbe7096b056af9ef442 Mon Sep 17 00:00:00 2001 From: "devin-ai-integration[bot]" <158243242+devin-ai-integration[bot]@users.noreply.github.com> Date: Thu, 16 Jul 2026 17:20:40 +0100 Subject: [PATCH 2/2] docs: add guides sections before API reference on collaboration-features pages (#3586) Co-authored-by: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com> Co-authored-by: Chris Nicholas --- .../ai-collaboration.mdx | 21 +++++++++++ .../collaboration-features/ai-copilots.mdx | 28 +++++++++++++++ .../pages/collaboration-features/comments.mdx | 35 +++++++++++++++++++ .../collaboration-features/multiplayer.mdx | 32 +++++++++++++++++ .../sync-engine/liveblocks-storage.mdx | 35 +++++++++++++++++++ .../sync-engine/liveblocks-yjs.mdx | 35 +++++++++++++++++++ .../multiplayer/text-editor/blocknote.mdx | 21 +++++++++++ .../multiplayer/text-editor/lexical.mdx | 28 +++++++++++++++ .../multiplayer/text-editor/tiptap.mdx | 35 +++++++++++++++++++ .../collaboration-features/notifications.mdx | 35 +++++++++++++++++++ 10 files changed, 305 insertions(+) diff --git a/docs/pages/collaboration-features/ai-collaboration.mdx b/docs/pages/collaboration-features/ai-collaboration.mdx index dccbdd573dc..158ef3b38e9 100644 --- a/docs/pages/collaboration-features/ai-collaboration.mdx +++ b/docs/pages/collaboration-features/ai-collaboration.mdx @@ -242,6 +242,27 @@ multiplayer state, and more. Learn more about Liveblocks n8n nodes +## AI Collaboration guides + + + + } + /> + } + /> + + ## API Reference diff --git a/docs/pages/collaboration-features/ai-copilots.mdx b/docs/pages/collaboration-features/ai-copilots.mdx index 835efb747e4..0dda057fe5f 100644 --- a/docs/pages/collaboration-features/ai-copilots.mdx +++ b/docs/pages/collaboration-features/ai-copilots.mdx @@ -78,6 +78,34 @@ can understand and modify your application state. /> +## AI Copilots guides + + + + } + /> + } + /> + } + /> + + ## AI Copilots API Reference diff --git a/docs/pages/collaboration-features/comments.mdx b/docs/pages/collaboration-features/comments.mdx index aa26153a21a..f729992b8c2 100644 --- a/docs/pages/collaboration-features/comments.mdx +++ b/docs/pages/collaboration-features/comments.mdx @@ -78,6 +78,41 @@ annotations, video annotations, and more. /> +## Comments guides + + + + } + /> + } + /> + } + /> + } + /> + + ## Comments API Reference diff --git a/docs/pages/collaboration-features/multiplayer.mdx b/docs/pages/collaboration-features/multiplayer.mdx index 6b367398d87..b66677d33ab 100644 --- a/docs/pages/collaboration-features/multiplayer.mdx +++ b/docs/pages/collaboration-features/multiplayer.mdx @@ -69,6 +69,38 @@ editors (like Tiptap, Lexical, or BlockNote), or more general packages like /> +## Multiplayer guides + + + + } + /> + + } + /> + + } + /> + + ## Multiplayer API Reference ### Text editor SDKs diff --git a/docs/pages/collaboration-features/multiplayer/sync-engine/liveblocks-storage.mdx b/docs/pages/collaboration-features/multiplayer/sync-engine/liveblocks-storage.mdx index 7aae128c5ca..28454670f40 100644 --- a/docs/pages/collaboration-features/multiplayer/sync-engine/liveblocks-storage.mdx +++ b/docs/pages/collaboration-features/multiplayer/sync-engine/liveblocks-storage.mdx @@ -360,6 +360,41 @@ await liveblocks.broadcastEvent("my-room-id", { type: "PLAY_VIDEO" }); The same operation can be performed using the [Broadcast event to a room REST API](/docs/api-reference/rest-api-endpoints#post-broadcast-event). +## Storage guides + + + + } + /> + } + /> + } + /> + } + /> + + ## API Reference ### Presence diff --git a/docs/pages/collaboration-features/multiplayer/sync-engine/liveblocks-yjs.mdx b/docs/pages/collaboration-features/multiplayer/sync-engine/liveblocks-yjs.mdx index 95010db968e..346ae305c0f 100644 --- a/docs/pages/collaboration-features/multiplayer/sync-engine/liveblocks-yjs.mdx +++ b/docs/pages/collaboration-features/multiplayer/sync-engine/liveblocks-yjs.mdx @@ -144,6 +144,41 @@ different editors. +## Yjs guides + + + + } + /> + } + /> + } + /> + } + /> + + ## API Reference diff --git a/docs/pages/collaboration-features/multiplayer/text-editor/blocknote.mdx b/docs/pages/collaboration-features/multiplayer/text-editor/blocknote.mdx index 065c1dddc30..62354fc3c05 100644 --- a/docs/pages/collaboration-features/multiplayer/text-editor/blocknote.mdx +++ b/docs/pages/collaboration-features/multiplayer/text-editor/blocknote.mdx @@ -311,6 +311,27 @@ restore different versions. Learn more in our [version history guide](/docs/guides/how-to-add-version-history-to-your-app). +## BlockNote guides + + + + } + /> + } + /> + + ## BlockNote API Reference diff --git a/docs/pages/collaboration-features/multiplayer/text-editor/lexical.mdx b/docs/pages/collaboration-features/multiplayer/text-editor/lexical.mdx index 4621550b756..244db4e0a57 100644 --- a/docs/pages/collaboration-features/multiplayer/text-editor/lexical.mdx +++ b/docs/pages/collaboration-features/multiplayer/text-editor/lexical.mdx @@ -368,6 +368,34 @@ restore different versions. Learn more in our [version history guide](/docs/guides/how-to-add-version-history-to-your-app). +## Lexical guides + + + + } + /> + } + /> + } + /> + + ## Lexical API Reference diff --git a/docs/pages/collaboration-features/multiplayer/text-editor/tiptap.mdx b/docs/pages/collaboration-features/multiplayer/text-editor/tiptap.mdx index 9efb2509af1..22eb54d6cda 100644 --- a/docs/pages/collaboration-features/multiplayer/text-editor/tiptap.mdx +++ b/docs/pages/collaboration-features/multiplayer/text-editor/tiptap.mdx @@ -406,6 +406,41 @@ restore different versions. Learn more in our [version history guide](/docs/guides/how-to-add-version-history-to-your-app). +## Tiptap guides + + + + } + /> + } + /> + } + /> + } + /> + + ## Tiptap API Reference diff --git a/docs/pages/collaboration-features/notifications.mdx b/docs/pages/collaboration-features/notifications.mdx index 6db97935104..3430a3d1e4e 100644 --- a/docs/pages/collaboration-features/notifications.mdx +++ b/docs/pages/collaboration-features/notifications.mdx @@ -59,6 +59,41 @@ also automatically trigger collaboration notifications where appropriate. /> +## Notifications guides + + + + } + /> + } + /> + } + /> + } + /> + + ## Notifications API Reference