From 5816f2d40b4f1f03374a923047aff019dadc718e Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Jun 2026 16:12:14 +0000 Subject: [PATCH 1/2] docs: clarify API keys, domain management, recordings, and version history --- .../comments/customize-behavior.mdx | 4 ++++ docs.json | 8 ++++++++ get-started/quickstart.mdx | 16 +++++++++++++++- realtime-collaboration/crdt/overview.mdx | 18 ++++++++++++++++++ 4 files changed, 45 insertions(+), 1 deletion(-) diff --git a/async-collaboration/comments/customize-behavior.mdx b/async-collaboration/comments/customize-behavior.mdx index 6d7b13b5e..e419def09 100644 --- a/async-collaboration/comments/customize-behavior.mdx +++ b/async-collaboration/comments/customize-behavior.mdx @@ -5005,6 +5005,10 @@ Set the Recorder media options within Comments: (`audio`, `screen`, `video`, `al Default: `"audio"` + +**Disabling video recording in comments:** pass any combination that omits `video` (for example `"audio"`, `"screen"`, or `"audio,screen"`). To turn the Recorder off entirely in comments, use `"none"`. + + ```jsx diff --git a/docs.json b/docs.json index 3d6a1673d..a95c502ea 100644 --- a/docs.json +++ b/docs.json @@ -1548,6 +1548,14 @@ { "source": "/users/server-side/api-reset-contact-list", "destination": "/api-reference/rest-apis/v2/users/delete-users" + }, + { + "source": "/collaboration/version-history", + "destination": "/realtime-collaboration/crdt/overview" + }, + { + "source": "/realtime-collaboration/crdt/version-history", + "destination": "/realtime-collaboration/crdt/overview" } ], "logo": { diff --git a/get-started/quickstart.mdx b/get-started/quickstart.mdx index e0bc2d6d2..f6b802b96 100644 --- a/get-started/quickstart.mdx +++ b/get-started/quickstart.mdx @@ -65,7 +65,11 @@ Use our CDN Script ![](/images/velt-console-api-key.png) - + + +Velt uses a single API key on the client (frontend). There is no separate public/private key pair — the API key is paired with your allowed domains list to restrict where it can be used. For backend / server-to-server calls to Velt's REST APIs, you generate a separate [Auth Token](/security/auth-tokens) in the Velt Console and pass it alongside the API key as the `x-velt-auth-token` header. Keep auth tokens server-side only. + + ### Step 3: Safelist Your Domain In the Velt Console, add your app's domain to "Managed Domains" to whitelist it for development and production use. @@ -74,6 +78,16 @@ In the Velt Console, add your app's domain to "Managed Domains" to whitelist it ![](/images/velt-console-add-website.png) + +Managing many environments? You can also add, list, and remove allowed domains programmatically via the REST APIs: + +- [Add Domains](/api-reference/rest-apis/v2/workspace/add-domain) — `POST /v2/workspace/domains/add` (supports wildcard subdomains, e.g. `*.example.com`) +- [Get Domains](/api-reference/rest-apis/v2/workspace/domains-get) +- [Delete Domains](/api-reference/rest-apis/v2/workspace/delete-domain) + +Both endpoints require your API key and an [Auth Token](/security/auth-tokens) and are designed for automating environment provisioning. + + ### Step 4: Initialize Velt Initialize the SDK and render the base collaborative components. Pick your framework and: diff --git a/realtime-collaboration/crdt/overview.mdx b/realtime-collaboration/crdt/overview.mdx index 5933e26b6..85aaa5504 100644 --- a/realtime-collaboration/crdt/overview.mdx +++ b/realtime-collaboration/crdt/overview.mdx @@ -42,6 +42,24 @@ CRDT (Yjs) based collaborative editing. This feature is useful for building coll - **Version history**: Create checkpoints and restore prior states when needed. - **Framework agnostic**: Use anywhere; React hook available for faster integration. +## Version history + +Every Velt CRDT store supports saving named snapshots and restoring the document to any previous version. This works for plain stores (array, map, text, xml) and for the editor integrations built on top of them (Tiptap, BlockNote, CodeMirror, ReactFlow). + +Core methods exposed on the store (or via `useStore` in React): + +- `saveVersion(name)` — save a named snapshot of the current state. +- `getVersions()` — list all saved versions. +- `getVersionById(id)` — fetch a specific version. +- `restoreVersion(id)` — restore the document to a saved version. +- `setStateFromVersion(version)` — apply a version's state locally. + +See full usage and examples in: + +- [Core library](./setup/core#version-methods) — generic version APIs for any store type +- [Text store](./setup/core-stores/text) and [XML store](./setup/core-stores/xml) — version save/restore for text-based documents +- [Tiptap](./setup/tiptap), [BlockNote](./setup/blocknote), [CodeMirror](./setup/codemirror), [ReactFlow](./setup/reactflow) — editor-specific version history + ## How it works - You initialize the Velt client in your app. - You create a CRDT store (core or via the React hook) with a unique `id` and a data `type`. From 2bcc912b152eca950c30b92e9ef214d96835ba2a Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Jun 2026 16:14:40 +0000 Subject: [PATCH 2/2] docs: improve SEO descriptions and tighten quickstart copy --- async-collaboration/comments/customize-behavior.mdx | 1 + get-started/quickstart.mdx | 4 ++-- realtime-collaboration/crdt/overview.mdx | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/async-collaboration/comments/customize-behavior.mdx b/async-collaboration/comments/customize-behavior.mdx index e419def09..354582cb7 100644 --- a/async-collaboration/comments/customize-behavior.mdx +++ b/async-collaboration/comments/customize-behavior.mdx @@ -1,5 +1,6 @@ --- title: "Customize Behavior" +description: "Configure Velt Comments behavior: threads, mentions, attachments, recordings, visibility, autocomplete, and other runtime options for the comment composer." --- # Threads diff --git a/get-started/quickstart.mdx b/get-started/quickstart.mdx index f6b802b96..9cfe6a21f 100644 --- a/get-started/quickstart.mdx +++ b/get-started/quickstart.mdx @@ -1,6 +1,6 @@ --- title: "Quickstart" -description: "Install and set up Velt in minutes in React, Angular, Vue, or HTML." +description: "Install the Velt SDK, configure your API key and allowed domains, and add collaborative comments and presence in React, Angular, Vue, or HTML." --- Get Velt up and running in your app with comments, presence, and real-time collaboration features. You'll install the package, configure authentication, set up documents, and see collaborative features working immediately. @@ -67,7 +67,7 @@ Use our CDN Script -Velt uses a single API key on the client (frontend). There is no separate public/private key pair — the API key is paired with your allowed domains list to restrict where it can be used. For backend / server-to-server calls to Velt's REST APIs, you generate a separate [Auth Token](/security/auth-tokens) in the Velt Console and pass it alongside the API key as the `x-velt-auth-token` header. Keep auth tokens server-side only. +Velt uses a single API key on the client (frontend). There is no separate public/private key pair — the API key is paired with your allowed domains list to restrict where it can be used. For backend calls to Velt's REST APIs, generate a separate [Auth Token](/security/auth-tokens) in the Velt Console and pass it as the `x-velt-auth-token` header alongside the API key. Keep auth tokens server-side only. ### Step 3: Safelist Your Domain diff --git a/realtime-collaboration/crdt/overview.mdx b/realtime-collaboration/crdt/overview.mdx index 85aaa5504..e22b3c492 100644 --- a/realtime-collaboration/crdt/overview.mdx +++ b/realtime-collaboration/crdt/overview.mdx @@ -1,6 +1,6 @@ --- title: Overview -description: CRDT (Yjs) based collaborative editing. +description: Build collaborative editors, whiteboards, and shared app state with Velt's Yjs-based CRDT stores, version history, and editor integrations. --- CRDT (Yjs) based collaborative editing. This feature is useful for building collaborative features like shared forms, whiteboards, or any real-time state that needs to be synced across all users.