From a3b7c5cd35ea642a4914ecb533980c4bde1d6106 Mon Sep 17 00:00:00 2001 From: "mintlify[bot]" <109931778+mintlify[bot]@users.noreply.github.com> Date: Mon, 29 Jun 2026 16:19:26 +0000 Subject: [PATCH] docs: apply SEO and metadata best practices across docs --- ai/agent-comments.mdx | 2 +- ai/approval-engine/customize-behavior.mdx | 4 ++-- ai/approval-engine/overview.mdx | 2 +- ai/approval-engine/setup.mdx | 4 ++-- ai/chat-sdk-adapter.mdx | 2 +- ai/memory/setup.mdx | 4 ++-- ai/rewriter/customize-behavior.mdx | 3 ++- ai/rewriter/overview.mdx | 2 +- ai/rewriter/setup.mdx | 3 ++- api-reference/rest-apis/v1/auth/generate-token.mdx | 3 ++- .../comment-annotations/add-comment-annotations.mdx | 3 ++- .../comment-annotations/delete-comment-annotations.mdx | 3 ++- .../comment-annotations/get-comment-annotations-count.mdx | 3 ++- .../comment-annotations/get-comment-annotations.mdx | 3 ++- .../comment-annotations/update-comment-annotations.mdx | 3 ++- .../rest-apis/v1/comments-feature/comments/add-comments.mdx | 3 ++- .../v1/comments-feature/comments/delete-comments.mdx | 3 ++- .../rest-apis/v1/comments-feature/comments/get-comments.mdx | 3 ++- .../v1/comments-feature/comments/update-comments.mdx | 3 ++- api-reference/rest-apis/v1/documents/add-documents.mdx | 3 ++- api-reference/rest-apis/v1/documents/delete-documents.mdx | 3 ++- api-reference/rest-apis/v1/documents/get-documents.mdx | 3 ++- api-reference/rest-apis/v1/documents/move-documents.mdx | 3 ++- .../rest-apis/v1/documents/update-document-access.mdx | 3 ++- .../rest-apis/v1/documents/update-document-disable-state.mdx | 3 ++- api-reference/rest-apis/v1/documents/update-documents.mdx | 3 ++- api-reference/rest-apis/v1/folders/add-folder.mdx | 3 ++- api-reference/rest-apis/v1/folders/get-folders.mdx | 3 ++- api-reference/rest-apis/v1/folders/update-folder-access.mdx | 3 ++- api-reference/rest-apis/v1/folders/update-folder.mdx | 3 ++- .../rest-apis/v1/gdpr/delete-all-user-data-gdpr.mdx | 4 ++-- api-reference/rest-apis/v1/gdpr/get-all-user-data-gdpr.mdx | 4 ++-- .../rest-apis/v1/gdpr/get-delete-user-data-status-gdpr.mdx | 4 ++-- api-reference/rest-apis/v1/livestate/broadcast-event.mdx | 3 ++- .../rest-apis/v1/locations/delete-data-by-location.mdx | 4 ++-- api-reference/rest-apis/v1/locations/update-location.mdx | 4 ++-- .../rest-apis/v1/notifications/add-notifications.mdx | 3 ++- .../rest-apis/v1/notifications/delete-notifications.mdx | 3 ++- api-reference/rest-apis/v1/notifications/get-config.mdx | 3 ++- .../rest-apis/v1/notifications/get-notifications.mdx | 3 ++- api-reference/rest-apis/v1/notifications/set-config.mdx | 3 ++- .../rest-apis/v1/notifications/update-notifications.mdx | 3 ++- .../rest-apis/v1/organizations/add-organizations.mdx | 3 ++- .../rest-apis/v1/organizations/delete-organizations.mdx | 3 ++- .../rest-apis/v1/organizations/get-organizations.mdx | 3 ++- .../v1/organizations/update-organization-disable-state.mdx | 3 ++- .../rest-apis/v1/organizations/update-organizations.mdx | 3 ++- api-reference/rest-apis/v1/user-groups/add-groups.mdx | 3 ++- .../rest-apis/v1/user-groups/add-users-to-group.mdx | 3 ++- .../rest-apis/v1/user-groups/delete-users-from-group.mdx | 3 ++- api-reference/rest-apis/v1/users/add-users.mdx | 3 ++- api-reference/rest-apis/v1/users/delete-users.mdx | 4 ++-- api-reference/rest-apis/v1/users/get-users.mdx | 3 ++- api-reference/rest-apis/v1/users/update-users.mdx | 3 ++- api-reference/rest-apis/v1/workspace/add-domain.mdx | 3 ++- api-reference/rest-apis/v1/workspace/delete-domain.mdx | 3 ++- api-reference/rest-apis/v2/activities/add-activities.mdx | 3 ++- api-reference/rest-apis/v2/activities/delete-activities.mdx | 3 ++- api-reference/rest-apis/v2/activities/get-activities.mdx | 3 ++- api-reference/rest-apis/v2/activities/update-activities.mdx | 3 ++- api-reference/rest-apis/v2/agents/list-agent-executions.mdx | 3 ++- .../v2/approval-engine/definitions/create-definition.mdx | 3 ++- .../v2/approval-engine/definitions/delete-definition.mdx | 3 ++- .../v2/approval-engine/definitions/get-definition.mdx | 3 ++- .../v2/approval-engine/definitions/list-definitions.mdx | 3 ++- .../v2/approval-engine/definitions/update-definition.mdx | 3 ++- .../v2/approval-engine/executions/cancel-execution.mdx | 3 ++- .../v2/approval-engine/executions/dispatch-execution.mdx | 3 ++- .../v2/approval-engine/executions/get-execution-events.mdx | 3 ++- .../v2/approval-engine/executions/get-execution.mdx | 3 ++- .../v2/approval-engine/executions/list-executions.mdx | 3 ++- .../rest-apis/v2/approval-engine/steps/cancel-step.mdx | 3 ++- .../v2/approval-engine/steps/record-agent-resolution.mdx | 3 ++- .../v2/approval-engine/steps/record-reviewer-decision.mdx | 3 ++- .../rest-apis/v2/approval-engine/steps/resolve-step.mdx | 3 ++- api-reference/rest-apis/v2/auth/add-permissions.mdx | 3 ++- api-reference/rest-apis/v2/auth/generate-signature.mdx | 3 ++- api-reference/rest-apis/v2/auth/generate-token.mdx | 3 ++- api-reference/rest-apis/v2/auth/get-permissions.mdx | 3 ++- api-reference/rest-apis/v2/auth/remove-permissions.mdx | 3 ++- .../comment-annotations/add-comment-annotations.mdx | 3 ++- .../comment-annotations/delete-comment-annotations.mdx | 3 ++- .../comment-annotations/get-comment-annotations-count.mdx | 3 ++- .../comment-annotations/get-comment-annotations-v2.mdx | 3 ++- .../comment-annotations/update-comment-annotations.mdx | 3 ++- .../rest-apis/v2/comments-feature/comments/add-comments.mdx | 3 ++- .../v2/comments-feature/comments/delete-comments.mdx | 3 ++- .../rest-apis/v2/comments-feature/comments/get-comments.mdx | 3 ++- .../v2/comments-feature/comments/update-comments.mdx | 3 ++- api-reference/rest-apis/v2/crdt/add-crdt-data.mdx | 3 ++- api-reference/rest-apis/v2/crdt/get-crdt-data.mdx | 3 ++- api-reference/rest-apis/v2/crdt/update-crdt-data.mdx | 3 ++- api-reference/rest-apis/v2/documents/add-documents.mdx | 3 ++- api-reference/rest-apis/v2/documents/delete-documents.mdx | 3 ++- api-reference/rest-apis/v2/documents/get-documents-v2.mdx | 3 ++- .../rest-apis/v2/documents/migrate-documents-status.mdx | 3 ++- api-reference/rest-apis/v2/documents/migrate-documents.mdx | 3 ++- api-reference/rest-apis/v2/documents/move-documents.mdx | 3 ++- .../rest-apis/v2/documents/update-document-access.mdx | 3 ++- .../rest-apis/v2/documents/update-document-disable-state.mdx | 3 ++- api-reference/rest-apis/v2/documents/update-documents.mdx | 3 ++- api-reference/rest-apis/v2/folders/add-folder.mdx | 3 ++- api-reference/rest-apis/v2/folders/delete-folder.mdx | 3 ++- api-reference/rest-apis/v2/folders/get-folders.mdx | 3 ++- api-reference/rest-apis/v2/folders/update-folder-access.mdx | 3 ++- api-reference/rest-apis/v2/folders/update-folder.mdx | 3 ++- .../rest-apis/v2/gdpr/delete-all-user-data-gdpr.mdx | 4 ++-- api-reference/rest-apis/v2/gdpr/get-all-user-data-gdpr.mdx | 4 ++-- .../rest-apis/v2/gdpr/get-delete-user-data-status-gdpr.mdx | 4 ++-- api-reference/rest-apis/v2/livestate/broadcast-event.mdx | 3 ++- api-reference/rest-apis/v2/memory/alerts/action.mdx | 3 ++- api-reference/rest-apis/v2/memory/alerts/config/get.mdx | 3 ++- api-reference/rest-apis/v2/memory/alerts/config/update.mdx | 3 ++- api-reference/rest-apis/v2/memory/alerts/dismiss.mdx | 3 ++- api-reference/rest-apis/v2/memory/alerts/list.mdx | 3 ++- api-reference/rest-apis/v2/memory/ask.mdx | 3 ++- api-reference/rest-apis/v2/memory/judgments/query.mdx | 3 ++- api-reference/rest-apis/v2/memory/knowledge/delete.mdx | 3 ++- api-reference/rest-apis/v2/memory/knowledge/download.mdx | 3 ++- .../rest-apis/v2/memory/knowledge/ingest-status.mdx | 3 ++- api-reference/rest-apis/v2/memory/knowledge/ingest.mdx | 3 ++- api-reference/rest-apis/v2/memory/knowledge/list.mdx | 1 + api-reference/rest-apis/v2/memory/knowledge/rules.mdx | 1 + api-reference/rest-apis/v2/memory/knowledge/search.mdx | 1 + api-reference/rest-apis/v2/memory/knowledge/update.mdx | 3 ++- api-reference/rest-apis/v2/memory/knowledge/upload-url.mdx | 3 ++- api-reference/rest-apis/v2/memory/patterns/get.mdx | 3 ++- api-reference/rest-apis/v2/memory/profiles/get.mdx | 1 + api-reference/rest-apis/v2/memory/search.mdx | 1 + api-reference/rest-apis/v2/memory/stats/get.mdx | 3 ++- api-reference/rest-apis/v2/memory/suggest.mdx | 1 + .../rest-apis/v2/notifications/add-notifications.mdx | 1 + .../rest-apis/v2/notifications/delete-notifications.mdx | 1 + api-reference/rest-apis/v2/notifications/get-config.mdx | 3 ++- .../rest-apis/v2/notifications/get-notifications-v2.mdx | 1 + api-reference/rest-apis/v2/notifications/set-config.mdx | 3 ++- .../rest-apis/v2/notifications/update-notifications.mdx | 1 + .../rest-apis/v2/organizations/add-organizations.mdx | 1 + .../rest-apis/v2/organizations/delete-organizations.mdx | 1 + .../rest-apis/v2/organizations/get-organizations-v2.mdx | 1 + .../v2/organizations/update-organization-disable-state.mdx | 3 ++- .../rest-apis/v2/organizations/update-organizations.mdx | 1 + api-reference/rest-apis/v2/presence/add-presence.mdx | 1 + api-reference/rest-apis/v2/presence/delete-presence.mdx | 1 + api-reference/rest-apis/v2/presence/update-presence.mdx | 1 + api-reference/rest-apis/v2/recordings/get-recordings.mdx | 1 + api-reference/rest-apis/v2/rewriter/ask-ai.mdx | 3 ++- api-reference/rest-apis/v2/user-groups/add-groups.mdx | 1 + .../rest-apis/v2/user-groups/add-users-to-group.mdx | 1 + .../rest-apis/v2/user-groups/delete-users-from-group.mdx | 1 + api-reference/rest-apis/v2/users/add-users.mdx | 1 + api-reference/rest-apis/v2/users/delete-users.mdx | 2 +- api-reference/rest-apis/v2/users/get-users-v2.mdx | 1 + api-reference/rest-apis/v2/users/update-users.mdx | 1 + api-reference/rest-apis/v2/workspace/activityconfig-get.mdx | 1 + .../rest-apis/v2/workspace/activityconfig-update.mdx | 1 + api-reference/rest-apis/v2/workspace/add-domain.mdx | 3 ++- .../v2/workspace/advancedwebhook-endpoints-create.mdx | 1 + .../v2/workspace/advancedwebhook-endpoints-delete.mdx | 1 + .../rest-apis/v2/workspace/advancedwebhook-endpoints-get.mdx | 1 + .../v2/workspace/advancedwebhook-endpoints-secret-get.mdx | 1 + .../v2/workspace/advancedwebhook-endpoints-update.mdx | 1 + .../rest-apis/v2/workspace/advancedwebhookconfig-get.mdx | 1 + .../rest-apis/v2/workspace/advancedwebhookconfig-update.mdx | 1 + api-reference/rest-apis/v2/workspace/apikey-create.mdx | 1 + api-reference/rest-apis/v2/workspace/apikey-update.mdx | 1 + api-reference/rest-apis/v2/workspace/apikeyconfig-get.mdx | 1 + api-reference/rest-apis/v2/workspace/apikeyconfig-update.mdx | 1 + api-reference/rest-apis/v2/workspace/apikeys-get.mdx | 1 + api-reference/rest-apis/v2/workspace/authtoken-reset.mdx | 1 + api-reference/rest-apis/v2/workspace/authtokens-get.mdx | 1 + api-reference/rest-apis/v2/workspace/create.mdx | 1 + api-reference/rest-apis/v2/workspace/delete-domain.mdx | 3 ++- api-reference/rest-apis/v2/workspace/domains-get.mdx | 3 ++- api-reference/rest-apis/v2/workspace/email-status.mdx | 1 + api-reference/rest-apis/v2/workspace/emailconfig-get.mdx | 1 + api-reference/rest-apis/v2/workspace/emailconfig-update.mdx | 1 + api-reference/rest-apis/v2/workspace/get.mdx | 1 + .../rest-apis/v2/workspace/notificationconfig-get.mdx | 1 + .../rest-apis/v2/workspace/notificationconfig-update.mdx | 1 + .../rest-apis/v2/workspace/permissionproviderconfig-get.mdx | 1 + .../v2/workspace/permissionproviderconfig-update.mdx | 1 + api-reference/rest-apis/v2/workspace/send-login-link.mdx | 1 + api-reference/rest-apis/v2/workspace/webhookconfig-get.mdx | 1 + .../rest-apis/v2/workspace/webhookconfig-update.mdx | 1 + api-reference/sdk/api/api-methods.mdx | 3 ++- api-reference/sdk/api/react-hooks.mdx | 1 + api-reference/sdk/models/data-models.mdx | 5 +++++ async-collaboration/activity/customize-behavior.mdx | 3 ++- async-collaboration/activity/overview.mdx | 1 + async-collaboration/activity/setup.mdx | 3 ++- async-collaboration/arrows/customize-behavior.mdx | 3 ++- async-collaboration/arrows/overview.mdx | 1 + async-collaboration/arrows/setup.mdx | 3 ++- async-collaboration/comments-sidebar/overview.mdx | 2 +- .../comments-sidebar/v1/customize-behavior.mdx | 3 ++- async-collaboration/comments-sidebar/v1/setup.mdx | 3 ++- .../comments-sidebar/v2/customize-behavior.mdx | 3 ++- async-collaboration/comments-sidebar/v2/setup.mdx | 3 ++- async-collaboration/comments/customize-behavior.mdx | 3 ++- async-collaboration/comments/notifications.mdx | 2 +- async-collaboration/comments/overview.mdx | 2 +- async-collaboration/comments/setup/ace.mdx | 3 ++- async-collaboration/comments/setup/apryse.mdx | 3 ++- .../comments/setup/canvas-comments/overview.mdx | 3 ++- async-collaboration/comments/setup/canvas.mdx | 4 ++-- .../comments/setup/chart-comments-setup/chartjs.mdx | 3 ++- .../comments/setup/chart-comments-setup/custom-charts.mdx | 3 ++- .../comments/setup/chart-comments-setup/highcharts.mdx | 3 ++- .../comments/setup/chart-comments-setup/nivo-charts.mdx | 3 ++- async-collaboration/comments/setup/ckeditor.mdx | 2 +- async-collaboration/comments/setup/codemirror.mdx | 3 ++- async-collaboration/comments/setup/draftjs.mdx | 3 ++- async-collaboration/comments/setup/freestyle.mdx | 3 ++- async-collaboration/comments/setup/inline-comments.mdx | 3 ++- async-collaboration/comments/setup/lexical.mdx | 3 ++- async-collaboration/comments/setup/lottie-player-setup.mdx | 3 ++- async-collaboration/comments/setup/monaco.mdx | 2 +- async-collaboration/comments/setup/nutrient.mdx | 2 +- async-collaboration/comments/setup/page.mdx | 3 ++- async-collaboration/comments/setup/plate.mdx | 3 ++- async-collaboration/comments/setup/popover.mdx | 3 ++- async-collaboration/comments/setup/prosemirror.mdx | 3 ++- async-collaboration/comments/setup/quill.mdx | 3 ++- async-collaboration/comments/setup/slatejs.mdx | 3 ++- async-collaboration/comments/setup/spreadjs.mdx | 2 +- async-collaboration/comments/setup/stream.mdx | 3 ++- async-collaboration/comments/setup/superdoc.mdx | 3 ++- async-collaboration/comments/setup/text.mdx | 3 ++- async-collaboration/comments/setup/tinymce.mdx | 2 +- async-collaboration/comments/setup/tiptap.mdx | 3 ++- .../setup/video-player-setup/custom-video-player-setup.mdx | 4 ++-- .../comments/setup/video-player-setup/video-player-setup.mdx | 4 ++-- .../comment-composer/customize-behavior.mdx | 3 ++- .../standalone-components/comment-composer/overview.mdx | 3 ++- .../standalone-components/comment-composer/setup.mdx | 3 ++- .../standalone-components/comment-pin/customize-behavior.mdx | 3 ++- .../comments/standalone-components/comment-pin/overview.mdx | 1 + .../comments/standalone-components/comment-pin/setup.mdx | 3 ++- .../comment-thread/customize-behavior.mdx | 3 ++- .../standalone-components/comment-thread/overview.mdx | 1 + .../comments/standalone-components/comment-thread/setup.mdx | 3 ++- async-collaboration/notifications/customize-behavior.mdx | 3 ++- async-collaboration/notifications/overview.mdx | 3 ++- async-collaboration/notifications/setup.mdx | 3 ++- async-collaboration/reactions/customize-behavior.mdx | 3 ++- async-collaboration/reactions/overview.mdx | 3 ++- async-collaboration/reactions/setup.mdx | 3 ++- async-collaboration/recorder/customize-behavior.mdx | 3 ++- async-collaboration/recorder/overview.mdx | 2 +- async-collaboration/recorder/setup.mdx | 4 ++++ async-collaboration/suggestions/overview.mdx | 1 + async-collaboration/view-analytics/customize-behavior.mdx | 3 ++- async-collaboration/view-analytics/overview.mdx | 1 + async-collaboration/view-analytics/setup.mdx | 3 ++- get-started/advanced.mdx | 2 +- get-started/cli.mdx | 2 +- get-started/mcp-installer.mdx | 2 +- get-started/quickstart-old.mdx | 4 ++-- get-started/quickstart.mdx | 2 +- get-started/skills.mdx | 2 +- global-styles/css-injection.mdx | 3 ++- global-styles/dark-mode.mdx | 3 ++- global-styles/global-styles.mdx | 3 ++- in-app-user-feedback/customize-behavior.mdx | 3 ++- in-app-user-feedback/overview.mdx | 5 +++++ in-app-user-feedback/setup.mdx | 3 ++- integrations/ag-grid.mdx | 3 ++- key-concepts/overview.mdx | 5 +++++ live-co-editing/customize-behavior.mdx | 3 ++- live-co-editing/customize-ui.mdx | 3 ++- live-co-editing/overview.mdx | 5 +++++ live-co-editing/setup.mdx | 4 ++++ mcp/mcp.mdx | 3 ++- migration/environments.mdx | 2 +- migration/migrate-from-cord-to-velt.mdx | 1 + migration/migrate-from-liveblocks-to-velt.mdx | 1 + .../share-and-invite/customize-ui/parts.mdx | 5 +++++ .../share-and-invite/customize-ui/slots.mdx | 3 ++- .../share-and-invite/customize-ui/variables.mdx | 5 +++++ permission-management/share-and-invite/overview.mdx | 2 +- permission-management/share-and-invite/setup.mdx | 3 ++- realtime-collaboration/crdt/overview.mdx | 4 ++-- realtime-collaboration/crdt/setup/blocknote.mdx | 4 ++-- realtime-collaboration/crdt/setup/codemirror.mdx | 4 ++-- realtime-collaboration/crdt/setup/core-stores/array.mdx | 4 ++-- realtime-collaboration/crdt/setup/core-stores/map.mdx | 4 ++-- realtime-collaboration/crdt/setup/core-stores/text.mdx | 4 ++-- realtime-collaboration/crdt/setup/core-stores/xml.mdx | 4 ++-- realtime-collaboration/crdt/setup/core.mdx | 4 ++-- realtime-collaboration/crdt/setup/reactflow.mdx | 4 ++-- realtime-collaboration/crdt/setup/tiptap.mdx | 4 ++-- realtime-collaboration/cursors/customize-behavior.mdx | 3 ++- realtime-collaboration/cursors/overview.mdx | 4 ++-- realtime-collaboration/cursors/setup.mdx | 4 ++++ realtime-collaboration/flock-mode/customize-behavior.mdx | 3 ++- realtime-collaboration/flock-mode/overview.mdx | 4 ++-- realtime-collaboration/flock-mode/setup.mdx | 3 ++- realtime-collaboration/huddle/customize-behavior.mdx | 3 ++- realtime-collaboration/huddle/setup.mdx | 3 ++- realtime-collaboration/huddle/webhooks.mdx | 5 +++++ realtime-collaboration/live-selection/customize-behavior.mdx | 3 ++- realtime-collaboration/live-selection/overview.mdx | 4 ++-- realtime-collaboration/live-selection/setup.mdx | 5 +++++ realtime-collaboration/live-state-sync/overview.mdx | 4 ++-- realtime-collaboration/live-state-sync/redux-middleware.mdx | 3 ++- realtime-collaboration/live-state-sync/setup.mdx | 3 ++- realtime-collaboration/presence/customize-behavior.mdx | 3 ++- realtime-collaboration/presence/overview.mdx | 4 ++-- realtime-collaboration/presence/setup.mdx | 3 ++- .../single-editor-mode/customize-behavior.mdx | 3 ++- realtime-collaboration/single-editor-mode/overview.mdx | 4 ++-- realtime-collaboration/single-editor-mode/setup.mdx | 4 ++-- realtime-collaboration/video-player-sync/overview.mdx | 4 ++++ realtime-collaboration/video-player-sync/setup.mdx | 3 ++- release-notes/3-0-0.mdx | 3 ++- release-notes/version-4/blocknote-changelog.mdx | 2 +- release-notes/version-4/codemirror-changelog.mdx | 2 +- release-notes/version-4/crdt-core-changelog.mdx | 2 +- release-notes/version-4/lexical-changelog.mdx | 2 +- release-notes/version-4/reactflow-changelog.mdx | 2 +- release-notes/version-4/sdk-changelog.mdx | 2 +- release-notes/version-4/tiptap-changelog.mdx | 2 +- release-notes/version-4/upgrade-guide.mdx | 3 ++- release-notes/version-5/crdt-core-changelog.mdx | 2 +- release-notes/version-5/sdk-changelog.mdx | 2 +- release-notes/version-5/upgrade-guide.mdx | 3 ++- release-notes/version-5/velt-node-changelog.mdx | 2 +- release-notes/version-5/velt-py-changelog.mdx | 2 +- security/auth-tokens.mdx | 1 + security/content-security-policy.mdx | 5 +++++ security/jwt-tokens.mdx | 2 +- security/proxy-server.mdx | 3 ++- security/supported-regions.mdx | 1 + self-host-data/activity.mdx | 2 +- self-host-data/attachments.mdx | 2 +- self-host-data/field-inventory.mdx | 4 ++-- self-host-data/notifications.mdx | 2 +- self-host-data/overview.mdx | 4 ++-- self-host-data/recordings.mdx | 2 +- ui-customization/conditional-templates.mdx | 1 + ui-customization/custom-action-component.mdx | 1 + .../async/activity-logs/activity-logs-primitives.mdx | 2 +- .../activity-logs/activity-logs-wireframe-variables.mdx | 2 +- ui-customization/features/async/area/wireframe-variables.mdx | 2 +- ui-customization/features/async/arrows/custom-button.mdx | 3 ++- ui-customization/features/async/arrows/parts.mdx | 5 +++++ ui-customization/features/async/arrows/slots.mdx | 3 ++- ui-customization/features/async/arrows/variables.mdx | 5 +++++ .../async/comments/autocomplete-wireframe-variables.mdx | 2 +- .../features/async/comments/comment-bubble/primitives.mdx | 2 +- .../async/comments/comment-bubble/wireframe-variables.mdx | 2 +- .../features/async/comments/comment-bubble/wireframes.mdx | 2 +- .../features/async/comments/comment-dialog-structure.mdx | 2 +- .../features/async/comments/comment-dialog/primitives.mdx | 2 +- .../async/comments/comment-dialog/wireframe-variables.mdx | 2 +- .../features/async/comments/comment-dialog/wireframes.mdx | 2 +- .../features/async/comments/comment-pin/primitives.mdx | 2 +- .../features/async/comments/comment-pin/wireframes.mdx | 2 +- .../features/async/comments/comment-player-timeline.mdx | 1 + .../async/comments/comment-sidebar-button/primitives.mdx | 2 +- .../comments/comment-sidebar-button/wireframe-variables.mdx | 2 +- .../async/comments/comment-sidebar-button/wireframes.mdx | 2 +- .../features/async/comments/comment-sidebar-structure-v2.mdx | 2 +- .../features/async/comments/comment-sidebar-structure.mdx | 2 +- .../comments/comment-sidebar/comment-sidebar-components.mdx | 2 +- .../comment-sidebar/comment-sidebar-v2-primitives.mdx | 2 +- .../comment-sidebar/comment-sidebar-v2-wireframes.mdx | 2 +- .../comment-sidebar/comment-sidebar-wireframe-variables.mdx | 2 +- .../async/comments/comment-tool-wireframe-variables.mdx | 2 +- ui-customization/features/async/comments/comment-tool.mdx | 2 +- .../features/async/comments/comment-video-player.mdx | 1 + ui-customization/features/async/comments/confirm-dialog.mdx | 2 +- .../async/comments/inline-comments-section/primitives.mdx | 2 +- .../comments/inline-comments-section/wireframe-variables.mdx | 2 +- .../async/comments/inline-comments-section/wireframes.mdx | 2 +- .../async/comments/multithread-comments/primitives.mdx | 2 +- .../comments/multithread-comments/wireframe-variables.mdx | 2 +- .../async/comments/multithread-comments/wireframes.mdx | 2 +- .../async/comments/persistent-comment-mode-banner.mdx | 2 +- .../comments/standalone-components/comment-composer.mdx | 1 + .../async/comments/standalone-components/comment-thread.mdx | 1 + .../features/async/comments/text-comment-primitives.mdx | 2 +- .../async/comments/text-comment-wireframe-variables.mdx | 2 +- .../comments/text-comment/text-comment-tool/primitives.mdx | 2 +- .../comments/text-comment/text-comment-tool/wireframes.mdx | 2 +- .../text-comment/text-comment-toolbar/primitives.mdx | 2 +- .../text-comment/text-comment-toolbar/wireframes.mdx | 2 +- ui-customization/features/async/inline-reactions.mdx | 2 +- .../async/notifications/notifications-panel/primitives.mdx | 2 +- .../notifications-panel/wireframe-variables.mdx | 2 +- .../async/notifications/notifications-panel/wireframes.mdx | 2 +- .../async/notifications/notifications-tool/primitives.mdx | 2 +- .../notifications/notifications-tool/wireframe-variables.mdx | 2 +- .../async/notifications/notifications-tool/wireframes.mdx | 2 +- .../features/async/reactions-wireframe-variables.mdx | 2 +- ui-customization/features/async/recorder/control-panel.mdx | 2 +- .../features/async/recorder/media-source-settings.mdx | 2 +- ui-customization/features/async/recorder/recorder-player.mdx | 2 +- ui-customization/features/async/recorder/recorder-tool.mdx | 2 +- .../async/recorder/recording-preview-steps-dialog.mdx | 2 +- ui-customization/features/async/recorder/subtitles.mdx | 2 +- .../async/recorder/transcription-wireframe-variables.mdx | 2 +- ui-customization/features/async/recorder/transcription.mdx | 2 +- ui-customization/features/async/recorder/video-editor.mdx | 2 +- .../features/async/recorder/wireframe-variables.mdx | 2 +- .../features/async/rewriter/wireframe-variables.mdx | 2 +- .../features/async/view-analytics/wireframe-variables.mdx | 2 +- .../features/realtime/cursors-wireframe-variables.mdx | 2 +- ui-customization/features/realtime/cursors.mdx | 2 +- ui-customization/features/realtime/huddle/parts.mdx | 5 +++++ ui-customization/features/realtime/huddle/slots.mdx | 3 ++- ui-customization/features/realtime/huddle/variables.mdx | 5 +++++ .../features/realtime/huddle/wireframe-variables.mdx | 2 +- .../features/realtime/live-selection-wireframe-variables.mdx | 2 +- ui-customization/features/realtime/live-selection.mdx | 1 + .../features/realtime/presence-wireframe-variables.mdx | 2 +- ui-customization/features/realtime/presence.mdx | 2 +- ui-customization/features/realtime/single-editor-mode.mdx | 2 +- ui-customization/layout.mdx | 1 + ui-customization/localisation.mdx | 1 + ui-customization/overview.mdx | 3 ++- ui-customization/setup.mdx | 1 + ui-customization/styling.mdx | 1 + ui-customization/template-variables.mdx | 1 + webhooks/advanced.mdx | 3 ++- webhooks/basic.mdx | 3 ++- 427 files changed, 724 insertions(+), 370 deletions(-) diff --git a/ai/agent-comments.mdx b/ai/agent-comments.mdx index fe4d2535d..9814bcf79 100644 --- a/ai/agent-comments.mdx +++ b/ai/agent-comments.mdx @@ -1,7 +1,7 @@ --- title: "Agent Comments" sidebarTitle: "Agent Comments" -description: "Let your AI agents leave comments and findings directly in Velt by calling the Comments REST APIs." +description: "Let AI agents post comments, findings, and suggestions into Velt threads via the Comments REST APIs, with accept/reject reviewer workflows." --- ## What are agent comments? diff --git a/ai/approval-engine/customize-behavior.mdx b/ai/approval-engine/customize-behavior.mdx index 2eaa3318e..472e6cecb 100644 --- a/ai/approval-engine/customize-behavior.mdx +++ b/ai/approval-engine/customize-behavior.mdx @@ -1,6 +1,6 @@ --- -title: "Customize Behavior" -description: "Node configuration, edge expressions, parallel groups, SLAs, linter rules, events, errors, and the full object reference." +title: "Approval Engine: Customize Behavior" +description: "Reference for Approval Engine node configs, edge expressions, parallel groups, SLA deadlines, linter rules, events, and error handling." --- This is the deep-dive reference. Setup covers the happy path. This page covers everything you reach for when you need precise control over node behavior, edge routing, quorum policies, SLA breaches, and event consumption. diff --git a/ai/approval-engine/overview.mdx b/ai/approval-engine/overview.mdx index 05db712f5..7d1c88761 100644 --- a/ai/approval-engine/overview.mdx +++ b/ai/approval-engine/overview.mdx @@ -1,7 +1,7 @@ --- title: "Approval Engine (Beta)" sidebarTitle: "Overview" -description: "Multi-step approval workflows where AI agents and humans review work together." +description: "Run multi-step approval workflows where AI agents and humans review work together, with state, retries, quorum, SLAs, and webhooks built in." --- ## What is the Approval Engine? diff --git a/ai/approval-engine/setup.mdx b/ai/approval-engine/setup.mdx index 32d519f8e..031f6f8c7 100644 --- a/ai/approval-engine/setup.mdx +++ b/ai/approval-engine/setup.mdx @@ -1,6 +1,6 @@ --- -title: "Setup" -description: "Build a review-and-approval workflow end to end: author a definition, dispatch a run, record a decision, and receive the outcome." +title: "Approval Engine Setup" +description: "Build a review-and-approval workflow end to end: author a definition, dispatch a run, record a human decision, and receive the outcome via webhook." --- A hands-on guide to building your first workflow on the Approval Engine. By the end you'll have authored a workflow, dispatched a run against a work item, recorded a human decision, and received the outcome. diff --git a/ai/chat-sdk-adapter.mdx b/ai/chat-sdk-adapter.mdx index c40d52622..924fae34a 100644 --- a/ai/chat-sdk-adapter.mdx +++ b/ai/chat-sdk-adapter.mdx @@ -1,7 +1,7 @@ --- title: "Chat SDK Adapter" sidebarTitle: "Chat SDK Adapter" -description: "Build a bot that reads and responds to Velt comment threads using the Chat SDK and @veltdev/chat-sdk-adapter." +description: "Build platform-agnostic bots that read and reply to Velt comment threads using the Chat SDK and the @veltdev/chat-sdk-adapter package." --- [Chat SDK](https://chat-sdk.dev) lets you build cross-platform bots whose logic diff --git a/ai/memory/setup.mdx b/ai/memory/setup.mdx index e8de62cad..0aded457e 100644 --- a/ai/memory/setup.mdx +++ b/ai/memory/setup.mdx @@ -1,6 +1,6 @@ --- -title: "Setup" -description: "Set up Velt Memory end to end: add a knowledge source, ask a question, search past decisions, and pull a grounded suggestion." +title: "Velt Memory Setup" +description: "Set up Velt Memory end to end: add a knowledge source, ask a natural-language question, search past review decisions, and get a grounded suggestion." --- A hands-on guide to building on Velt **Memory**, the review-intelligence layer. By the end you'll have added a knowledge source, asked a natural-language question, searched past review decisions, and pulled a grounded decision suggestion. diff --git a/ai/rewriter/customize-behavior.mdx b/ai/rewriter/customize-behavior.mdx index ffbe79a78..00d39747e 100644 --- a/ai/rewriter/customize-behavior.mdx +++ b/ai/rewriter/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Rewriter: Customize Behavior" +description: "Reference for Velt Rewriter methods like addComment to anchor AI suggestions, rewrites, and comments to selected text ranges inside your application." --- # addComment diff --git a/ai/rewriter/overview.mdx b/ai/rewriter/overview.mdx index c17b227eb..f49f852de 100644 --- a/ai/rewriter/overview.mdx +++ b/ai/rewriter/overview.mdx @@ -1,7 +1,7 @@ --- title: "Rewriter" sidebarTitle: "Overview" -description: "Let users select text on your website and use AI to rewrite, improve, or comment on it — powered by any major LLM provider." +description: "Let users select text in your app and use AI to rewrite, improve, or comment on it, powered by OpenAI, Anthropic, or any major LLM provider." --- diff --git a/ai/rewriter/setup.mdx b/ai/rewriter/setup.mdx index 8349f19a9..7c306a01b 100644 --- a/ai/rewriter/setup.mdx +++ b/ai/rewriter/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Rewriter Setup" +description: "Enable Velt Rewriter in your React, Next.js, or other framework app to add AI-powered text rewriting and inline suggestions on selected content." --- diff --git a/api-reference/rest-apis/v1/auth/generate-token.mdx b/api-reference/rest-apis/v1/auth/generate-token.mdx index 87058021f..bf69c7c55 100644 --- a/api-reference/rest-apis/v1/auth/generate-token.mdx +++ b/api-reference/rest-apis/v1/auth/generate-token.mdx @@ -1,5 +1,6 @@ --- -title: "Generate Token" +title: "Generate auth token (v1)" +description: "Generate a Velt JWT auth token using your API key and auth token. Encodes userId, organizationId and admin flag; expires in 48 hours." api: "POST https://api.velt.dev/v1/auth/token/get" --- diff --git a/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations.mdx b/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations.mdx index 18ddde321..3a39eca88 100644 --- a/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations.mdx +++ b/api-reference/rest-apis/v1/comments-feature/comment-annotations/add-comment-annotations.mdx @@ -1,5 +1,6 @@ --- -title: "Add Comment Annotations" +title: "Add comment annotations (v1)" +description: "Add comment annotations to a document via the v1 REST API. Attach comments to elements, text, or pages with HTML or plain text content." api: "POST https://api.velt.dev/v1/commentannotations/add" # api: "POST https://addcommentannotations.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/comments-feature/comment-annotations/delete-comment-annotations.mdx b/api-reference/rest-apis/v1/comments-feature/comment-annotations/delete-comment-annotations.mdx index 4fa2e9f87..290649a74 100644 --- a/api-reference/rest-apis/v1/comments-feature/comment-annotations/delete-comment-annotations.mdx +++ b/api-reference/rest-apis/v1/comments-feature/comment-annotations/delete-comment-annotations.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Comment Annotations" +title: "Delete comment annotations (v1)" +description: "Delete comment annotations from a document using the v1 REST API. Filter by location IDs, annotation IDs, or user IDs for targeted removal." api: "POST https://api.velt.dev/v1/commentannotations/delete" # api: "POST https://deletecommentannotations.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations-count.mdx b/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations-count.mdx index a1567c5d3..58ddff910 100644 --- a/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations-count.mdx +++ b/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations-count.mdx @@ -1,5 +1,6 @@ --- -title: 'Get Comment Annotations Count' +title: 'Get comment annotations count (v1)' +description: "Retrieve total and unread comment annotation counts for up to 30 documents using the v1 REST API. Filter by user ID and status IDs." api: 'POST https://api.velt.dev/v1/commentannotations/count/get' --- diff --git a/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations.mdx b/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations.mdx index c6a8dc166..0ee9c5c01 100644 --- a/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations.mdx +++ b/api-reference/rest-apis/v1/comments-feature/comment-annotations/get-comment-annotations.mdx @@ -1,5 +1,6 @@ --- -title: "Get Comment Annotations" +title: "Get comment annotations (v1)" +description: "Retrieve comment annotations from a document via the v1 REST API for SDK v3 or earlier. Filter by location IDs, annotation IDs, or user IDs." api: "POST https://api.velt.dev/v1/commentannotations/get" # api: "POST https://getcommentannotations.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/comments-feature/comment-annotations/update-comment-annotations.mdx b/api-reference/rest-apis/v1/comments-feature/comment-annotations/update-comment-annotations.mdx index d9eaff63b..81b562f13 100644 --- a/api-reference/rest-apis/v1/comments-feature/comment-annotations/update-comment-annotations.mdx +++ b/api-reference/rest-apis/v1/comments-feature/comment-annotations/update-comment-annotations.mdx @@ -1,5 +1,6 @@ --- -title: "Update Comment Annotations" +title: "Update comment annotations (v1)" +description: "Update comment annotations on a document via the v1 REST API. Filter by location, annotation, or user IDs and modify status, assignees, and more." api: "POST https://api.velt.dev/v1/commentannotations/update" # api: "POST https://updatecommentannotations.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/comments-feature/comments/add-comments.mdx b/api-reference/rest-apis/v1/comments-feature/comments/add-comments.mdx index 2675f6baf..fb3cc30cc 100644 --- a/api-reference/rest-apis/v1/comments-feature/comments/add-comments.mdx +++ b/api-reference/rest-apis/v1/comments-feature/comments/add-comments.mdx @@ -1,5 +1,6 @@ --- -title: "Add Comments" +title: "Add comments to annotation (v1)" +description: "Add reply comments inside a specific Velt comment annotation using the v1 REST API. Authenticate with API key and auth token headers." api: "POST https://api.velt.dev/v1/commentannotations/comments/add" # api: "POST https://addcommentsincommentannotation.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/comments-feature/comments/delete-comments.mdx b/api-reference/rest-apis/v1/comments-feature/comments/delete-comments.mdx index f5b9da8ed..d023529a0 100644 --- a/api-reference/rest-apis/v1/comments-feature/comments/delete-comments.mdx +++ b/api-reference/rest-apis/v1/comments-feature/comments/delete-comments.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Comments" +title: "Delete comments from annotation (v1)" +description: "Delete individual reply comments from a Velt comment annotation using the v1 REST API. Filter by specific comment IDs for targeted removal." api: "POST https://api.velt.dev/v1/commentannotations/comments/delete" # api: "POST https://getcommentsincommentannotation.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/comments-feature/comments/get-comments.mdx b/api-reference/rest-apis/v1/comments-feature/comments/get-comments.mdx index 94f7067a1..5ea6516e9 100644 --- a/api-reference/rest-apis/v1/comments-feature/comments/get-comments.mdx +++ b/api-reference/rest-apis/v1/comments-feature/comments/get-comments.mdx @@ -1,5 +1,6 @@ --- -title: "Get Comments" +title: "Get comments in annotation (v1)" +description: "Retrieve reply comments inside a specific Velt comment annotation using the v1 REST API. Requires advanced queries and SDK v4. Filter by comment IDs." api: "POST https://api.velt.dev/v1/commentannotations/comments/get" # api: "POST https://getcommentsincommentannotation.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/comments-feature/comments/update-comments.mdx b/api-reference/rest-apis/v1/comments-feature/comments/update-comments.mdx index 8e4b8424c..c34135060 100644 --- a/api-reference/rest-apis/v1/comments-feature/comments/update-comments.mdx +++ b/api-reference/rest-apis/v1/comments-feature/comments/update-comments.mdx @@ -1,5 +1,6 @@ --- -title: "Update Comments" +title: "Update comments in annotation (v1)" +description: "Update individual reply comments inside a Velt comment annotation using the v1 REST API. Edit comment text and metadata by comment ID." api: "POST https://api.velt.dev/v1/commentannotations/comments/update" # api: "POST https://updatecommentsincommentannotation.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/documents/add-documents.mdx b/api-reference/rest-apis/v1/documents/add-documents.mdx index aed06a185..ef015a139 100644 --- a/api-reference/rest-apis/v1/documents/add-documents.mdx +++ b/api-reference/rest-apis/v1/documents/add-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Add Documents" +title: "Add documents (v1)" +description: "Add documents with metadata to a Velt organization using the v1 REST API. Provide document IDs, names, and custom fields in a single request." api: "POST https://api.velt.dev/v1/organizations/documents/add" # api: "POST https://adddocuments.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/documents/delete-documents.mdx b/api-reference/rest-apis/v1/documents/delete-documents.mdx index 89bc857fc..0920c8dc7 100644 --- a/api-reference/rest-apis/v1/documents/delete-documents.mdx +++ b/api-reference/rest-apis/v1/documents/delete-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Documents" +title: "Delete documents (v1)" +description: "Delete one or more documents from a Velt organization using the v1 REST API. Pass an array of document IDs to remove documents and their data." api: "POST https://api.velt.dev/v1/organizations/documents/delete" # api: "POST https://deletedocuments.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/documents/get-documents.mdx b/api-reference/rest-apis/v1/documents/get-documents.mdx index 268aaf725..ca966202c 100644 --- a/api-reference/rest-apis/v1/documents/get-documents.mdx +++ b/api-reference/rest-apis/v1/documents/get-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Get Documents" +title: "Get documents (v1)" +description: "Retrieve specific documents or all documents in a Velt organization via the v1 REST API. Use this endpoint with SDK v3 or earlier versions." api: "POST https://api.velt.dev/v1/organizations/documents/get" # api: "POST https://getdocuments.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/documents/move-documents.mdx b/api-reference/rest-apis/v1/documents/move-documents.mdx index 70c542a3c..3b9c0ed47 100644 --- a/api-reference/rest-apis/v1/documents/move-documents.mdx +++ b/api-reference/rest-apis/v1/documents/move-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Move Documents" +title: "Move documents to folder (v1)" +description: "Move up to 30 documents into a target folder within a Velt organization using the v1 REST API. Reorganize document hierarchy in bulk." api: "POST https://api.velt.dev/v1/organizations/documents/move" --- diff --git a/api-reference/rest-apis/v1/documents/update-document-access.mdx b/api-reference/rest-apis/v1/documents/update-document-access.mdx index 65b4e1ccc..578880dd9 100644 --- a/api-reference/rest-apis/v1/documents/update-document-access.mdx +++ b/api-reference/rest-apis/v1/documents/update-document-access.mdx @@ -1,5 +1,6 @@ --- -title: "Update Access for Documents" +title: "Update document access type (v1)" +description: "Update the access type for one or many documents at once using the v1 REST API. Control public, restricted, or default document permissions." api: "POST https://api.velt.dev/v1/organizations/documents/access/update" # api: "POST https://updateaccessfordocuments.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/documents/update-document-disable-state.mdx b/api-reference/rest-apis/v1/documents/update-document-disable-state.mdx index af3c2a2a0..3606fc106 100644 --- a/api-reference/rest-apis/v1/documents/update-document-disable-state.mdx +++ b/api-reference/rest-apis/v1/documents/update-document-disable-state.mdx @@ -1,5 +1,6 @@ --- -title: "Update Disabled State for Documents" +title: "Update document disabled state (v1)" +description: "Enable or disable read and write access for specific documents using the v1 REST API. Useful to suspend Velt access after trial or subscription ends." api: "POST https://api.velt.dev/v1/organizations/documents/access/disablestate/update" # api: "POST https://updatedisablestatefordocuments.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/documents/update-documents.mdx b/api-reference/rest-apis/v1/documents/update-documents.mdx index b2021a675..b316e957b 100644 --- a/api-reference/rest-apis/v1/documents/update-documents.mdx +++ b/api-reference/rest-apis/v1/documents/update-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Update Documents" +title: "Update documents (v1)" +description: "Update metadata for one or more documents in a Velt organization using the v1 REST API. Modify names, custom fields, and other document properties." api: "POST https://api.velt.dev/v1/organizations/documents/update" # api: "POST https://updatedocuments.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/folders/add-folder.mdx b/api-reference/rest-apis/v1/folders/add-folder.mdx index 519b99333..867bf6594 100644 --- a/api-reference/rest-apis/v1/folders/add-folder.mdx +++ b/api-reference/rest-apis/v1/folders/add-folder.mdx @@ -1,5 +1,6 @@ --- -title: "Add Folder" +title: "Add folder (v1)" +description: "Create a new folder inside a Velt organization using the v1 REST API. Requires advanced queries enabled and Velt SDK v4 series deployed." api: "POST https://api.velt.dev/v1/organizations/folders/add" --- diff --git a/api-reference/rest-apis/v1/folders/get-folders.mdx b/api-reference/rest-apis/v1/folders/get-folders.mdx index 8a1784853..e7863da74 100644 --- a/api-reference/rest-apis/v1/folders/get-folders.mdx +++ b/api-reference/rest-apis/v1/folders/get-folders.mdx @@ -1,5 +1,6 @@ --- -title: "Get Folders" +title: "Get folders (v1)" +description: "Retrieve a folder's metadata and its subfolders within a Velt organization using the v1 REST API. Requires advanced queries and SDK v4 series." api: "POST https://api.velt.dev/v1/organizations/folders/get" --- diff --git a/api-reference/rest-apis/v1/folders/update-folder-access.mdx b/api-reference/rest-apis/v1/folders/update-folder-access.mdx index b9773aa33..89ca8909d 100644 --- a/api-reference/rest-apis/v1/folders/update-folder-access.mdx +++ b/api-reference/rest-apis/v1/folders/update-folder-access.mdx @@ -1,5 +1,6 @@ --- -title: "Update Access for Folders" +title: "Update folder access type (v1)" +description: "Update the access type for one or many folders at once using the v1 REST API. Control default, public, or restricted permissions for folders." api: "POST https://api.velt.dev/v1/organizations/folders/access/update" --- diff --git a/api-reference/rest-apis/v1/folders/update-folder.mdx b/api-reference/rest-apis/v1/folders/update-folder.mdx index 38190edd5..989ae36f3 100644 --- a/api-reference/rest-apis/v1/folders/update-folder.mdx +++ b/api-reference/rest-apis/v1/folders/update-folder.mdx @@ -1,5 +1,6 @@ --- -title: "Update Folder" +title: "Update or move folder (v1)" +description: "Update folder metadata or move a folder and its contents to a new parent using the v1 REST API. Requires advanced queries and SDK v4 series." api: "POST https://api.velt.dev/v1/organizations/folders/update" --- diff --git a/api-reference/rest-apis/v1/gdpr/delete-all-user-data-gdpr.mdx b/api-reference/rest-apis/v1/gdpr/delete-all-user-data-gdpr.mdx index df5a63763..152d48bc2 100644 --- a/api-reference/rest-apis/v1/gdpr/delete-all-user-data-gdpr.mdx +++ b/api-reference/rest-apis/v1/gdpr/delete-all-user-data-gdpr.mdx @@ -1,6 +1,6 @@ --- -title: "Delete All User Data" -description: "Remove All User data from Velt." +title: "Delete all user data (GDPR, v1)" +description: "Asynchronously delete all of a user's data from Velt for GDPR compliance, including comments, mentions, reactions, and organization access." # api: "POST https://api.velt.dev/deleteusers" api: "POST https://api.velt.dev/v1/users/data/delete" --- diff --git a/api-reference/rest-apis/v1/gdpr/get-all-user-data-gdpr.mdx b/api-reference/rest-apis/v1/gdpr/get-all-user-data-gdpr.mdx index 87349e5f5..47b76cc6a 100644 --- a/api-reference/rest-apis/v1/gdpr/get-all-user-data-gdpr.mdx +++ b/api-reference/rest-apis/v1/gdpr/get-all-user-data-gdpr.mdx @@ -1,6 +1,6 @@ --- -title: "Get All User Data" -description: "Get all feature data for a user stored in Velt." +title: "Get all user data (GDPR, v1)" +description: "Export all Velt feature data stored for a user for GDPR requests. Returns paginated chunks of 100 items per feature using nextPageToken." api: "POST https://api.velt.dev/v1/users/data/get" --- diff --git a/api-reference/rest-apis/v1/gdpr/get-delete-user-data-status-gdpr.mdx b/api-reference/rest-apis/v1/gdpr/get-delete-user-data-status-gdpr.mdx index 793de1961..460dc7fbb 100644 --- a/api-reference/rest-apis/v1/gdpr/get-delete-user-data-status-gdpr.mdx +++ b/api-reference/rest-apis/v1/gdpr/get-delete-user-data-status-gdpr.mdx @@ -1,6 +1,6 @@ --- -title: "Get Delete All User Data Status" -description: "Get the status of the data deletion process for a user." +title: "Get delete user data status (GDPR, v1)" +description: "Check the progress and status of an asynchronous GDPR user data deletion job in Velt. Poll this endpoint after starting a delete request." api: "POST https://api.velt.dev/v1/users/data/delete/status" --- diff --git a/api-reference/rest-apis/v1/livestate/broadcast-event.mdx b/api-reference/rest-apis/v1/livestate/broadcast-event.mdx index 1e034e967..e79ead34d 100644 --- a/api-reference/rest-apis/v1/livestate/broadcast-event.mdx +++ b/api-reference/rest-apis/v1/livestate/broadcast-event.mdx @@ -1,5 +1,6 @@ --- -title: "Broadcast Event" +title: "Broadcast live state event (v1)" +description: "Broadcast a live state event from your server to any Velt document using the v1 REST API. Pair with the Live State Sync feature for realtime updates." api: "POST https://api.velt.dev/v1/livestate/broadcast" --- diff --git a/api-reference/rest-apis/v1/locations/delete-data-by-location.mdx b/api-reference/rest-apis/v1/locations/delete-data-by-location.mdx index 184c9e492..07276b7a1 100644 --- a/api-reference/rest-apis/v1/locations/delete-data-by-location.mdx +++ b/api-reference/rest-apis/v1/locations/delete-data-by-location.mdx @@ -1,6 +1,6 @@ --- -title: "Delete Data by Location" -description: "Delete all data associated with a specific location" +title: "Delete data by location (v1)" +description: "Delete all Velt feature data tied to a specific location, including comments, recordings, and other annotations, using the v1 REST API." api: "POST https://api.velt.dev/v1/organizations/documents/locations/data/delete" --- diff --git a/api-reference/rest-apis/v1/locations/update-location.mdx b/api-reference/rest-apis/v1/locations/update-location.mdx index 1edb3342f..590ce4c85 100644 --- a/api-reference/rest-apis/v1/locations/update-location.mdx +++ b/api-reference/rest-apis/v1/locations/update-location.mdx @@ -1,6 +1,6 @@ --- -title: "Update Location" -description: "Update a Location's metadata" +title: "Update location (v1)" +description: "Update a Velt location's metadata within a document using the v1 REST API. Modify location names, custom fields, and other properties." api: "POST https://api.velt.dev/v1/organizations/documents/locations/update" --- diff --git a/api-reference/rest-apis/v1/notifications/add-notifications.mdx b/api-reference/rest-apis/v1/notifications/add-notifications.mdx index 48f27661f..7afa6360a 100644 --- a/api-reference/rest-apis/v1/notifications/add-notifications.mdx +++ b/api-reference/rest-apis/v1/notifications/add-notifications.mdx @@ -1,5 +1,6 @@ --- -title: "Add Notifications" +title: "Add notifications (v1)" +description: "Create and send in-app notifications to Velt users using the v1 REST API. Trigger notifications from your server with custom payloads and targets." api: "POST https://api.velt.dev/v1/notifications/add" # api: "POST https://addnotifications.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/notifications/delete-notifications.mdx b/api-reference/rest-apis/v1/notifications/delete-notifications.mdx index 376292d1b..9b4d28798 100644 --- a/api-reference/rest-apis/v1/notifications/delete-notifications.mdx +++ b/api-reference/rest-apis/v1/notifications/delete-notifications.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Notifications" +title: "Delete notifications (v1)" +description: "Delete in-app notifications from Velt using the v1 REST API. Remove specific notifications by ID to clean up notification feeds programmatically." api: "POST https://api.velt.dev/v1/notifications/delete" # api: "POST https://deletenotifications.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/notifications/get-config.mdx b/api-reference/rest-apis/v1/notifications/get-config.mdx index ac8499f60..0e4d42f61 100644 --- a/api-reference/rest-apis/v1/notifications/get-config.mdx +++ b/api-reference/rest-apis/v1/notifications/get-config.mdx @@ -1,5 +1,6 @@ --- -title: "Get Config" +title: "Get notifications config (v1)" +description: "Retrieve a user's notifications configuration from Velt using the v1 REST API. Requires the notifications feature enabled in the Velt console." api: "POST https://api.velt.dev/v1/notifications/config/get" --- diff --git a/api-reference/rest-apis/v1/notifications/get-notifications.mdx b/api-reference/rest-apis/v1/notifications/get-notifications.mdx index f5fbe3a56..a753c5efb 100644 --- a/api-reference/rest-apis/v1/notifications/get-notifications.mdx +++ b/api-reference/rest-apis/v1/notifications/get-notifications.mdx @@ -1,5 +1,6 @@ --- -title: "Get Notifications" +title: "Get notifications (v1)" +description: "Retrieve in-app notifications for Velt users via the v1 REST API. Use this endpoint with SDK v3 or earlier versions for notification feeds." api: "POST https://api.velt.dev/v1/notifications/get" # api: "POST https://getnotifications.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/notifications/set-config.mdx b/api-reference/rest-apis/v1/notifications/set-config.mdx index c15371ea3..8e9f83df1 100644 --- a/api-reference/rest-apis/v1/notifications/set-config.mdx +++ b/api-reference/rest-apis/v1/notifications/set-config.mdx @@ -1,5 +1,6 @@ --- -title: "Set Config" +title: "Set notifications config (v1)" +description: "Set a user's notifications configuration in Velt using the v1 REST API. Requires the notifications feature enabled in the Velt console first." api: "POST https://api.velt.dev/v1/notifications/config/set" --- diff --git a/api-reference/rest-apis/v1/notifications/update-notifications.mdx b/api-reference/rest-apis/v1/notifications/update-notifications.mdx index 222afdf2f..d89249cea 100644 --- a/api-reference/rest-apis/v1/notifications/update-notifications.mdx +++ b/api-reference/rest-apis/v1/notifications/update-notifications.mdx @@ -1,5 +1,6 @@ --- -title: "Update Notifications" +title: "Update notifications (v1)" +description: "Update existing in-app notifications in Velt using the v1 REST API. Modify notification content, status, or metadata after delivery." api: "POST https://api.velt.dev/v1/notifications/update" # api: "POST https://updatenotifications.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/organizations/add-organizations.mdx b/api-reference/rest-apis/v1/organizations/add-organizations.mdx index 972dce255..f3b96a62b 100644 --- a/api-reference/rest-apis/v1/organizations/add-organizations.mdx +++ b/api-reference/rest-apis/v1/organizations/add-organizations.mdx @@ -1,5 +1,6 @@ --- -title: "Add Organizations" +title: "Add organizations (v1)" +description: "Create new organizations and their metadata in Velt using the v1 REST API. Provision tenants for multi-org collaboration apps in a single call." api: "POST https://api.velt.dev/v1/organizations/add" # api: "POST https://addorganizations.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/organizations/delete-organizations.mdx b/api-reference/rest-apis/v1/organizations/delete-organizations.mdx index 41a433a90..ad51e814a 100644 --- a/api-reference/rest-apis/v1/organizations/delete-organizations.mdx +++ b/api-reference/rest-apis/v1/organizations/delete-organizations.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Organizations" +title: "Delete organizations (v1)" +description: "Delete one or more Velt organizations and all of their data using the v1 REST API. Pass an array of organization IDs to remove tenants in bulk." api: "POST https://api.velt.dev/v1/organizations/delete" # api: "POST https://deleteorganizations.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/organizations/get-organizations.mdx b/api-reference/rest-apis/v1/organizations/get-organizations.mdx index f3bfb6c04..44573c6d8 100644 --- a/api-reference/rest-apis/v1/organizations/get-organizations.mdx +++ b/api-reference/rest-apis/v1/organizations/get-organizations.mdx @@ -1,5 +1,6 @@ --- -title: "Get Organizations" +title: "Get organizations (v1)" +description: "Retrieve specific Velt organizations by organization IDs using the v1 REST API. Use this endpoint with SDK v3 or earlier versions." api: "POST https://api.velt.dev/v1/organizations/get" # api: "POST https://getorganizations.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/organizations/update-organization-disable-state.mdx b/api-reference/rest-apis/v1/organizations/update-organization-disable-state.mdx index 4f7082d18..03a0c3fd1 100644 --- a/api-reference/rest-apis/v1/organizations/update-organization-disable-state.mdx +++ b/api-reference/rest-apis/v1/organizations/update-organization-disable-state.mdx @@ -1,5 +1,6 @@ --- -title: "Update Disabled State for Organizations" +title: "Update organization disabled state (v1)" +description: "Enable or disable read and write access for all documents in a Velt organization using the v1 REST API. Useful when suspending tenant access." api: "POST https://api.velt.dev/v1/organizations/access/disablestate/update" # api: "POST https://updatedisablestatefororganizations.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/organizations/update-organizations.mdx b/api-reference/rest-apis/v1/organizations/update-organizations.mdx index 29bc319a7..6012fab2e 100644 --- a/api-reference/rest-apis/v1/organizations/update-organizations.mdx +++ b/api-reference/rest-apis/v1/organizations/update-organizations.mdx @@ -1,5 +1,6 @@ --- -title: "Update Organizations" +title: "Update organizations (v1)" +description: "Update metadata for one or more existing Velt organizations using the v1 REST API. Modify org names, custom fields, and other tenant properties." api: "POST https://api.velt.dev/v1/organizations/update" # api: "POST https://updateorganizations.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/user-groups/add-groups.mdx b/api-reference/rest-apis/v1/user-groups/add-groups.mdx index b22c14b2a..718e9aa9e 100644 --- a/api-reference/rest-apis/v1/user-groups/add-groups.mdx +++ b/api-reference/rest-apis/v1/user-groups/add-groups.mdx @@ -1,5 +1,6 @@ --- -title: "Add User Groups" +title: "Add user groups (v1)" +description: "Create user groups within a Velt organization using the v1 REST API. Organize members into groups for mentions, permissions, and team workflows." api: "POST https://api.velt.dev/v1/organizations/usergroups/add" # api: "POST https://addorganizationusergroups.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/user-groups/add-users-to-group.mdx b/api-reference/rest-apis/v1/user-groups/add-users-to-group.mdx index 06f0bd0b6..a36232033 100644 --- a/api-reference/rest-apis/v1/user-groups/add-users-to-group.mdx +++ b/api-reference/rest-apis/v1/user-groups/add-users-to-group.mdx @@ -1,5 +1,6 @@ --- -title: "Add Users to Groups" +title: "Add users to user group (v1)" +description: "Add users to a specific Velt organization user group using the v1 REST API. Manage group membership for mentions and team-based permissions." api: "POST https://api.velt.dev/v1/organizations/usergroups/users/add" # api: "POST https://addorganizationuserstogroup.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/user-groups/delete-users-from-group.mdx b/api-reference/rest-apis/v1/user-groups/delete-users-from-group.mdx index c078615a5..32047bda9 100644 --- a/api-reference/rest-apis/v1/user-groups/delete-users-from-group.mdx +++ b/api-reference/rest-apis/v1/user-groups/delete-users-from-group.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Users from Groups" +title: "Delete users from user group (v1)" +description: "Remove users from a specific Velt organization user group using the v1 REST API. Revoke group-based permissions and mention targeting in bulk." api: "POST https://api.velt.dev/v1/organizations/usergroups/users/delete" # api: "POST https://deleteorganizationusersfromgroup.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/users/add-users.mdx b/api-reference/rest-apis/v1/users/add-users.mdx index 4619f2000..febb48afc 100644 --- a/api-reference/rest-apis/v1/users/add-users.mdx +++ b/api-reference/rest-apis/v1/users/add-users.mdx @@ -1,5 +1,6 @@ --- -title: "Add Users" +title: "Add users (v1)" +description: "Add users to a Velt organization, folder, or document using the v1 REST API. Grants access and adds users to mention contact lists in one call." api: "POST https://api.velt.dev/v1/users/add" # api: "POST https://addusers.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/users/delete-users.mdx b/api-reference/rest-apis/v1/users/delete-users.mdx index df2d47344..f6e461ed6 100644 --- a/api-reference/rest-apis/v1/users/delete-users.mdx +++ b/api-reference/rest-apis/v1/users/delete-users.mdx @@ -1,6 +1,6 @@ --- -title: "Delete Users" -description: "Remove Users from an Organization or a Document." +title: "Delete users (v1)" +description: "Remove users from a Velt organization or document using the v1 REST API. Revokes access and removes them from mention contact lists in one call." api: "POST https://api.velt.dev/v1/users/delete" # api: "POST https://deleteusers.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/users/get-users.mdx b/api-reference/rest-apis/v1/users/get-users.mdx index 02d636bdf..fa7f20f1f 100644 --- a/api-reference/rest-apis/v1/users/get-users.mdx +++ b/api-reference/rest-apis/v1/users/get-users.mdx @@ -1,5 +1,6 @@ --- -title: "Get Users" +title: "Get users (v1)" +description: "Retrieve Velt users filtered by organization, document, user group, or user IDs via the v1 REST API. Use with SDK v3 or earlier versions." api: "POST https://api.velt.dev/v1/users/get" # api: "POST https://getusers.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/users/update-users.mdx b/api-reference/rest-apis/v1/users/update-users.mdx index 1588b8441..755a5aeb6 100644 --- a/api-reference/rest-apis/v1/users/update-users.mdx +++ b/api-reference/rest-apis/v1/users/update-users.mdx @@ -1,5 +1,6 @@ --- -title: "Update Users" +title: "Update users (v1)" +description: "Update Velt user metadata such as name and email using the v1 REST API. Filter by organization, document, folder, or user IDs to target users." api: "POST https://api.velt.dev/v1/users/update" # api: "POST https://updateusers.api.velt.dev/" --- diff --git a/api-reference/rest-apis/v1/workspace/add-domain.mdx b/api-reference/rest-apis/v1/workspace/add-domain.mdx index d5e27bd4e..8cd8d28ac 100644 --- a/api-reference/rest-apis/v1/workspace/add-domain.mdx +++ b/api-reference/rest-apis/v1/workspace/add-domain.mdx @@ -1,5 +1,6 @@ --- -title: "Add Domains" +title: "Add workspace domains (v1)" +description: "Add allowed domains to your Velt workspace using the v1 REST API. Manage which domains can authenticate and access your Velt-powered apps." api: "POST https://api.velt.dev/v1/workspace/domains/add" --- diff --git a/api-reference/rest-apis/v1/workspace/delete-domain.mdx b/api-reference/rest-apis/v1/workspace/delete-domain.mdx index e7c27ea17..bbca2880a 100644 --- a/api-reference/rest-apis/v1/workspace/delete-domain.mdx +++ b/api-reference/rest-apis/v1/workspace/delete-domain.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Domains" +title: "Delete workspace domains (v1)" +description: "Remove allowed domains from your Velt workspace using the v1 REST API. Revoke a domain's ability to authenticate against your Velt workspace." api: "POST https://api.velt.dev/v1/workspace/domains/delete" --- diff --git a/api-reference/rest-apis/v2/activities/add-activities.mdx b/api-reference/rest-apis/v2/activities/add-activities.mdx index 7d51308ad..fb32505a4 100644 --- a/api-reference/rest-apis/v2/activities/add-activities.mdx +++ b/api-reference/rest-apis/v2/activities/add-activities.mdx @@ -1,5 +1,6 @@ --- -title: "Add Activity Logs" +title: "Add activity logs (v2)" +description: "Create activity log records for a document in an organization using the Velt v2 REST API. Requires activityServiceConfig enabled in the Velt Console." api: "POST https://api.velt.dev/v2/activities/add" --- diff --git a/api-reference/rest-apis/v2/activities/delete-activities.mdx b/api-reference/rest-apis/v2/activities/delete-activities.mdx index 7dac0d2d8..1ab708033 100644 --- a/api-reference/rest-apis/v2/activities/delete-activities.mdx +++ b/api-reference/rest-apis/v2/activities/delete-activities.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Activity Logs" +title: "Delete activity logs (v2)" +description: "Remove activity log records by documentId, targetEntityId, or activityId in an organization using the Velt v2 REST API for activity history cleanup." api: "POST https://api.velt.dev/v2/activities/delete" --- diff --git a/api-reference/rest-apis/v2/activities/get-activities.mdx b/api-reference/rest-apis/v2/activities/get-activities.mdx index 0a3c1a250..702b677ee 100644 --- a/api-reference/rest-apis/v2/activities/get-activities.mdx +++ b/api-reference/rest-apis/v2/activities/get-activities.mdx @@ -1,5 +1,6 @@ --- -title: "Get Activity Logs" +title: "Get activity logs (v2)" +description: "Retrieve activity log records for a document or organization using the Velt v2 REST API to fetch audit history, user actions, and event timelines." api: "POST https://api.velt.dev/v2/activities/get" --- diff --git a/api-reference/rest-apis/v2/activities/update-activities.mdx b/api-reference/rest-apis/v2/activities/update-activities.mdx index 0bea82748..78d94f1ad 100644 --- a/api-reference/rest-apis/v2/activities/update-activities.mdx +++ b/api-reference/rest-apis/v2/activities/update-activities.mdx @@ -1,5 +1,6 @@ --- -title: "Update Activity Logs" +title: "Update activity logs (v2)" +description: "Modify existing activity log records within an organization using the Velt v2 REST API to amend metadata, payloads, or labels on past audit events." api: "POST https://api.velt.dev/v2/activities/update" --- diff --git a/api-reference/rest-apis/v2/agents/list-agent-executions.mdx b/api-reference/rest-apis/v2/agents/list-agent-executions.mdx index 9cb1ed2ea..e630c2575 100644 --- a/api-reference/rest-apis/v2/agents/list-agent-executions.mdx +++ b/api-reference/rest-apis/v2/agents/list-agent-executions.mdx @@ -1,5 +1,6 @@ --- -title: "List Agent Executions" +title: "List agent executions (v2)" +description: "List AI agent execution runs with status, timing, and metadata using the Velt v2 REST API to monitor agent activity, debug runs, and audit usage." api: "POST https://api.velt.dev/v2/agents/execution/list" --- diff --git a/api-reference/rest-apis/v2/approval-engine/definitions/create-definition.mdx b/api-reference/rest-apis/v2/approval-engine/definitions/create-definition.mdx index 8cfd0f0df..95ff314e2 100644 --- a/api-reference/rest-apis/v2/approval-engine/definitions/create-definition.mdx +++ b/api-reference/rest-apis/v2/approval-engine/definitions/create-definition.mdx @@ -1,5 +1,6 @@ --- -title: "Create Definition" +title: "Create approval definition (v2)" +description: "Register a new approval workflow definition with nodes, edges, and parallel groups using the Velt v2 REST API. Graphs are linted at write time." api: "POST https://api.velt.dev/v2/workflow/definitions/create" --- diff --git a/api-reference/rest-apis/v2/approval-engine/definitions/delete-definition.mdx b/api-reference/rest-apis/v2/approval-engine/definitions/delete-definition.mdx index cda259e53..561620258 100644 --- a/api-reference/rest-apis/v2/approval-engine/definitions/delete-definition.mdx +++ b/api-reference/rest-apis/v2/approval-engine/definitions/delete-definition.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Definition" +title: "Delete approval definition (v2)" +description: "Remove an approval workflow definition by ID using the Velt v2 REST API. Deletes the static blueprint of nodes, edges, and parallel groups." api: "POST https://api.velt.dev/v2/workflow/definitions/delete" --- diff --git a/api-reference/rest-apis/v2/approval-engine/definitions/get-definition.mdx b/api-reference/rest-apis/v2/approval-engine/definitions/get-definition.mdx index cd4997c2c..9ce95d609 100644 --- a/api-reference/rest-apis/v2/approval-engine/definitions/get-definition.mdx +++ b/api-reference/rest-apis/v2/approval-engine/definitions/get-definition.mdx @@ -1,5 +1,6 @@ --- -title: "Get Definition" +title: "Get approval definition (v2)" +description: "Fetch a single approval workflow definition with its nodes, edges, and parallel groups by ID using the Velt v2 REST API for inspection and audits." api: "POST https://api.velt.dev/v2/workflow/definitions/get" --- diff --git a/api-reference/rest-apis/v2/approval-engine/definitions/list-definitions.mdx b/api-reference/rest-apis/v2/approval-engine/definitions/list-definitions.mdx index 3df04155e..596485a8a 100644 --- a/api-reference/rest-apis/v2/approval-engine/definitions/list-definitions.mdx +++ b/api-reference/rest-apis/v2/approval-engine/definitions/list-definitions.mdx @@ -1,5 +1,6 @@ --- -title: "List Definitions" +title: "List approval definitions (v2)" +description: "List approval workflow definitions in a workspace using the Velt v2 REST API to browse blueprints, filter by status, and paginate results." api: "POST https://api.velt.dev/v2/workflow/definitions/list" --- diff --git a/api-reference/rest-apis/v2/approval-engine/definitions/update-definition.mdx b/api-reference/rest-apis/v2/approval-engine/definitions/update-definition.mdx index 615451010..1192e3cf9 100644 --- a/api-reference/rest-apis/v2/approval-engine/definitions/update-definition.mdx +++ b/api-reference/rest-apis/v2/approval-engine/definitions/update-definition.mdx @@ -1,5 +1,6 @@ --- -title: "Update Definition" +title: "Update approval definition (v2)" +description: "Edit an existing approval workflow definition's nodes, edges, or parallel groups using the Velt v2 REST API. Changes are linted before being applied." api: "POST https://api.velt.dev/v2/workflow/definitions/update" --- diff --git a/api-reference/rest-apis/v2/approval-engine/executions/cancel-execution.mdx b/api-reference/rest-apis/v2/approval-engine/executions/cancel-execution.mdx index cfa3a214f..864af0d49 100644 --- a/api-reference/rest-apis/v2/approval-engine/executions/cancel-execution.mdx +++ b/api-reference/rest-apis/v2/approval-engine/executions/cancel-execution.mdx @@ -1,5 +1,6 @@ --- -title: "Cancel Execution" +title: "Cancel approval execution (v2)" +description: "Cancel a running approval workflow execution by ID using the Velt v2 REST API to halt pending steps and mark the run as terminated." api: "POST https://api.velt.dev/v2/workflow/executions/cancel" --- diff --git a/api-reference/rest-apis/v2/approval-engine/executions/dispatch-execution.mdx b/api-reference/rest-apis/v2/approval-engine/executions/dispatch-execution.mdx index 901cdde21..0dfa0bef0 100644 --- a/api-reference/rest-apis/v2/approval-engine/executions/dispatch-execution.mdx +++ b/api-reference/rest-apis/v2/approval-engine/executions/dispatch-execution.mdx @@ -1,5 +1,6 @@ --- -title: "Dispatch Execution" +title: "Dispatch approval execution (v2)" +description: "Start a new approval workflow execution from a definition using the Velt v2 REST API, passing inputs and context to launch a fresh run." api: "POST https://api.velt.dev/v2/workflow/executions/dispatch" --- diff --git a/api-reference/rest-apis/v2/approval-engine/executions/get-execution-events.mdx b/api-reference/rest-apis/v2/approval-engine/executions/get-execution-events.mdx index c8f9ed080..5dd187749 100644 --- a/api-reference/rest-apis/v2/approval-engine/executions/get-execution-events.mdx +++ b/api-reference/rest-apis/v2/approval-engine/executions/get-execution-events.mdx @@ -1,5 +1,6 @@ --- -title: "Get Execution Events" +title: "Get approval execution events (v2)" +description: "Fetch the ordered event stream for an approval workflow execution using the Velt v2 REST API to audit transitions, reviewer actions, and outcomes." api: "POST https://api.velt.dev/v2/workflow/executions/getEvents" --- diff --git a/api-reference/rest-apis/v2/approval-engine/executions/get-execution.mdx b/api-reference/rest-apis/v2/approval-engine/executions/get-execution.mdx index 141cf5d68..6f57f0d8d 100644 --- a/api-reference/rest-apis/v2/approval-engine/executions/get-execution.mdx +++ b/api-reference/rest-apis/v2/approval-engine/executions/get-execution.mdx @@ -1,5 +1,6 @@ --- -title: "Get Execution" +title: "Get approval execution (v2)" +description: "Retrieve a single approval workflow execution with current status, step states, and metadata by ID using the Velt v2 REST API for run inspection." api: "POST https://api.velt.dev/v2/workflow/executions/get" --- diff --git a/api-reference/rest-apis/v2/approval-engine/executions/list-executions.mdx b/api-reference/rest-apis/v2/approval-engine/executions/list-executions.mdx index 3f0cc8ec7..486b34df0 100644 --- a/api-reference/rest-apis/v2/approval-engine/executions/list-executions.mdx +++ b/api-reference/rest-apis/v2/approval-engine/executions/list-executions.mdx @@ -1,5 +1,6 @@ --- -title: "List Executions" +title: "List approval executions (v2)" +description: "List approval workflow executions filtered by definition, status, or time range using the Velt v2 REST API to monitor runs and reporting dashboards." api: "POST https://api.velt.dev/v2/workflow/executions/list" --- diff --git a/api-reference/rest-apis/v2/approval-engine/steps/cancel-step.mdx b/api-reference/rest-apis/v2/approval-engine/steps/cancel-step.mdx index 20f1e6136..56c52dc44 100644 --- a/api-reference/rest-apis/v2/approval-engine/steps/cancel-step.mdx +++ b/api-reference/rest-apis/v2/approval-engine/steps/cancel-step.mdx @@ -1,5 +1,6 @@ --- -title: "Cancel Step" +title: "Cancel approval step (v2)" +description: "Cancel an individual step within a running approval workflow execution using the Velt v2 REST API to skip pending reviewers or agent tasks." api: "POST https://api.velt.dev/v2/workflow/steps/cancel" --- diff --git a/api-reference/rest-apis/v2/approval-engine/steps/record-agent-resolution.mdx b/api-reference/rest-apis/v2/approval-engine/steps/record-agent-resolution.mdx index 2dfbe8e39..9e713982b 100644 --- a/api-reference/rest-apis/v2/approval-engine/steps/record-agent-resolution.mdx +++ b/api-reference/rest-apis/v2/approval-engine/steps/record-agent-resolution.mdx @@ -1,5 +1,6 @@ --- -title: "Record Agent Resolution" +title: "Record agent resolution (v2)" +description: "Submit an AI agent's resolution for an approval step using the Velt v2 REST API to record agent verdicts, confidence, and reasoning back into the run." api: "POST https://api.velt.dev/v2/workflow/steps/recordAgentResolution" --- diff --git a/api-reference/rest-apis/v2/approval-engine/steps/record-reviewer-decision.mdx b/api-reference/rest-apis/v2/approval-engine/steps/record-reviewer-decision.mdx index a8b38769d..55b6f2cec 100644 --- a/api-reference/rest-apis/v2/approval-engine/steps/record-reviewer-decision.mdx +++ b/api-reference/rest-apis/v2/approval-engine/steps/record-reviewer-decision.mdx @@ -1,5 +1,6 @@ --- -title: "Record Reviewer Decision" +title: "Record reviewer decision (v2)" +description: "Record a human reviewer's approve, reject, or comment decision on an approval step using the Velt v2 REST API to advance the workflow execution." api: "POST https://api.velt.dev/v2/workflow/steps/recordReviewerDecision" --- diff --git a/api-reference/rest-apis/v2/approval-engine/steps/resolve-step.mdx b/api-reference/rest-apis/v2/approval-engine/steps/resolve-step.mdx index 5d0696b9a..8637cb177 100644 --- a/api-reference/rest-apis/v2/approval-engine/steps/resolve-step.mdx +++ b/api-reference/rest-apis/v2/approval-engine/steps/resolve-step.mdx @@ -1,5 +1,6 @@ --- -title: "Resolve Step" +title: "Resolve approval step (v2)" +description: "Mark an approval workflow step as resolved with a final outcome using the Velt v2 REST API to close out the step and progress to the next node." api: "POST https://api.velt.dev/v2/workflow/steps/resolve" --- diff --git a/api-reference/rest-apis/v2/auth/add-permissions.mdx b/api-reference/rest-apis/v2/auth/add-permissions.mdx index 3fee8231b..45c03bb0a 100644 --- a/api-reference/rest-apis/v2/auth/add-permissions.mdx +++ b/api-reference/rest-apis/v2/auth/add-permissions.mdx @@ -1,5 +1,6 @@ --- -title: "Add Permissions" +title: "Add user permissions (v2)" +description: "Grant a user access roles (viewer or editor) on organizations, folders, or documents using the Velt v2 REST API for fine-grained authorization control." api: "POST https://api.velt.dev/v2/auth/permissions/add" --- diff --git a/api-reference/rest-apis/v2/auth/generate-signature.mdx b/api-reference/rest-apis/v2/auth/generate-signature.mdx index 78ad09a80..2c883f1d4 100644 --- a/api-reference/rest-apis/v2/auth/generate-signature.mdx +++ b/api-reference/rest-apis/v2/auth/generate-signature.mdx @@ -1,5 +1,6 @@ --- -title: "Generate Signature" +title: "Generate auth signature (v2)" +description: "Generate a server-side signed payload signature using the Velt v2 REST API to securely authenticate end-user identity claims sent from your backend." api: "POST https://api.velt.dev/v2/auth/generate_signature" --- diff --git a/api-reference/rest-apis/v2/auth/generate-token.mdx b/api-reference/rest-apis/v2/auth/generate-token.mdx index d23df6114..57b8098a9 100644 --- a/api-reference/rest-apis/v2/auth/generate-token.mdx +++ b/api-reference/rest-apis/v2/auth/generate-token.mdx @@ -1,5 +1,6 @@ --- -title: "Generate Token" +title: "Generate auth token (v2)" +description: "Mint a JWT auth token with user identity and resource permissions using the Velt v2 REST API to securely sign in users to organizations, folders, and documents." api: "POST https://api.velt.dev/v2/auth/generate_token" --- diff --git a/api-reference/rest-apis/v2/auth/get-permissions.mdx b/api-reference/rest-apis/v2/auth/get-permissions.mdx index 7bbf9cba9..1e65b5d62 100644 --- a/api-reference/rest-apis/v2/auth/get-permissions.mdx +++ b/api-reference/rest-apis/v2/auth/get-permissions.mdx @@ -1,5 +1,6 @@ --- -title: "Get Permissions" +title: "Get user permissions (v2)" +description: "Retrieve a user's current access roles across organizations, folders, and documents using the Velt v2 REST API for authorization checks and audits." api: "POST https://api.velt.dev/v2/auth/permissions/get" --- diff --git a/api-reference/rest-apis/v2/auth/remove-permissions.mdx b/api-reference/rest-apis/v2/auth/remove-permissions.mdx index 0181c6ad8..05da0115e 100644 --- a/api-reference/rest-apis/v2/auth/remove-permissions.mdx +++ b/api-reference/rest-apis/v2/auth/remove-permissions.mdx @@ -1,5 +1,6 @@ --- -title: "Remove Permissions" +title: "Remove user permissions (v2)" +description: "Revoke a user's access roles on organizations, folders, or documents using the Velt v2 REST API to tighten authorization and offboard collaborators." api: "POST https://api.velt.dev/v2/auth/permissions/remove" --- diff --git a/api-reference/rest-apis/v2/comments-feature/comment-annotations/add-comment-annotations.mdx b/api-reference/rest-apis/v2/comments-feature/comment-annotations/add-comment-annotations.mdx index bd8d35908..6daa12821 100644 --- a/api-reference/rest-apis/v2/comments-feature/comment-annotations/add-comment-annotations.mdx +++ b/api-reference/rest-apis/v2/comments-feature/comment-annotations/add-comment-annotations.mdx @@ -1,5 +1,6 @@ --- -title: "Add Comment Annotations" +title: "Add comment annotations (v2)" +description: "Create comment annotation threads anchored to documents using the Velt v2 REST API, with support for replies, mentions, and target element metadata." api: "POST https://api.velt.dev/v2/commentannotations/add" --- diff --git a/api-reference/rest-apis/v2/comments-feature/comment-annotations/delete-comment-annotations.mdx b/api-reference/rest-apis/v2/comments-feature/comment-annotations/delete-comment-annotations.mdx index 635e88ce2..a2286e395 100644 --- a/api-reference/rest-apis/v2/comments-feature/comment-annotations/delete-comment-annotations.mdx +++ b/api-reference/rest-apis/v2/comments-feature/comment-annotations/delete-comment-annotations.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Comment Annotations" +title: "Delete comment annotations (v2)" +description: "Permanently remove comment annotation threads and their replies from a document using the Velt v2 REST API for moderation and content cleanup." api: "POST https://api.velt.dev/v2/commentannotations/delete" --- diff --git a/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-count.mdx b/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-count.mdx index 9089cf924..6013475c9 100644 --- a/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-count.mdx +++ b/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-count.mdx @@ -1,5 +1,6 @@ --- -title: 'Get Comment Annotations Count' +title: "Get comment annotations count (v2)" +description: "Get the total count of comment annotations on a document or across an organization using the Velt v2 REST API to power activity badges and dashboards." api: 'POST https://api.velt.dev/v2/commentannotations/count/get' --- diff --git a/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-v2.mdx b/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-v2.mdx index 02eb683af..46613e1ab 100644 --- a/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-v2.mdx +++ b/api-reference/rest-apis/v2/comments-feature/comment-annotations/get-comment-annotations-v2.mdx @@ -1,5 +1,6 @@ --- -title: "Get Comment Annotations" +title: "Get comment annotations (v2)" +description: "Fetch comment annotation threads with replies, mentions, and status filters using the Velt v2 REST API to render inline collaboration threads in your app." api: "POST https://api.velt.dev/v2/commentannotations/get" --- diff --git a/api-reference/rest-apis/v2/comments-feature/comment-annotations/update-comment-annotations.mdx b/api-reference/rest-apis/v2/comments-feature/comment-annotations/update-comment-annotations.mdx index d727f4295..31202fe1d 100644 --- a/api-reference/rest-apis/v2/comments-feature/comment-annotations/update-comment-annotations.mdx +++ b/api-reference/rest-apis/v2/comments-feature/comment-annotations/update-comment-annotations.mdx @@ -1,5 +1,6 @@ --- -title: "Update Comment Annotations" +title: "Update comment annotations (v2)" +description: "Update comment annotation properties such as status, priority, assignees, or labels using the Velt v2 REST API to manage collaboration threads server-side." api: "POST https://api.velt.dev/v2/commentannotations/update" --- diff --git a/api-reference/rest-apis/v2/comments-feature/comments/add-comments.mdx b/api-reference/rest-apis/v2/comments-feature/comments/add-comments.mdx index 60e6c8ae8..32b4122ca 100644 --- a/api-reference/rest-apis/v2/comments-feature/comments/add-comments.mdx +++ b/api-reference/rest-apis/v2/comments-feature/comments/add-comments.mdx @@ -1,5 +1,6 @@ --- -title: "Add Comments" +title: "Add comments (v2)" +description: "Add a new comment or reply to an existing comment annotation thread using the Velt v2 REST API, with support for rich content, mentions, and attachments." api: "POST https://api.velt.dev/v2/commentannotations/comments/add" --- diff --git a/api-reference/rest-apis/v2/comments-feature/comments/delete-comments.mdx b/api-reference/rest-apis/v2/comments-feature/comments/delete-comments.mdx index fcc39fcfd..254b7055a 100644 --- a/api-reference/rest-apis/v2/comments-feature/comments/delete-comments.mdx +++ b/api-reference/rest-apis/v2/comments-feature/comments/delete-comments.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Comments" +title: "Delete comments (v2)" +description: "Delete individual comments or replies within a comment annotation thread using the Velt v2 REST API for moderation and content removal workflows." api: "POST https://api.velt.dev/v2/commentannotations/comments/delete" --- diff --git a/api-reference/rest-apis/v2/comments-feature/comments/get-comments.mdx b/api-reference/rest-apis/v2/comments-feature/comments/get-comments.mdx index d55bd949a..40a3311e6 100644 --- a/api-reference/rest-apis/v2/comments-feature/comments/get-comments.mdx +++ b/api-reference/rest-apis/v2/comments-feature/comments/get-comments.mdx @@ -1,5 +1,6 @@ --- -title: "Get Comments" +title: "Get comments (v2)" +description: "Retrieve individual comments and replies within comment annotation threads using the Velt v2 REST API for inspection, exports, and integrations." api: "POST https://api.velt.dev/v2/commentannotations/comments/get" --- diff --git a/api-reference/rest-apis/v2/comments-feature/comments/update-comments.mdx b/api-reference/rest-apis/v2/comments-feature/comments/update-comments.mdx index 93abff050..6349c8c73 100644 --- a/api-reference/rest-apis/v2/comments-feature/comments/update-comments.mdx +++ b/api-reference/rest-apis/v2/comments-feature/comments/update-comments.mdx @@ -1,5 +1,6 @@ --- -title: "Update Comments" +title: "Update comments (v2)" +description: "Edit the body, mentions, or metadata of an existing comment in a thread using the Velt v2 REST API to keep collaboration content accurate and current." api: "POST https://api.velt.dev/v2/commentannotations/comments/update" --- diff --git a/api-reference/rest-apis/v2/crdt/add-crdt-data.mdx b/api-reference/rest-apis/v2/crdt/add-crdt-data.mdx index 24978045e..b55ecd99d 100644 --- a/api-reference/rest-apis/v2/crdt/add-crdt-data.mdx +++ b/api-reference/rest-apis/v2/crdt/add-crdt-data.mdx @@ -1,5 +1,6 @@ --- -title: "Add CRDT Data" +title: "Add CRDT data (v2)" +description: "Insert new CRDT documents for collaborative real-time state using the Velt v2 REST API to seed shared data across clients with conflict-free merges." api: "POST https://api.velt.dev/v2/crdt/add" --- diff --git a/api-reference/rest-apis/v2/crdt/get-crdt-data.mdx b/api-reference/rest-apis/v2/crdt/get-crdt-data.mdx index 2843af1b6..572bdb6fd 100644 --- a/api-reference/rest-apis/v2/crdt/get-crdt-data.mdx +++ b/api-reference/rest-apis/v2/crdt/get-crdt-data.mdx @@ -1,5 +1,6 @@ --- -title: "Get CRDT Data" +title: "Get CRDT data (v2)" +description: "Read CRDT documents and their merged state using the Velt v2 REST API for server-side syncing, backups, and integrations with collaborative state." api: "POST https://api.velt.dev/v2/crdt/get" --- diff --git a/api-reference/rest-apis/v2/crdt/update-crdt-data.mdx b/api-reference/rest-apis/v2/crdt/update-crdt-data.mdx index 10dced24c..9977507e0 100644 --- a/api-reference/rest-apis/v2/crdt/update-crdt-data.mdx +++ b/api-reference/rest-apis/v2/crdt/update-crdt-data.mdx @@ -1,5 +1,6 @@ --- -title: "Update CRDT Data" +title: "Update CRDT data (v2)" +description: "Apply updates to existing CRDT documents using the Velt v2 REST API to push server-side mutations into the conflict-free replicated data store." api: "POST https://api.velt.dev/v2/crdt/update" --- diff --git a/api-reference/rest-apis/v2/documents/add-documents.mdx b/api-reference/rest-apis/v2/documents/add-documents.mdx index 8d5b4a005..84207fa13 100644 --- a/api-reference/rest-apis/v2/documents/add-documents.mdx +++ b/api-reference/rest-apis/v2/documents/add-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Add Documents" +title: "Add documents (v2)" +description: "Create new documents under an organization with metadata and folder placement using the Velt v2 REST API to bootstrap collaboration resources at scale." api: "POST https://api.velt.dev/v2/organizations/documents/add" --- diff --git a/api-reference/rest-apis/v2/documents/delete-documents.mdx b/api-reference/rest-apis/v2/documents/delete-documents.mdx index e6ae23849..a1faeda1a 100644 --- a/api-reference/rest-apis/v2/documents/delete-documents.mdx +++ b/api-reference/rest-apis/v2/documents/delete-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Documents" +title: "Delete documents (v2)" +description: "Permanently delete documents and their associated collaboration data from an organization using the Velt v2 REST API for cleanup and lifecycle automation." api: "POST https://api.velt.dev/v2/organizations/documents/delete" --- diff --git a/api-reference/rest-apis/v2/documents/get-documents-v2.mdx b/api-reference/rest-apis/v2/documents/get-documents-v2.mdx index 8af3a5a9c..240182760 100644 --- a/api-reference/rest-apis/v2/documents/get-documents-v2.mdx +++ b/api-reference/rest-apis/v2/documents/get-documents-v2.mdx @@ -1,5 +1,6 @@ --- -title: "Get Documents" +title: "Get documents (v2)" +description: "Retrieve documents within an organization filtered by IDs, folders, or metadata using the Velt v2 REST API for syncing, exports, and dashboards." api: "POST https://api.velt.dev/v2/organizations/documents/get" --- diff --git a/api-reference/rest-apis/v2/documents/migrate-documents-status.mdx b/api-reference/rest-apis/v2/documents/migrate-documents-status.mdx index 0c254774c..f5fc3afea 100644 --- a/api-reference/rest-apis/v2/documents/migrate-documents-status.mdx +++ b/api-reference/rest-apis/v2/documents/migrate-documents-status.mdx @@ -1,5 +1,6 @@ --- -title: "Migrate Documents Status" +title: "Get document migration status (v2)" +description: "Check the progress and status of a bulk document migration job using the Velt v2 REST API to monitor long-running data transfers between organizations." api: "POST https://api.velt.dev/v2/organizations/documents/migrate/status" --- diff --git a/api-reference/rest-apis/v2/documents/migrate-documents.mdx b/api-reference/rest-apis/v2/documents/migrate-documents.mdx index 98c854318..937f5e3f6 100644 --- a/api-reference/rest-apis/v2/documents/migrate-documents.mdx +++ b/api-reference/rest-apis/v2/documents/migrate-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Migrate Documents" +title: "Migrate documents (v2)" +description: "Bulk migrate documents and their collaboration data between organizations or environments using the Velt v2 REST API for tenant moves and consolidations." api: "POST https://api.velt.dev/v2/organizations/documents/migrate" --- diff --git a/api-reference/rest-apis/v2/documents/move-documents.mdx b/api-reference/rest-apis/v2/documents/move-documents.mdx index d37dcfa40..ffb9d7583 100644 --- a/api-reference/rest-apis/v2/documents/move-documents.mdx +++ b/api-reference/rest-apis/v2/documents/move-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Move Documents" +title: "Move documents (v2)" +description: "Move documents between folders within an organization using the Velt v2 REST API to reorganize content hierarchies without losing comments or activity." api: "POST https://api.velt.dev/v2/organizations/documents/move" --- diff --git a/api-reference/rest-apis/v2/documents/update-document-access.mdx b/api-reference/rest-apis/v2/documents/update-document-access.mdx index f68e50a6d..695411b9b 100644 --- a/api-reference/rest-apis/v2/documents/update-document-access.mdx +++ b/api-reference/rest-apis/v2/documents/update-document-access.mdx @@ -1,5 +1,6 @@ --- -title: "Update Access for Documents" +title: "Update document access (v2)" +description: "Adjust document-level access roles and sharing rules for users or groups using the Velt v2 REST API to manage permissions and collaboration scope." api: "POST https://api.velt.dev/v2/organizations/documents/access/update" --- diff --git a/api-reference/rest-apis/v2/documents/update-document-disable-state.mdx b/api-reference/rest-apis/v2/documents/update-document-disable-state.mdx index 43d95165b..402cde7f7 100644 --- a/api-reference/rest-apis/v2/documents/update-document-disable-state.mdx +++ b/api-reference/rest-apis/v2/documents/update-document-disable-state.mdx @@ -1,5 +1,6 @@ --- -title: "Update Disabled State for Documents" +title: "Update document disabled state (v2)" +description: "Enable or disable a document's collaboration features such as comments and presence using the Velt v2 REST API to freeze or reopen activity per resource." api: "POST https://api.velt.dev/v2/organizations/documents/access/disablestate/update" --- diff --git a/api-reference/rest-apis/v2/documents/update-documents.mdx b/api-reference/rest-apis/v2/documents/update-documents.mdx index 4d79f4422..32f7bc234 100644 --- a/api-reference/rest-apis/v2/documents/update-documents.mdx +++ b/api-reference/rest-apis/v2/documents/update-documents.mdx @@ -1,5 +1,6 @@ --- -title: "Update Documents" +title: "Update documents (v2)" +description: "Update document metadata such as title, description, and custom fields using the Velt v2 REST API to keep collaboration resources in sync with your app." api: "POST https://api.velt.dev/v2/organizations/documents/update" --- diff --git a/api-reference/rest-apis/v2/folders/add-folder.mdx b/api-reference/rest-apis/v2/folders/add-folder.mdx index 623a7fa1e..c0c975fce 100644 --- a/api-reference/rest-apis/v2/folders/add-folder.mdx +++ b/api-reference/rest-apis/v2/folders/add-folder.mdx @@ -1,5 +1,6 @@ --- -title: "Add Folder" +title: "Add folder (v2)" +description: "Create a new folder under an organization using the Velt v2 REST API to organize documents into hierarchies and scope access for collaborators." api: "POST https://api.velt.dev/v2/organizations/folders/add" --- diff --git a/api-reference/rest-apis/v2/folders/delete-folder.mdx b/api-reference/rest-apis/v2/folders/delete-folder.mdx index 6a5975f1b..0781b2aef 100644 --- a/api-reference/rest-apis/v2/folders/delete-folder.mdx +++ b/api-reference/rest-apis/v2/folders/delete-folder.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Folder" +title: "Delete folder (v2)" +description: "Delete a folder and optionally its child documents from an organization using the Velt v2 REST API for cleanup and content-hierarchy maintenance." api: "POST https://api.velt.dev/v2/organizations/folders/delete" --- diff --git a/api-reference/rest-apis/v2/folders/get-folders.mdx b/api-reference/rest-apis/v2/folders/get-folders.mdx index 423ac69d7..aa21e7794 100644 --- a/api-reference/rest-apis/v2/folders/get-folders.mdx +++ b/api-reference/rest-apis/v2/folders/get-folders.mdx @@ -1,5 +1,6 @@ --- -title: "Get Folders" +title: "Get folders (v2)" +description: "Retrieve folders within an organization filtered by IDs or parent using the Velt v2 REST API to render navigation trees and content browsers in your app." api: "POST https://api.velt.dev/v2/organizations/folders/get" --- diff --git a/api-reference/rest-apis/v2/folders/update-folder-access.mdx b/api-reference/rest-apis/v2/folders/update-folder-access.mdx index e64b6c633..19cdba071 100644 --- a/api-reference/rest-apis/v2/folders/update-folder-access.mdx +++ b/api-reference/rest-apis/v2/folders/update-folder-access.mdx @@ -1,5 +1,6 @@ --- -title: "Update Access for Folders" +title: "Update folder access (v2)" +description: "Adjust folder-level access roles and sharing rules for users or groups using the Velt v2 REST API to govern collaboration on grouped documents." api: "POST https://api.velt.dev/v2/organizations/folders/access/update" --- diff --git a/api-reference/rest-apis/v2/folders/update-folder.mdx b/api-reference/rest-apis/v2/folders/update-folder.mdx index 5bf7cea18..26df3d755 100644 --- a/api-reference/rest-apis/v2/folders/update-folder.mdx +++ b/api-reference/rest-apis/v2/folders/update-folder.mdx @@ -1,5 +1,6 @@ --- -title: "Update Folder" +title: "Update folder (v2)" +description: "Edit folder metadata like name, description, or parent placement using the Velt v2 REST API to keep your content hierarchy organized and labeled." api: "POST https://api.velt.dev/v2/organizations/folders/update" --- diff --git a/api-reference/rest-apis/v2/gdpr/delete-all-user-data-gdpr.mdx b/api-reference/rest-apis/v2/gdpr/delete-all-user-data-gdpr.mdx index edf2af467..ddb4a59ae 100644 --- a/api-reference/rest-apis/v2/gdpr/delete-all-user-data-gdpr.mdx +++ b/api-reference/rest-apis/v2/gdpr/delete-all-user-data-gdpr.mdx @@ -1,6 +1,6 @@ --- -title: "Delete All User Data" -description: "Remove All User data from Velt." +title: "Delete all user data (v2)" +description: "Permanently remove all of a user's stored data from Velt for GDPR compliance using the v2 REST API to honor data deletion and right-to-be-forgotten requests." api: "POST https://api.velt.dev/v2/users/data/delete" --- diff --git a/api-reference/rest-apis/v2/gdpr/get-all-user-data-gdpr.mdx b/api-reference/rest-apis/v2/gdpr/get-all-user-data-gdpr.mdx index a25c4372d..c7fd21b4d 100644 --- a/api-reference/rest-apis/v2/gdpr/get-all-user-data-gdpr.mdx +++ b/api-reference/rest-apis/v2/gdpr/get-all-user-data-gdpr.mdx @@ -1,6 +1,6 @@ --- -title: "Get All User Data" -description: "Get all feature data for a user stored in Velt." +title: "Get all user data (v2)" +description: "Export all feature data stored in Velt for a single user using the v2 REST API to support GDPR data-access, portability, and subject-access requests." api: "POST https://api.velt.dev/v2/users/data/get" --- diff --git a/api-reference/rest-apis/v2/gdpr/get-delete-user-data-status-gdpr.mdx b/api-reference/rest-apis/v2/gdpr/get-delete-user-data-status-gdpr.mdx index 0ef81b63b..66cba9c82 100644 --- a/api-reference/rest-apis/v2/gdpr/get-delete-user-data-status-gdpr.mdx +++ b/api-reference/rest-apis/v2/gdpr/get-delete-user-data-status-gdpr.mdx @@ -1,6 +1,6 @@ --- -title: "Get Delete All User Data Status" -description: "Get the status of the data deletion process for a user." +title: "Get user data deletion status (v2)" +description: "Check the progress of a GDPR user-data deletion job using the Velt v2 REST API to track completion status, errors, and remaining items in the deletion queue." api: "POST https://api.velt.dev/v2/users/data/delete/status" --- diff --git a/api-reference/rest-apis/v2/livestate/broadcast-event.mdx b/api-reference/rest-apis/v2/livestate/broadcast-event.mdx index 6d05b9045..5bfd78782 100644 --- a/api-reference/rest-apis/v2/livestate/broadcast-event.mdx +++ b/api-reference/rest-apis/v2/livestate/broadcast-event.mdx @@ -1,5 +1,6 @@ --- -title: "Broadcast Event" +title: "Broadcast live state event (v2)" +description: "Broadcast custom real-time events to connected clients on a document or channel using the Velt v2 REST API to power live state, presence, and notifications." api: "POST https://api.velt.dev/v2/livestate/broadcast" --- diff --git a/api-reference/rest-apis/v2/memory/alerts/action.mdx b/api-reference/rest-apis/v2/memory/alerts/action.mdx index fbd93c40e..6c9176772 100644 --- a/api-reference/rest-apis/v2/memory/alerts/action.mdx +++ b/api-reference/rest-apis/v2/memory/alerts/action.mdx @@ -1,5 +1,6 @@ --- -title: "Mark Alert Actioned" +title: "Mark memory alert actioned (v2)" +description: "Mark a Memory alert as actioned with an outcome note using the Velt v2 REST API to track follow-up on AI-driven review trend notifications." api: "POST https://api.velt.dev/v2/memory/alerts/action" --- diff --git a/api-reference/rest-apis/v2/memory/alerts/config/get.mdx b/api-reference/rest-apis/v2/memory/alerts/config/get.mdx index 2e7e626ec..9d1cd2e3e 100644 --- a/api-reference/rest-apis/v2/memory/alerts/config/get.mdx +++ b/api-reference/rest-apis/v2/memory/alerts/config/get.mdx @@ -1,5 +1,6 @@ --- -title: "Get Alert Config" +title: "Get memory alert config (v2)" +description: "Fetch the current Memory alert configuration including thresholds and channels using the Velt v2 REST API to inspect alerting rules for review trends." api: "POST https://api.velt.dev/v2/memory/alerts/config/get" --- diff --git a/api-reference/rest-apis/v2/memory/alerts/config/update.mdx b/api-reference/rest-apis/v2/memory/alerts/config/update.mdx index 04c307c8c..bdc76ba4a 100644 --- a/api-reference/rest-apis/v2/memory/alerts/config/update.mdx +++ b/api-reference/rest-apis/v2/memory/alerts/config/update.mdx @@ -1,5 +1,6 @@ --- -title: "Update Alert Config" +title: "Update memory alert config (v2)" +description: "Update Memory alert thresholds, channels, and routing rules using the Velt v2 REST API to tune proactive notifications for review trend monitoring." api: "POST https://api.velt.dev/v2/memory/alerts/config/update" --- diff --git a/api-reference/rest-apis/v2/memory/alerts/dismiss.mdx b/api-reference/rest-apis/v2/memory/alerts/dismiss.mdx index bceacc6aa..a637cc1a2 100644 --- a/api-reference/rest-apis/v2/memory/alerts/dismiss.mdx +++ b/api-reference/rest-apis/v2/memory/alerts/dismiss.mdx @@ -1,5 +1,6 @@ --- -title: "Dismiss Alert" +title: "Dismiss memory alert (v2)" +description: "Dismiss a Memory alert so it no longer appears in the active list using the Velt v2 REST API to clear handled review-trend notifications from the queue." api: "POST https://api.velt.dev/v2/memory/alerts/dismiss" --- diff --git a/api-reference/rest-apis/v2/memory/alerts/list.mdx b/api-reference/rest-apis/v2/memory/alerts/list.mdx index 720493e82..f4f673147 100644 --- a/api-reference/rest-apis/v2/memory/alerts/list.mdx +++ b/api-reference/rest-apis/v2/memory/alerts/list.mdx @@ -1,5 +1,6 @@ --- -title: "List Alerts" +title: "List memory alerts (v2)" +description: "List active Memory alerts (up to 50) about review trends such as approval-rate drift using the Velt v2 REST API to surface proactive notifications in your app." api: "POST https://api.velt.dev/v2/memory/alerts/list" --- diff --git a/api-reference/rest-apis/v2/memory/ask.mdx b/api-reference/rest-apis/v2/memory/ask.mdx index 2025db49e..3d456bb6c 100644 --- a/api-reference/rest-apis/v2/memory/ask.mdx +++ b/api-reference/rest-apis/v2/memory/ask.mdx @@ -1,5 +1,6 @@ --- -title: "Ask Memory" +title: "Ask memory (v2)" +description: "Send a natural-language query to Velt Memory and get grounded answers from your knowledge sources using the v2 REST API for AI-powered review assistance." api: "POST https://api.velt.dev/v2/memory/ask" --- diff --git a/api-reference/rest-apis/v2/memory/judgments/query.mdx b/api-reference/rest-apis/v2/memory/judgments/query.mdx index b0e8682e4..2ccc06687 100644 --- a/api-reference/rest-apis/v2/memory/judgments/query.mdx +++ b/api-reference/rest-apis/v2/memory/judgments/query.mdx @@ -1,5 +1,6 @@ --- -title: "Query Judgments" +title: "Query memory judgments (v2)" +description: "Query Memory reviewer judgments by filters such as outcome, reviewer, or time range using the Velt v2 REST API to analyze decisions and approval trends." api: "POST https://api.velt.dev/v2/memory/judgments/query" --- diff --git a/api-reference/rest-apis/v2/memory/knowledge/delete.mdx b/api-reference/rest-apis/v2/memory/knowledge/delete.mdx index 1eb1c851f..ec62fffbb 100644 --- a/api-reference/rest-apis/v2/memory/knowledge/delete.mdx +++ b/api-reference/rest-apis/v2/memory/knowledge/delete.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Knowledge" +title: "Delete memory knowledge source (v2)" +description: "Hard-delete a Memory knowledge source and all its chunks and rules using the Velt v2 REST API. Processing or referenced sources return FAILED_PRECONDITION." api: "POST https://api.velt.dev/v2/memory/knowledge/delete" --- diff --git a/api-reference/rest-apis/v2/memory/knowledge/download.mdx b/api-reference/rest-apis/v2/memory/knowledge/download.mdx index 95107e762..a74a6f68a 100644 --- a/api-reference/rest-apis/v2/memory/knowledge/download.mdx +++ b/api-reference/rest-apis/v2/memory/knowledge/download.mdx @@ -1,5 +1,6 @@ --- -title: "Download Canonical Markdown" +title: "Download canonical markdown (v2)" +description: "Download the canonical markdown extracted from a Memory knowledge source using the Velt v2 REST API. Returns null if extraction is still in progress." api: "POST https://api.velt.dev/v2/memory/knowledge/download" --- diff --git a/api-reference/rest-apis/v2/memory/knowledge/ingest-status.mdx b/api-reference/rest-apis/v2/memory/knowledge/ingest-status.mdx index 80d463d2d..5f39ab599 100644 --- a/api-reference/rest-apis/v2/memory/knowledge/ingest-status.mdx +++ b/api-reference/rest-apis/v2/memory/knowledge/ingest-status.mdx @@ -1,5 +1,6 @@ --- -title: "Get Ingest Status" +title: "Get knowledge ingest status (v2)" +description: "Poll the status of a Memory knowledge ingestion job started via the ingest endpoint using the Velt v2 REST API to track parsing, chunking, and indexing." api: "POST https://api.velt.dev/v2/memory/knowledge/ingest-status" --- diff --git a/api-reference/rest-apis/v2/memory/knowledge/ingest.mdx b/api-reference/rest-apis/v2/memory/knowledge/ingest.mdx index 182cd203e..a58819a06 100644 --- a/api-reference/rest-apis/v2/memory/knowledge/ingest.mdx +++ b/api-reference/rest-apis/v2/memory/knowledge/ingest.mdx @@ -1,5 +1,6 @@ --- -title: "Ingest Knowledge" +title: "Ingest memory knowledge (v2)" +description: "Submit a new knowledge source for ingestion into Velt Memory using the v2 REST API to extract, chunk, and index content for grounded AI answers and judgments." api: "POST https://api.velt.dev/v2/memory/knowledge/ingest" --- diff --git a/api-reference/rest-apis/v2/memory/knowledge/list.mdx b/api-reference/rest-apis/v2/memory/knowledge/list.mdx index 07059957e..73200fd87 100644 --- a/api-reference/rest-apis/v2/memory/knowledge/list.mdx +++ b/api-reference/rest-apis/v2/memory/knowledge/list.mdx @@ -1,5 +1,6 @@ --- title: "List Knowledge Sources" +description: "List your Velt Memory v2 knowledge sources, each with ingestion status, embedding state, and signed download URLs for completed files." api: "POST https://api.velt.dev/v2/memory/knowledge/list" --- diff --git a/api-reference/rest-apis/v2/memory/knowledge/rules.mdx b/api-reference/rest-apis/v2/memory/knowledge/rules.mdx index ab18135fd..bb3f0714f 100644 --- a/api-reference/rest-apis/v2/memory/knowledge/rules.mdx +++ b/api-reference/rest-apis/v2/memory/knowledge/rules.mdx @@ -1,5 +1,6 @@ --- title: "List Extracted Rules" +description: "List the policy rules extracted from a rule-based knowledge source in Velt Memory v2, including rule text, IDs, and source metadata." api: "POST https://api.velt.dev/v2/memory/knowledge/rules" --- diff --git a/api-reference/rest-apis/v2/memory/knowledge/search.mdx b/api-reference/rest-apis/v2/memory/knowledge/search.mdx index ff662074c..ea5d90447 100644 --- a/api-reference/rest-apis/v2/memory/knowledge/search.mdx +++ b/api-reference/rest-apis/v2/memory/knowledge/search.mdx @@ -1,5 +1,6 @@ --- title: "Search Knowledge Base" +description: "Run a workspace-scoped semantic vector search over ingested knowledge base content in Velt Memory v2 to retrieve relevant chunks and citations." api: "POST https://api.velt.dev/v2/memory/knowledge/search" --- diff --git a/api-reference/rest-apis/v2/memory/knowledge/update.mdx b/api-reference/rest-apis/v2/memory/knowledge/update.mdx index bbb69c958..8178c2f75 100644 --- a/api-reference/rest-apis/v2/memory/knowledge/update.mdx +++ b/api-reference/rest-apis/v2/memory/knowledge/update.mdx @@ -1,5 +1,6 @@ --- -title: "Update Knowledge" +title: "Update Knowledge Source" +description: "Replace a Velt Memory v2 knowledge source's content and re-run the conversion, rule extraction, and embedding pipeline, bumping its version." api: "POST https://api.velt.dev/v2/memory/knowledge/update" --- diff --git a/api-reference/rest-apis/v2/memory/knowledge/upload-url.mdx b/api-reference/rest-apis/v2/memory/knowledge/upload-url.mdx index fffe45e68..de2db46e7 100644 --- a/api-reference/rest-apis/v2/memory/knowledge/upload-url.mdx +++ b/api-reference/rest-apis/v2/memory/knowledge/upload-url.mdx @@ -1,5 +1,6 @@ --- -title: "Get Upload URL" +title: "Get Knowledge Upload URL" +description: "Mint a short-lived signed upload URL (up to 30 MB) for the Velt Memory v2 by-reference ingestion flow, returning a fileRef for ingestion." api: "POST https://api.velt.dev/v2/memory/knowledge/upload-url" --- diff --git a/api-reference/rest-apis/v2/memory/patterns/get.mdx b/api-reference/rest-apis/v2/memory/patterns/get.mdx index eca9872cd..7a7754d69 100644 --- a/api-reference/rest-apis/v2/memory/patterns/get.mdx +++ b/api-reference/rest-apis/v2/memory/patterns/get.mdx @@ -1,5 +1,6 @@ --- -title: "Get Patterns" +title: "Get Decision Patterns" +description: "List decision patterns detected by Velt Memory v2 across accumulated review judgments in a workspace, revealing reviewer policies and trends." api: "POST https://api.velt.dev/v2/memory/patterns/get" --- diff --git a/api-reference/rest-apis/v2/memory/profiles/get.mdx b/api-reference/rest-apis/v2/memory/profiles/get.mdx index c6f666db9..780dfb00c 100644 --- a/api-reference/rest-apis/v2/memory/profiles/get.mdx +++ b/api-reference/rest-apis/v2/memory/profiles/get.mdx @@ -1,5 +1,6 @@ --- title: "Get Reviewer Profile" +description: "Fetch a reviewer's behavioral profile from Velt Memory v2: judgment volume, approval rate, review speed, top flags, content types, and peak hours." api: "POST https://api.velt.dev/v2/memory/profiles/get" --- diff --git a/api-reference/rest-apis/v2/memory/search.mdx b/api-reference/rest-apis/v2/memory/search.mdx index ead68fb8e..c015f7f8f 100644 --- a/api-reference/rest-apis/v2/memory/search.mdx +++ b/api-reference/rest-apis/v2/memory/search.mdx @@ -1,5 +1,6 @@ --- title: "Search Judgments" +description: "Run a semantic vector search over past review judgments in Velt Memory v2, with optional filters by decision, reviewer, content type, or recency." api: "POST https://api.velt.dev/v2/memory/search" --- diff --git a/api-reference/rest-apis/v2/memory/stats/get.mdx b/api-reference/rest-apis/v2/memory/stats/get.mdx index 33a036712..8dc0a67da 100644 --- a/api-reference/rest-apis/v2/memory/stats/get.mdx +++ b/api-reference/rest-apis/v2/memory/stats/get.mdx @@ -1,5 +1,6 @@ --- -title: "Get Stats" +title: "Get Memory Stats" +description: "Fetch aggregate Velt Memory v2 counts for a workspace, including totals for judgments, knowledge sources, patterns, and reviewer profiles." api: "POST https://api.velt.dev/v2/memory/stats/get" --- diff --git a/api-reference/rest-apis/v2/memory/suggest.mdx b/api-reference/rest-apis/v2/memory/suggest.mdx index c2d2a8f1b..8e89349cd 100644 --- a/api-reference/rest-apis/v2/memory/suggest.mdx +++ b/api-reference/rest-apis/v2/memory/suggest.mdx @@ -1,5 +1,6 @@ --- title: "Suggest Decision" +description: "Compute a suggested review decision in Velt Memory v2 grounded in past judgments, returning a primary recommendation and a conflict signal when split." api: "POST https://api.velt.dev/v2/memory/suggest" --- diff --git a/api-reference/rest-apis/v2/notifications/add-notifications.mdx b/api-reference/rest-apis/v2/notifications/add-notifications.mdx index 2613c02ea..334594eae 100644 --- a/api-reference/rest-apis/v2/notifications/add-notifications.mdx +++ b/api-reference/rest-apis/v2/notifications/add-notifications.mdx @@ -1,5 +1,6 @@ --- title: "Add Notifications" +description: "Create in-app notifications for users in a Velt workspace via the v2 REST API, including recipient targeting, message body, and metadata." api: "POST https://api.velt.dev/v2/notifications/add" --- diff --git a/api-reference/rest-apis/v2/notifications/delete-notifications.mdx b/api-reference/rest-apis/v2/notifications/delete-notifications.mdx index d88dbd2ed..ec7ca9b35 100644 --- a/api-reference/rest-apis/v2/notifications/delete-notifications.mdx +++ b/api-reference/rest-apis/v2/notifications/delete-notifications.mdx @@ -1,5 +1,6 @@ --- title: "Delete Notifications" +description: "Delete one or more in-app notifications from a Velt workspace using the v2 REST API by notification ID, recipient, or document filter." api: "POST https://api.velt.dev/v2/notifications/delete" --- diff --git a/api-reference/rest-apis/v2/notifications/get-config.mdx b/api-reference/rest-apis/v2/notifications/get-config.mdx index 776b6248d..533c19ae7 100644 --- a/api-reference/rest-apis/v2/notifications/get-config.mdx +++ b/api-reference/rest-apis/v2/notifications/get-config.mdx @@ -1,5 +1,6 @@ --- -title: "Get Config" +title: "Get Notifications Config" +description: "Retrieve the workspace notifications configuration in Velt v2, including channel toggles, default preferences, and delivery rules for in-app notifications." api: "POST https://api.velt.dev/v2/notifications/config/get" --- diff --git a/api-reference/rest-apis/v2/notifications/get-notifications-v2.mdx b/api-reference/rest-apis/v2/notifications/get-notifications-v2.mdx index 6b14556f3..7ece73458 100644 --- a/api-reference/rest-apis/v2/notifications/get-notifications-v2.mdx +++ b/api-reference/rest-apis/v2/notifications/get-notifications-v2.mdx @@ -1,5 +1,6 @@ --- title: "Get Notifications" +description: "Retrieve in-app notifications from a Velt workspace using the v2 REST API, with filters by recipient user, document, organization, and pagination." api: "POST https://api.velt.dev/v2/notifications/get" --- diff --git a/api-reference/rest-apis/v2/notifications/set-config.mdx b/api-reference/rest-apis/v2/notifications/set-config.mdx index 8016fc408..eeaa7827c 100644 --- a/api-reference/rest-apis/v2/notifications/set-config.mdx +++ b/api-reference/rest-apis/v2/notifications/set-config.mdx @@ -1,5 +1,6 @@ --- -title: "Set Config" +title: "Set Notifications Config" +description: "Set or replace the workspace notifications configuration in Velt v2, controlling channel toggles, defaults, and delivery rules for in-app notifications." api: "POST https://api.velt.dev/v2/notifications/config/set" --- diff --git a/api-reference/rest-apis/v2/notifications/update-notifications.mdx b/api-reference/rest-apis/v2/notifications/update-notifications.mdx index 50b6e9260..9200422bc 100644 --- a/api-reference/rest-apis/v2/notifications/update-notifications.mdx +++ b/api-reference/rest-apis/v2/notifications/update-notifications.mdx @@ -1,5 +1,6 @@ --- title: "Update Notifications" +description: "Update in-app notifications in a Velt workspace via the v2 REST API, modifying read state, message content, recipients, or custom metadata." api: "POST https://api.velt.dev/v2/notifications/update" --- diff --git a/api-reference/rest-apis/v2/organizations/add-organizations.mdx b/api-reference/rest-apis/v2/organizations/add-organizations.mdx index e09833160..551c63193 100644 --- a/api-reference/rest-apis/v2/organizations/add-organizations.mdx +++ b/api-reference/rest-apis/v2/organizations/add-organizations.mdx @@ -1,5 +1,6 @@ --- title: "Add Organizations" +description: "Create one or more organizations in a Velt workspace using the v2 REST API, including organization IDs, names, and custom metadata fields." api: "POST https://api.velt.dev/v2/organizations/add" --- diff --git a/api-reference/rest-apis/v2/organizations/delete-organizations.mdx b/api-reference/rest-apis/v2/organizations/delete-organizations.mdx index cc189e622..45fbf61ee 100644 --- a/api-reference/rest-apis/v2/organizations/delete-organizations.mdx +++ b/api-reference/rest-apis/v2/organizations/delete-organizations.mdx @@ -1,5 +1,6 @@ --- title: "Delete Organizations" +description: "Delete specific organizations and their data from a Velt workspace by organization ID using the v2 REST API for tenant cleanup and offboarding." api: "POST https://api.velt.dev/v2/organizations/delete" --- diff --git a/api-reference/rest-apis/v2/organizations/get-organizations-v2.mdx b/api-reference/rest-apis/v2/organizations/get-organizations-v2.mdx index a7ead3285..0272e7476 100644 --- a/api-reference/rest-apis/v2/organizations/get-organizations-v2.mdx +++ b/api-reference/rest-apis/v2/organizations/get-organizations-v2.mdx @@ -1,5 +1,6 @@ --- title: "Get Organizations" +description: "Retrieve organizations from a Velt workspace by organization ID using the v2 REST API, returning organization metadata, names, and configuration." api: "POST https://api.velt.dev/v2/organizations/get" --- diff --git a/api-reference/rest-apis/v2/organizations/update-organization-disable-state.mdx b/api-reference/rest-apis/v2/organizations/update-organization-disable-state.mdx index 921487124..3f6bc9f03 100644 --- a/api-reference/rest-apis/v2/organizations/update-organization-disable-state.mdx +++ b/api-reference/rest-apis/v2/organizations/update-organization-disable-state.mdx @@ -1,5 +1,6 @@ --- -title: "Update Disabled State for Organizations" +title: "Update Organization Disabled State" +description: "Enable or disable access for one or more organizations in a Velt workspace using the v2 REST API to restrict or restore Velt features." api: "POST https://api.velt.dev/v2/organizations/access/disablestate/update" --- diff --git a/api-reference/rest-apis/v2/organizations/update-organizations.mdx b/api-reference/rest-apis/v2/organizations/update-organizations.mdx index 442cdcfc5..08a03549d 100644 --- a/api-reference/rest-apis/v2/organizations/update-organizations.mdx +++ b/api-reference/rest-apis/v2/organizations/update-organizations.mdx @@ -1,5 +1,6 @@ --- title: "Update Organizations" +description: "Update metadata for one or more organizations in a Velt workspace using the v2 REST API, including names, descriptions, and custom organization fields." api: "POST https://api.velt.dev/v2/organizations/update" --- diff --git a/api-reference/rest-apis/v2/presence/add-presence.mdx b/api-reference/rest-apis/v2/presence/add-presence.mdx index a2cb30f71..578c061d1 100644 --- a/api-reference/rest-apis/v2/presence/add-presence.mdx +++ b/api-reference/rest-apis/v2/presence/add-presence.mdx @@ -1,5 +1,6 @@ --- title: "Add Presence" +description: "Add users to the presence list for a document within an organization using the Velt v2 REST API to show who is currently active or viewing." api: "POST https://api.velt.dev/v2/presence/add" --- diff --git a/api-reference/rest-apis/v2/presence/delete-presence.mdx b/api-reference/rest-apis/v2/presence/delete-presence.mdx index 209a9d0c6..35c2b5483 100644 --- a/api-reference/rest-apis/v2/presence/delete-presence.mdx +++ b/api-reference/rest-apis/v2/presence/delete-presence.mdx @@ -1,5 +1,6 @@ --- title: "Delete Presence" +description: "Remove users from the presence list for a document within an organization using the Velt v2 REST API to update who appears as active." api: "POST https://api.velt.dev/v2/presence/delete" --- diff --git a/api-reference/rest-apis/v2/presence/update-presence.mdx b/api-reference/rest-apis/v2/presence/update-presence.mdx index 19629c58d..16e9ce499 100644 --- a/api-reference/rest-apis/v2/presence/update-presence.mdx +++ b/api-reference/rest-apis/v2/presence/update-presence.mdx @@ -1,5 +1,6 @@ --- title: "Update Presence" +description: "Update presence data for existing users on a document within an organization using the Velt v2 REST API, including status, metadata, and timestamps." api: "POST https://api.velt.dev/v2/presence/update" --- diff --git a/api-reference/rest-apis/v2/recordings/get-recordings.mdx b/api-reference/rest-apis/v2/recordings/get-recordings.mdx index a94ee95a6..569ea634b 100644 --- a/api-reference/rest-apis/v2/recordings/get-recordings.mdx +++ b/api-reference/rest-apis/v2/recordings/get-recordings.mdx @@ -1,5 +1,6 @@ --- title: "Get Recordings" +description: "Retrieve recording annotations for a document or organization with the Velt v2 REST API, with optional filtering by recording ID and pagination." api: "POST https://api.velt.dev/v2/recordings/get" --- diff --git a/api-reference/rest-apis/v2/rewriter/ask-ai.mdx b/api-reference/rest-apis/v2/rewriter/ask-ai.mdx index 8f27c3f79..fce1a1206 100644 --- a/api-reference/rest-apis/v2/rewriter/ask-ai.mdx +++ b/api-reference/rest-apis/v2/rewriter/ask-ai.mdx @@ -1,5 +1,6 @@ --- -title: "Ask AI" +title: "Ask AI Rewriter" +description: "Send a text rewriting or processing prompt to an AI model through the Velt v2 REST API; the model provider is resolved from the model name prefix." api: "POST https://api.velt.dev/v2/rewriter/ask-ai" --- diff --git a/api-reference/rest-apis/v2/user-groups/add-groups.mdx b/api-reference/rest-apis/v2/user-groups/add-groups.mdx index a72210c4c..7946f0e03 100644 --- a/api-reference/rest-apis/v2/user-groups/add-groups.mdx +++ b/api-reference/rest-apis/v2/user-groups/add-groups.mdx @@ -1,5 +1,6 @@ --- title: "Add User Groups" +description: "Create organization user groups in a Velt workspace using the v2 REST API, including group IDs and metadata for permission and notification routing." api: "POST https://api.velt.dev/v2/organizations/usergroups/add" --- diff --git a/api-reference/rest-apis/v2/user-groups/add-users-to-group.mdx b/api-reference/rest-apis/v2/user-groups/add-users-to-group.mdx index 9154b28d9..1905e4ddc 100644 --- a/api-reference/rest-apis/v2/user-groups/add-users-to-group.mdx +++ b/api-reference/rest-apis/v2/user-groups/add-users-to-group.mdx @@ -1,5 +1,6 @@ --- title: "Add Users to Groups" +description: "Add one or more users to an organization user group in a Velt workspace using the v2 REST API to manage group membership and access scopes." api: "POST https://api.velt.dev/v2/organizations/usergroups/users/add" --- diff --git a/api-reference/rest-apis/v2/user-groups/delete-users-from-group.mdx b/api-reference/rest-apis/v2/user-groups/delete-users-from-group.mdx index dd49853d1..89d28febe 100644 --- a/api-reference/rest-apis/v2/user-groups/delete-users-from-group.mdx +++ b/api-reference/rest-apis/v2/user-groups/delete-users-from-group.mdx @@ -1,5 +1,6 @@ --- title: "Delete Users from Groups" +description: "Remove one or more users from an organization user group in a Velt workspace using the v2 REST API to revoke group membership and access." api: "POST https://api.velt.dev/v2/organizations/usergroups/users/delete" --- diff --git a/api-reference/rest-apis/v2/users/add-users.mdx b/api-reference/rest-apis/v2/users/add-users.mdx index f3dd94163..068affc48 100644 --- a/api-reference/rest-apis/v2/users/add-users.mdx +++ b/api-reference/rest-apis/v2/users/add-users.mdx @@ -1,5 +1,6 @@ --- title: "Add Users" +description: "Add users to an organization, document, or folder in a Velt workspace using the v2 REST API, including user IDs, names, and custom metadata." api: "POST https://api.velt.dev/v2/users/add" --- diff --git a/api-reference/rest-apis/v2/users/delete-users.mdx b/api-reference/rest-apis/v2/users/delete-users.mdx index 9702635fd..cad00e8fd 100644 --- a/api-reference/rest-apis/v2/users/delete-users.mdx +++ b/api-reference/rest-apis/v2/users/delete-users.mdx @@ -1,6 +1,6 @@ --- title: "Delete Users" -description: "Remove Users from an Organization or a Document." +description: "Remove users from an organization, document, or folder in a Velt workspace using the v2 REST API, with support for filtering by user IDs and scope." api: "POST https://api.velt.dev/v2/users/delete" --- diff --git a/api-reference/rest-apis/v2/users/get-users-v2.mdx b/api-reference/rest-apis/v2/users/get-users-v2.mdx index 15819d63a..314857574 100644 --- a/api-reference/rest-apis/v2/users/get-users-v2.mdx +++ b/api-reference/rest-apis/v2/users/get-users-v2.mdx @@ -1,5 +1,6 @@ --- title: "Get Users" +description: "Retrieve users from a Velt workspace using the v2 REST API with filters by organization ID, document ID, user group IDs, or user IDs." api: "POST https://api.velt.dev/v2/users/get" --- diff --git a/api-reference/rest-apis/v2/users/update-users.mdx b/api-reference/rest-apis/v2/users/update-users.mdx index 3ce1a9a45..937465082 100644 --- a/api-reference/rest-apis/v2/users/update-users.mdx +++ b/api-reference/rest-apis/v2/users/update-users.mdx @@ -1,5 +1,6 @@ --- title: "Update Users" +description: "Update user metadata in a Velt workspace using the v2 REST API, filtering by organization ID, document ID, folder ID, or user IDs." api: "POST https://api.velt.dev/v2/users/update" --- diff --git a/api-reference/rest-apis/v2/workspace/activityconfig-get.mdx b/api-reference/rest-apis/v2/workspace/activityconfig-get.mdx index 30d0629e6..49bdd50e1 100644 --- a/api-reference/rest-apis/v2/workspace/activityconfig-get.mdx +++ b/api-reference/rest-apis/v2/workspace/activityconfig-get.mdx @@ -1,5 +1,6 @@ --- title: "Get Activity Config" +description: "Retrieve the current activity logs configuration for a Velt workspace using the v2 REST API, including enabled state, retention, and service settings." api: "POST https://api.velt.dev/v2/workspace/activityconfig/get" --- diff --git a/api-reference/rest-apis/v2/workspace/activityconfig-update.mdx b/api-reference/rest-apis/v2/workspace/activityconfig-update.mdx index 0c2a21623..59746ae21 100644 --- a/api-reference/rest-apis/v2/workspace/activityconfig-update.mdx +++ b/api-reference/rest-apis/v2/workspace/activityconfig-update.mdx @@ -1,5 +1,6 @@ --- title: "Update Activity Config" +description: "Update the activity logs configuration for a Velt workspace using the v2 REST API; the config is deep-merged so omitted sub-fields are preserved." api: "POST https://api.velt.dev/v2/workspace/activityconfig/update" --- diff --git a/api-reference/rest-apis/v2/workspace/add-domain.mdx b/api-reference/rest-apis/v2/workspace/add-domain.mdx index 65b236d5f..45f75780c 100644 --- a/api-reference/rest-apis/v2/workspace/add-domain.mdx +++ b/api-reference/rest-apis/v2/workspace/add-domain.mdx @@ -1,5 +1,6 @@ --- -title: "Add Domains" +title: "Add Allowed Domains" +description: "Add one or more domains to the allowed domains list for a Velt workspace using the v2 REST API to control which origins can use your API keys." api: "POST https://api.velt.dev/v2/workspace/domains/add" --- diff --git a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-create.mdx b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-create.mdx index b1c3d2cd5..a6b5d65f6 100644 --- a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-create.mdx +++ b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-create.mdx @@ -1,5 +1,6 @@ --- title: "Create Advanced Webhook Endpoint" +description: "Create a new advanced webhook delivery endpoint in a Velt workspace using the v2 REST API to receive event payloads at your destination URL." api: "POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/create" --- diff --git a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-delete.mdx b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-delete.mdx index 2a4a43da0..c8e61a2e4 100644 --- a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-delete.mdx +++ b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-delete.mdx @@ -1,5 +1,6 @@ --- title: "Delete Advanced Webhook Endpoint" +description: "Delete an advanced webhook delivery endpoint from a Velt workspace using the v2 REST API to stop receiving event payloads at that destination URL." api: "POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/delete" --- diff --git a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-get.mdx b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-get.mdx index bbde3da27..4c1c2ac01 100644 --- a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-get.mdx +++ b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-get.mdx @@ -1,5 +1,6 @@ --- title: "Get Advanced Webhook Endpoints" +description: "List the advanced webhook delivery endpoints configured for a Velt workspace using the v2 REST API, with pagination via an opaque iterator cursor." api: "POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/get" --- diff --git a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-secret-get.mdx b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-secret-get.mdx index aa7e9b927..2d5219a6a 100644 --- a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-secret-get.mdx +++ b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-secret-get.mdx @@ -1,5 +1,6 @@ --- title: "Get Advanced Webhook Endpoint Secret" +description: "Retrieve the signing secret for a Velt v2 advanced webhook endpoint so you can verify the signature of webhook payloads delivered to your service." api: "POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/secret/get" --- diff --git a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-update.mdx b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-update.mdx index 43438920d..9f078e2a4 100644 --- a/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-update.mdx +++ b/api-reference/rest-apis/v2/workspace/advancedwebhook-endpoints-update.mdx @@ -1,5 +1,6 @@ --- title: "Update Advanced Webhook Endpoint" +description: "Update an existing advanced webhook delivery endpoint in a Velt workspace via the v2 REST API; at least one field besides endpointId must be provided." api: "POST https://api.velt.dev/v2/workspace/advancedwebhook/endpoints/update" --- diff --git a/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-get.mdx b/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-get.mdx index 9b32e6e19..e59adf9fc 100644 --- a/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-get.mdx +++ b/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-get.mdx @@ -1,5 +1,6 @@ --- title: "Get Advanced Webhook Config" +description: "Retrieve the advanced webhook configuration for a Velt workspace using the v2 REST API, including enable state, encryption, and data protection flags." api: "POST https://api.velt.dev/v2/workspace/advancedwebhookconfig/get" --- diff --git a/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-update.mdx b/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-update.mdx index 401b30251..4802ecd7a 100644 --- a/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-update.mdx +++ b/api-reference/rest-apis/v2/workspace/advancedwebhookconfig-update.mdx @@ -1,5 +1,6 @@ --- title: "Update Advanced Webhook Config" +description: "Update the advanced webhook configuration for a Velt workspace via the v2 REST API, toggling enable state, encryption, encoding, and data protection." api: "POST https://api.velt.dev/v2/workspace/advancedwebhookconfig/update" --- diff --git a/api-reference/rest-apis/v2/workspace/apikey-create.mdx b/api-reference/rest-apis/v2/workspace/apikey-create.mdx index 926108101..70392fb8d 100644 --- a/api-reference/rest-apis/v2/workspace/apikey-create.mdx +++ b/api-reference/rest-apis/v2/workspace/apikey-create.mdx @@ -1,5 +1,6 @@ --- title: "Create API Key" +description: "Create a new API key for a Velt workspace using the v2 REST API, returning the key value and associated auth token for client and server use." api: "POST https://api.velt.dev/v2/workspace/apikey/create" --- diff --git a/api-reference/rest-apis/v2/workspace/apikey-update.mdx b/api-reference/rest-apis/v2/workspace/apikey-update.mdx index bb80d56a5..28d5e505d 100644 --- a/api-reference/rest-apis/v2/workspace/apikey-update.mdx +++ b/api-reference/rest-apis/v2/workspace/apikey-update.mdx @@ -1,5 +1,6 @@ --- title: "Update API Key" +description: "Update the display name of an existing Velt workspace API key using the v2 REST API to keep keys organized across environments and projects." api: "POST https://api.velt.dev/v2/workspace/apikey/update" --- diff --git a/api-reference/rest-apis/v2/workspace/apikeyconfig-get.mdx b/api-reference/rest-apis/v2/workspace/apikeyconfig-get.mdx index 8cb4b58f8..7c57c4f05 100644 --- a/api-reference/rest-apis/v2/workspace/apikeyconfig-get.mdx +++ b/api-reference/rest-apis/v2/workspace/apikeyconfig-get.mdx @@ -1,5 +1,6 @@ --- title: "Get API Key Config" +description: "Retrieve the app configuration for a Velt v2 workspace API key: owner email, plan info, default document access, JWT and auto-org-user toggles." api: "POST https://api.velt.dev/v2/workspace/apikeyconfig/get" --- diff --git a/api-reference/rest-apis/v2/workspace/apikeyconfig-update.mdx b/api-reference/rest-apis/v2/workspace/apikeyconfig-update.mdx index bb8d9e331..fea080a06 100644 --- a/api-reference/rest-apis/v2/workspace/apikeyconfig-update.mdx +++ b/api-reference/rest-apis/v2/workspace/apikeyconfig-update.mdx @@ -1,5 +1,6 @@ --- title: "Update API Key Config" +description: "Update the app configuration for a Velt v2 workspace API key with field-merge semantics; every field is optional but at least one must be provided." api: "POST https://api.velt.dev/v2/workspace/apikeyconfig/update" --- diff --git a/api-reference/rest-apis/v2/workspace/apikeys-get.mdx b/api-reference/rest-apis/v2/workspace/apikeys-get.mdx index 91b7c77f4..a646ff615 100644 --- a/api-reference/rest-apis/v2/workspace/apikeys-get.mdx +++ b/api-reference/rest-apis/v2/workspace/apikeys-get.mdx @@ -1,5 +1,6 @@ --- title: "Get API Keys" +description: "Retrieve the list of API keys configured for a Velt workspace using the v2 REST API, including key IDs, names, and associated metadata for auditing." api: "POST https://api.velt.dev/v2/workspace/apikeys/get" --- diff --git a/api-reference/rest-apis/v2/workspace/authtoken-reset.mdx b/api-reference/rest-apis/v2/workspace/authtoken-reset.mdx index 545d81e28..67446ed32 100644 --- a/api-reference/rest-apis/v2/workspace/authtoken-reset.mdx +++ b/api-reference/rest-apis/v2/workspace/authtoken-reset.mdx @@ -1,5 +1,6 @@ --- title: "Reset Auth Token" +description: "Reset the auth token associated with a specific Velt workspace API key using the v2 REST API to rotate credentials and revoke compromised tokens." api: "POST https://api.velt.dev/v2/workspace/authtoken/reset" --- diff --git a/api-reference/rest-apis/v2/workspace/authtokens-get.mdx b/api-reference/rest-apis/v2/workspace/authtokens-get.mdx index 294425890..1797f8c4b 100644 --- a/api-reference/rest-apis/v2/workspace/authtokens-get.mdx +++ b/api-reference/rest-apis/v2/workspace/authtokens-get.mdx @@ -1,5 +1,6 @@ --- title: "Get Auth Tokens" +description: "Retrieve all auth tokens associated with a specific Velt workspace API key using the v2 REST API for credential auditing and key management." api: "POST https://api.velt.dev/v2/workspace/authtokens/get" --- diff --git a/api-reference/rest-apis/v2/workspace/create.mdx b/api-reference/rest-apis/v2/workspace/create.mdx index f29728ce9..1e7e997f5 100644 --- a/api-reference/rest-apis/v2/workspace/create.mdx +++ b/api-reference/rest-apis/v2/workspace/create.mdx @@ -1,5 +1,6 @@ --- title: "Create Workspace" +description: "Programmatically create a new Velt workspace via the v2 REST API; protected by IP-based rate limiting and disposable email domain blocking." api: "POST https://api.velt.dev/v2/workspace/create" --- diff --git a/api-reference/rest-apis/v2/workspace/delete-domain.mdx b/api-reference/rest-apis/v2/workspace/delete-domain.mdx index fa74b52ab..8cba1e6d5 100644 --- a/api-reference/rest-apis/v2/workspace/delete-domain.mdx +++ b/api-reference/rest-apis/v2/workspace/delete-domain.mdx @@ -1,5 +1,6 @@ --- -title: "Delete Domains" +title: "Delete Allowed Domains" +description: "Remove domains from a Velt workspace's allowed origins list using the v2 REST API to revoke origins permitted to use your API keys in the browser." api: "POST https://api.velt.dev/v2/workspace/domains/delete" --- diff --git a/api-reference/rest-apis/v2/workspace/domains-get.mdx b/api-reference/rest-apis/v2/workspace/domains-get.mdx index 4aa716cbd..8c1ab0bc6 100644 --- a/api-reference/rest-apis/v2/workspace/domains-get.mdx +++ b/api-reference/rest-apis/v2/workspace/domains-get.mdx @@ -1,5 +1,6 @@ --- -title: "Get Domains" +title: "Get Allowed Domains" +description: "Retrieve the list of allowed domains configured for a Velt workspace using the v2 REST API to review which origins can use your API keys." api: "POST https://api.velt.dev/v2/workspace/domains/get" --- diff --git a/api-reference/rest-apis/v2/workspace/email-status.mdx b/api-reference/rest-apis/v2/workspace/email-status.mdx index db22e6074..4bb247ae5 100644 --- a/api-reference/rest-apis/v2/workspace/email-status.mdx +++ b/api-reference/rest-apis/v2/workspace/email-status.mdx @@ -1,5 +1,6 @@ --- title: "Get Email Verification Status" +description: "Check whether a given email address has been verified for Velt workspace ownership using the v2 REST API as part of the workspace signup flow." api: "POST https://api.velt.dev/v2/workspace/email/status" --- diff --git a/api-reference/rest-apis/v2/workspace/emailconfig-get.mdx b/api-reference/rest-apis/v2/workspace/emailconfig-get.mdx index 0605562c6..12659452a 100644 --- a/api-reference/rest-apis/v2/workspace/emailconfig-get.mdx +++ b/api-reference/rest-apis/v2/workspace/emailconfig-get.mdx @@ -1,5 +1,6 @@ --- title: "Get Email Config" +description: "Retrieve the current email service configuration for a Velt workspace using the v2 REST API, including provider settings and enable state." api: "POST https://api.velt.dev/v2/workspace/emailconfig/get" --- diff --git a/api-reference/rest-apis/v2/workspace/emailconfig-update.mdx b/api-reference/rest-apis/v2/workspace/emailconfig-update.mdx index 329a51b7b..21ff4a0a0 100644 --- a/api-reference/rest-apis/v2/workspace/emailconfig-update.mdx +++ b/api-reference/rest-apis/v2/workspace/emailconfig-update.mdx @@ -1,5 +1,6 @@ --- title: "Update Email Config" +description: "Update the email service configuration for a Velt workspace using the v2 REST API; at least one of useEmailService or emailServiceConfig must be provided." api: "POST https://api.velt.dev/v2/workspace/emailconfig/update" --- diff --git a/api-reference/rest-apis/v2/workspace/get.mdx b/api-reference/rest-apis/v2/workspace/get.mdx index 4e8cc76f9..b105c3d87 100644 --- a/api-reference/rest-apis/v2/workspace/get.mdx +++ b/api-reference/rest-apis/v2/workspace/get.mdx @@ -1,5 +1,6 @@ --- title: "Get Workspace" +description: "Retrieve details of an existing Velt workspace using the v2 REST API, including workspace metadata, owner info, plan, and configuration summary." api: "POST https://api.velt.dev/v2/workspace/get" --- diff --git a/api-reference/rest-apis/v2/workspace/notificationconfig-get.mdx b/api-reference/rest-apis/v2/workspace/notificationconfig-get.mdx index 762cb568c..fa27383b6 100644 --- a/api-reference/rest-apis/v2/workspace/notificationconfig-get.mdx +++ b/api-reference/rest-apis/v2/workspace/notificationconfig-get.mdx @@ -1,5 +1,6 @@ --- title: "Get Notification Config" +description: "Retrieve the current in-app notification service configuration for a Velt workspace using the v2 REST API, including enable state and service settings." api: "POST https://api.velt.dev/v2/workspace/notificationconfig/get" --- diff --git a/api-reference/rest-apis/v2/workspace/notificationconfig-update.mdx b/api-reference/rest-apis/v2/workspace/notificationconfig-update.mdx index b4f345e5e..8713cab41 100644 --- a/api-reference/rest-apis/v2/workspace/notificationconfig-update.mdx +++ b/api-reference/rest-apis/v2/workspace/notificationconfig-update.mdx @@ -1,5 +1,6 @@ --- title: "Update Notification Config" +description: "Update the in-app notification service configuration for a Velt workspace via the v2 REST API; the config is deep-merged so omitted sub-fields are preserved." api: "POST https://api.velt.dev/v2/workspace/notificationconfig/update" --- diff --git a/api-reference/rest-apis/v2/workspace/permissionproviderconfig-get.mdx b/api-reference/rest-apis/v2/workspace/permissionproviderconfig-get.mdx index 41ee0f636..55396f7c9 100644 --- a/api-reference/rest-apis/v2/workspace/permissionproviderconfig-get.mdx +++ b/api-reference/rest-apis/v2/workspace/permissionproviderconfig-get.mdx @@ -1,5 +1,6 @@ --- title: "Get Permission Provider Config" +description: "Retrieve the current permission provider configuration for a Velt workspace using the v2 REST API, including provider URL, auth token, and enable state." api: "POST https://api.velt.dev/v2/workspace/permissionproviderconfig/get" --- diff --git a/api-reference/rest-apis/v2/workspace/permissionproviderconfig-update.mdx b/api-reference/rest-apis/v2/workspace/permissionproviderconfig-update.mdx index 3e9da9e70..ff161fd80 100644 --- a/api-reference/rest-apis/v2/workspace/permissionproviderconfig-update.mdx +++ b/api-reference/rest-apis/v2/workspace/permissionproviderconfig-update.mdx @@ -1,5 +1,6 @@ --- title: "Update Permission Provider Config" +description: "Update the permission provider configuration for a Velt workspace via the v2 REST API; the config is merged so existing values like authToken are preserved." api: "POST https://api.velt.dev/v2/workspace/permissionproviderconfig/update" --- diff --git a/api-reference/rest-apis/v2/workspace/send-login-link.mdx b/api-reference/rest-apis/v2/workspace/send-login-link.mdx index 9f97eb658..2c9fb4bae 100644 --- a/api-reference/rest-apis/v2/workspace/send-login-link.mdx +++ b/api-reference/rest-apis/v2/workspace/send-login-link.mdx @@ -1,5 +1,6 @@ --- title: "Send Login Link" +description: "Send a magic login link to a Velt workspace owner's email address using the v2 REST API to authenticate access to the Velt console without a password." api: "POST https://api.velt.dev/v2/workspace/email/send-login-link" --- diff --git a/api-reference/rest-apis/v2/workspace/webhookconfig-get.mdx b/api-reference/rest-apis/v2/workspace/webhookconfig-get.mdx index 34f201bc9..23224a85b 100644 --- a/api-reference/rest-apis/v2/workspace/webhookconfig-get.mdx +++ b/api-reference/rest-apis/v2/workspace/webhookconfig-get.mdx @@ -1,5 +1,6 @@ --- title: "Get Webhook Config" +description: "Retrieve the current webhook service configuration for a Velt workspace using the v2 REST API, including endpoint URL, enable state, and event settings." api: "POST https://api.velt.dev/v2/workspace/webhookconfig/get" --- diff --git a/api-reference/rest-apis/v2/workspace/webhookconfig-update.mdx b/api-reference/rest-apis/v2/workspace/webhookconfig-update.mdx index e14349c86..3f84526f8 100644 --- a/api-reference/rest-apis/v2/workspace/webhookconfig-update.mdx +++ b/api-reference/rest-apis/v2/workspace/webhookconfig-update.mdx @@ -1,5 +1,6 @@ --- title: "Update Webhook Config" +description: "Update the webhook service configuration for a Velt workspace using the v2 REST API; at least one of useWebhookService or webhookServiceConfig is required." api: "POST https://api.velt.dev/v2/workspace/webhookconfig/update" --- diff --git a/api-reference/sdk/api/api-methods.mdx b/api-reference/sdk/api/api-methods.mdx index 736b9f196..bf2b641b3 100644 --- a/api-reference/sdk/api/api-methods.mdx +++ b/api-reference/sdk/api/api-methods.mdx @@ -1,5 +1,6 @@ --- -title : "API Methods Index" +title: "API Methods Index" +description: "Complete index of Velt SDK API methods for comments, presence, notifications, cursors, recordings, and more, with links to docs and React hooks." --- # Comments diff --git a/api-reference/sdk/api/react-hooks.mdx b/api-reference/sdk/api/react-hooks.mdx index d3926e2ee..950764aca 100644 --- a/api-reference/sdk/api/react-hooks.mdx +++ b/api-reference/sdk/api/react-hooks.mdx @@ -1,5 +1,6 @@ --- title: "React Hooks Index" +description: "Complete index of Velt SDK React hooks for comments, presence, notifications, cursors, recordings, and more, with links to docs and API methods." --- # Comments diff --git a/api-reference/sdk/models/data-models.mdx b/api-reference/sdk/models/data-models.mdx index bdc338fc5..db43e9fe7 100644 --- a/api-reference/sdk/models/data-models.mdx +++ b/api-reference/sdk/models/data-models.mdx @@ -1,3 +1,8 @@ +--- +title: "Data Models Index" +description: "Reference for Velt SDK data models including CommentAnnotation, Comment, User, request and event types used across comments, presence, and notifications." +--- + # Comments ### Threads diff --git a/async-collaboration/activity/customize-behavior.mdx b/async-collaboration/activity/customize-behavior.mdx index a0fc209d2..a548bf221 100644 --- a/async-collaboration/activity/customize-behavior.mdx +++ b/async-collaboration/activity/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Activity Logs behavior" +description: "Customize Velt Activity Logs with subscription filters by document, feature type, and action type, plus options to scope feeds and render custom timelines." --- #### getAllActivities diff --git a/async-collaboration/activity/overview.mdx b/async-collaboration/activity/overview.mdx index 5cfe6b079..8411f2f27 100644 --- a/async-collaboration/activity/overview.mdx +++ b/async-collaboration/activity/overview.mdx @@ -1,6 +1,7 @@ --- title: "Activity Logs" sidebarTitle: "Overview" +description: "Track every collaboration event with real-time activity logs for comments, reactions, edits, and custom events across your product in one unified timeline." --- Every collaboration event in your app, every comment, approval, edit, and review, generates a question someone eventually asks: "Who did what, and when?" Activity Logs gives you a complete, real-time record of everything that happens across your product. diff --git a/async-collaboration/activity/setup.mdx b/async-collaboration/activity/setup.mdx index f6ae08ca8..f2f7007e2 100644 --- a/async-collaboration/activity/setup.mdx +++ b/async-collaboration/activity/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Activity Logs setup" +description: "Install and configure Velt Activity Logs to render a filterable timeline component, emit custom activity records, and stream real-time event feeds in your app." --- diff --git a/async-collaboration/arrows/customize-behavior.mdx b/async-collaboration/arrows/customize-behavior.mdx index 67009834d..6f2433581 100644 --- a/async-collaboration/arrows/customize-behavior.mdx +++ b/async-collaboration/arrows/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Arrows behavior" +description: "Configure Velt Arrows with allowed element IDs, custom containers, and Arrow Element APIs to control where and how arrow annotations can be placed." --- diff --git a/async-collaboration/arrows/overview.mdx b/async-collaboration/arrows/overview.mdx index 5f5139c4d..2de6d19c1 100644 --- a/async-collaboration/arrows/overview.mdx +++ b/async-collaboration/arrows/overview.mdx @@ -1,6 +1,7 @@ --- title: "Arrows" sidebarTitle: "Overview" +description: "Add interactive arrow annotations that let users point, highlight, and direct attention to specific elements in your app for clearer async collaboration." --- diff --git a/async-collaboration/arrows/setup.mdx b/async-collaboration/arrows/setup.mdx index 4bfbecc6e..569f53dc4 100644 --- a/async-collaboration/arrows/setup.mdx +++ b/async-collaboration/arrows/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Arrows setup" +description: "Install Velt Arrows by adding the VeltArrows and VeltArrowTool components to your React, Next.js, or HTML app to enable visual pointer annotations." --- diff --git a/async-collaboration/comments-sidebar/overview.mdx b/async-collaboration/comments-sidebar/overview.mdx index 9ca7fd0fb..93846ffa2 100644 --- a/async-collaboration/comments-sidebar/overview.mdx +++ b/async-collaboration/comments-sidebar/overview.mdx @@ -1,7 +1,7 @@ --- title: "Comments Sidebar" sidebarTitle: "Overview" -description: "Provide a toggleable sidebar to view and filter comments." +description: "Add a toggleable Comments Sidebar to view, filter, sort, and search all comments across your app with built-in components for opening and managing threads." --- The Velt SDK contains 4 components that can be used to control the Comments Sidebar functionality: diff --git a/async-collaboration/comments-sidebar/v1/customize-behavior.mdx b/async-collaboration/comments-sidebar/v1/customize-behavior.mdx index 520c3f4e0..0d5992f8b 100644 --- a/async-collaboration/comments-sidebar/v1/customize-behavior.mdx +++ b/async-collaboration/comments-sidebar/v1/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Comments Sidebar V1 behavior" +description: "Customize the V1 Comments Sidebar with filters, sorting, grouping, custom actions, lifecycle events, and wireframe overrides to tailor the comments panel." --- # Custom filtering, sorting and grouping diff --git a/async-collaboration/comments-sidebar/v1/setup.mdx b/async-collaboration/comments-sidebar/v1/setup.mdx index 53fb7595c..deb4c17bf 100644 --- a/async-collaboration/comments-sidebar/v1/setup.mdx +++ b/async-collaboration/comments-sidebar/v1/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Comments Sidebar V1 setup" +description: "Install the V1 Comments Sidebar by adding VeltCommentsSidebar, VeltSidebarButton, and VeltCommentTool components to surface comment threads in your app." --- diff --git a/async-collaboration/comments-sidebar/v2/customize-behavior.mdx b/async-collaboration/comments-sidebar/v2/customize-behavior.mdx index 661610afb..6ec2eced9 100644 --- a/async-collaboration/comments-sidebar/v2/customize-behavior.mdx +++ b/async-collaboration/comments-sidebar/v2/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Comments Sidebar V2 behavior" +description: "Configure the V2 Comments Sidebar with declarative filters, mini filters, sort, group, and search inputs plus client-side filter APIs for full control." --- # Filtering diff --git a/async-collaboration/comments-sidebar/v2/setup.mdx b/async-collaboration/comments-sidebar/v2/setup.mdx index 31b3be6af..87771f83c 100644 --- a/async-collaboration/comments-sidebar/v2/setup.mdx +++ b/async-collaboration/comments-sidebar/v2/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Comments Sidebar V2 setup" +description: "Install the V2 primitive-based Comments Sidebar with VeltCommentsSidebarV2 for a customizable, composable comments panel in React, Next.js, and HTML." --- The V2 sidebar is a fully primitive-based implementation. Import `VeltCommentsSidebarV2` directly to use it. diff --git a/async-collaboration/comments/customize-behavior.mdx b/async-collaboration/comments/customize-behavior.mdx index 6d7b13b5e..fd6fab820 100644 --- a/async-collaboration/comments/customize-behavior.mdx +++ b/async-collaboration/comments/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Comments behavior" +description: "Customize Velt Comments with APIs to add, edit, delete annotations, manage threads, replies, mentions, statuses, priorities, and assignees programmatically." --- # Threads diff --git a/async-collaboration/comments/notifications.mdx b/async-collaboration/comments/notifications.mdx index 4b05d582b..9ea09d957 100644 --- a/async-collaboration/comments/notifications.mdx +++ b/async-collaboration/comments/notifications.mdx @@ -1,6 +1,6 @@ --- title: "Notifications" -description: "There are several options to send notifications to your users." +description: "Send comment notifications to users via in-app banners, email digests, and webhooks to channels like Slack to keep collaborators informed of new activity." --- There are three ways to send notifications to your users: diff --git a/async-collaboration/comments/overview.mdx b/async-collaboration/comments/overview.mdx index 4404a479c..f02cedbfd 100644 --- a/async-collaboration/comments/overview.mdx +++ b/async-collaboration/comments/overview.mdx @@ -1,7 +1,7 @@ --- title: "Comments" sidebarTitle: "Overview" -description: "Your users can add comments in context to ask questions, leave feedback, report bugs etc. We handle all complexity to ensure the comments are robust against content changes. We support many types of comment UX patterns as illustrated below." +description: "Add in-context comments, replies, mentions, and annotations to any app with support for freestyle pins, area comments, inline text, and more UX patterns." --- diff --git a/async-collaboration/comments/setup/ace.mdx b/async-collaboration/comments/setup/ace.mdx index e62fc3cfe..903683082 100644 --- a/async-collaboration/comments/setup/ace.mdx +++ b/async-collaboration/comments/setup/ace.mdx @@ -1,5 +1,6 @@ --- -title: "Ace Editor Setup" +title: "Ace Editor comments setup" +description: "Integrate Velt Comments with the Ace code editor to enable inline text comments, mentions, and replies on specific lines or selections of source code." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/apryse.mdx b/async-collaboration/comments/setup/apryse.mdx index f4c52ab80..6e8e23f36 100644 --- a/async-collaboration/comments/setup/apryse.mdx +++ b/async-collaboration/comments/setup/apryse.mdx @@ -1,5 +1,6 @@ --- -title: "Apryse Setup" +title: "Apryse WebViewer comments setup" +description: "Add Velt Comments to the Apryse WebViewer PDF viewer in React to enable in-context annotations, replies, and mentions on PDF documents and pages." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/canvas-comments/overview.mdx b/async-collaboration/comments/setup/canvas-comments/overview.mdx index eae70bb61..cacccdd16 100644 --- a/async-collaboration/comments/setup/canvas-comments/overview.mdx +++ b/async-collaboration/comments/setup/canvas-comments/overview.mdx @@ -1,5 +1,6 @@ --- -title: "Overview" +title: "Canvas and chart comments overview" +description: "Add Velt comment pins to charting libraries and canvas surfaces by manually positioning Comment Pin components using custom metadata and annotation hooks." --- Within any charts library you have the option to manually set the position of a Comment Annotation using the `Comment Pin` component. diff --git a/async-collaboration/comments/setup/canvas.mdx b/async-collaboration/comments/setup/canvas.mdx index 6b34f289d..b27db7d58 100644 --- a/async-collaboration/comments/setup/canvas.mdx +++ b/async-collaboration/comments/setup/canvas.mdx @@ -1,6 +1,6 @@ --- -title: " Comments" -description: Add comments to an HTML Canvas. +title: "HTML Canvas comments setup" +description: "Add Velt comment pins to HTML Canvas elements using VeltCommentPin and the useCommentAnnotations hook to position threads anywhere on a canvas." --- diff --git a/async-collaboration/comments/setup/chart-comments-setup/chartjs.mdx b/async-collaboration/comments/setup/chart-comments-setup/chartjs.mdx index a8b16abbc..fd914819e 100644 --- a/async-collaboration/comments/setup/chart-comments-setup/chartjs.mdx +++ b/async-collaboration/comments/setup/chart-comments-setup/chartjs.mdx @@ -1,5 +1,6 @@ --- -title: "ChartJS Comments Setup" +title: "Chart.js comments setup" +description: "Add Velt Comments to Chart.js bar, line, and pie charts in React with chart-aware comment pins anchored to specific data points and chart elements." --- ![](/gifs/velt-chartjs-barchart.gif) diff --git a/async-collaboration/comments/setup/chart-comments-setup/custom-charts.mdx b/async-collaboration/comments/setup/chart-comments-setup/custom-charts.mdx index 087628a85..688d351c1 100644 --- a/async-collaboration/comments/setup/chart-comments-setup/custom-charts.mdx +++ b/async-collaboration/comments/setup/chart-comments-setup/custom-charts.mdx @@ -1,5 +1,6 @@ --- -title: "Custom Charts Setup" +title: "Custom charts comments setup" +description: "Integrate Velt Comments with any custom charting library by anchoring comment pins to chart data points using the generic Comment Pin approach." --- ![](/gifs/velt-chartjs-barchart.gif) diff --git a/async-collaboration/comments/setup/chart-comments-setup/highcharts.mdx b/async-collaboration/comments/setup/chart-comments-setup/highcharts.mdx index f90be1f8a..c8df33343 100644 --- a/async-collaboration/comments/setup/chart-comments-setup/highcharts.mdx +++ b/async-collaboration/comments/setup/chart-comments-setup/highcharts.mdx @@ -1,5 +1,6 @@ --- -title: Highcharts Comments Setup +title: "Highcharts comments setup" +description: "Add Velt Comments to Highcharts visualizations in React with comment pins anchored to specific data points across bar, column, and line chart types." --- ![](/gifs/Add-Charts-Comments.gif) diff --git a/async-collaboration/comments/setup/chart-comments-setup/nivo-charts.mdx b/async-collaboration/comments/setup/chart-comments-setup/nivo-charts.mdx index 05fed11bd..ffc33ba6e 100644 --- a/async-collaboration/comments/setup/chart-comments-setup/nivo-charts.mdx +++ b/async-collaboration/comments/setup/chart-comments-setup/nivo-charts.mdx @@ -1,5 +1,6 @@ --- -title: NivoCharts Comments Setup +title: "Nivo charts comments setup" +description: "Add Velt Comments to Nivo chart components in React using VeltNivoChartComments to anchor comment pins to specific data points on responsive charts." --- ![](/gifs/Add-Charts-Comments.gif) diff --git a/async-collaboration/comments/setup/ckeditor.mdx b/async-collaboration/comments/setup/ckeditor.mdx index 2627504d9..25c57a52d 100644 --- a/async-collaboration/comments/setup/ckeditor.mdx +++ b/async-collaboration/comments/setup/ckeditor.mdx @@ -1,6 +1,6 @@ --- title: "CKEditor Setup" -description: "Add Velt comments to a CKEditor 5 editor with the Velt CKEditor comments plugin." +description: "Add Velt Comments to a CKEditor 5 editor with the Velt plugin to enable inline text comments, replies, and mentions on rich-text content selections." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/codemirror.mdx b/async-collaboration/comments/setup/codemirror.mdx index d3aa2a08b..042bc8862 100644 --- a/async-collaboration/comments/setup/codemirror.mdx +++ b/async-collaboration/comments/setup/codemirror.mdx @@ -1,5 +1,6 @@ --- -title: "CodeMirror Setup" +title: "CodeMirror comments setup" +description: "Integrate Velt Comments with the CodeMirror editor to enable inline text comments, replies, and mentions on specific lines or selections of code." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/draftjs.mdx b/async-collaboration/comments/setup/draftjs.mdx index f7eebdb77..16540f1ae 100644 --- a/async-collaboration/comments/setup/draftjs.mdx +++ b/async-collaboration/comments/setup/draftjs.mdx @@ -1,5 +1,6 @@ --- -title: "DraftJS Setup" +title: "Draft.js comments setup" +description: "Integrate Velt Comments with the Draft.js rich-text editor to enable inline text comments, mentions, and replies on selected ranges of content." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/freestyle.mdx b/async-collaboration/comments/setup/freestyle.mdx index bb25cfbc1..156247b6f 100644 --- a/async-collaboration/comments/setup/freestyle.mdx +++ b/async-collaboration/comments/setup/freestyle.mdx @@ -1,5 +1,6 @@ --- -title: "Freestyle Setup" +title: "Freestyle comments setup" +description: "Set up Velt Freestyle Comments to let users drop comment pins on any element or draw area annotations anywhere on the page for flexible visual feedback." --- ![](/gifs/Add-Freestyle-Comment.gif) diff --git a/async-collaboration/comments/setup/inline-comments.mdx b/async-collaboration/comments/setup/inline-comments.mdx index cff1716eb..9ec878769 100644 --- a/async-collaboration/comments/setup/inline-comments.mdx +++ b/async-collaboration/comments/setup/inline-comments.mdx @@ -1,5 +1,6 @@ --- -title: "Inline Comments Setup" +title: "Inline comments setup" +description: "Set up Velt inline comments with VeltInlineCommentsSection to anchor threads directly to specific sections, blocks, or DOM elements within your app." --- ![](/gifs/inline-comment.gif) diff --git a/async-collaboration/comments/setup/lexical.mdx b/async-collaboration/comments/setup/lexical.mdx index 9c8c0ef48..1d59d239f 100644 --- a/async-collaboration/comments/setup/lexical.mdx +++ b/async-collaboration/comments/setup/lexical.mdx @@ -1,5 +1,6 @@ --- -title: "Lexical Setup" +title: "Lexical comments setup" +description: "Integrate Velt Comments with the Lexical rich-text editor to enable inline text comments, mentions, and replies on specific selections of editor content." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/lottie-player-setup.mdx b/async-collaboration/comments/setup/lottie-player-setup.mdx index a9ff4239e..bea75b1ac 100644 --- a/async-collaboration/comments/setup/lottie-player-setup.mdx +++ b/async-collaboration/comments/setup/lottie-player-setup.mdx @@ -1,5 +1,6 @@ --- -title: "Lottie Player Setup" +title: "Lottie Player comments setup" +description: "Add Velt Comments to Lottie animation players to anchor comment pins to specific frames or timestamps for visual review and feedback on animations." --- ![](/gifs/Add-Lottie-Comment.gif) diff --git a/async-collaboration/comments/setup/monaco.mdx b/async-collaboration/comments/setup/monaco.mdx index d2a3c4973..23bf57466 100644 --- a/async-collaboration/comments/setup/monaco.mdx +++ b/async-collaboration/comments/setup/monaco.mdx @@ -1,6 +1,6 @@ --- title: "Monaco Setup" -description: "Add Velt text comments to a Monaco editor with the Velt Monaco comments package." +description: "Add Velt text comments to a Monaco code editor with view-only overlay highlights that preserve your model, undo history, and saved source code unchanged." --- ![Add text comments in an editor](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/nutrient.mdx b/async-collaboration/comments/setup/nutrient.mdx index 542c199ec..67b369eee 100644 --- a/async-collaboration/comments/setup/nutrient.mdx +++ b/async-collaboration/comments/setup/nutrient.mdx @@ -1,6 +1,6 @@ --- title: "Nutrient Setup" -description: "Add Velt text comments to a Nutrient Web SDK PDF viewer with the Velt Nutrient comments extension." +description: "Add Velt text comments to a Nutrient Web SDK PDF viewer with view-only CustomOverlayItem highlights that preserve your original PDF document unchanged." --- ![Add text comments in an editor](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/page.mdx b/async-collaboration/comments/setup/page.mdx index 6ced93e39..aaa695a30 100644 --- a/async-collaboration/comments/setup/page.mdx +++ b/async-collaboration/comments/setup/page.mdx @@ -1,5 +1,6 @@ --- -title: "Page Mode Setup" +title: "Page mode comments setup" +description: "Set up Velt Page mode comments to attach a single comment thread to an entire page using the Comments Sidebar without dropping individual pins on elements." --- ![](/gifs/Add-Page-Comments.gif) diff --git a/async-collaboration/comments/setup/plate.mdx b/async-collaboration/comments/setup/plate.mdx index b8f70a237..cec54d62d 100644 --- a/async-collaboration/comments/setup/plate.mdx +++ b/async-collaboration/comments/setup/plate.mdx @@ -1,5 +1,6 @@ --- -title: "Plate Setup" +title: "Plate.js comments setup" +description: "Integrate Velt Comments with the Plate.js React rich-text editor to enable inline text comments, mentions, and replies on specific selections of content." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/popover.mdx b/async-collaboration/comments/setup/popover.mdx index 4b7ea4f32..d1a3487b5 100644 --- a/async-collaboration/comments/setup/popover.mdx +++ b/async-collaboration/comments/setup/popover.mdx @@ -1,5 +1,6 @@ --- -title: "Popover Setup" +title: "Popover comments setup" +description: "Add Velt Comments to specific DOM elements like cells or buttons using VeltCommentBubble and VeltCommentTool to surface threads in a popover UI." --- ![](/gifs/Add-Cell-Comment.gif) diff --git a/async-collaboration/comments/setup/prosemirror.mdx b/async-collaboration/comments/setup/prosemirror.mdx index 70e4b035f..1a1c6283f 100644 --- a/async-collaboration/comments/setup/prosemirror.mdx +++ b/async-collaboration/comments/setup/prosemirror.mdx @@ -1,5 +1,6 @@ --- -title: "ProseMirror Setup" +title: "ProseMirror comments setup" +description: "Integrate Velt Comments with the ProseMirror rich-text editor to enable inline text comments, mentions, and replies on specific selections of editor content." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/quill.mdx b/async-collaboration/comments/setup/quill.mdx index df8a90b63..fd16759cc 100644 --- a/async-collaboration/comments/setup/quill.mdx +++ b/async-collaboration/comments/setup/quill.mdx @@ -1,5 +1,6 @@ --- -title: "Quill Setup" +title: "Quill comments setup" +description: "Integrate Velt Comments with the Quill rich-text editor to enable inline text comments, mentions, and replies on specific selections of editor content." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/slatejs.mdx b/async-collaboration/comments/setup/slatejs.mdx index 998e0c1e8..3f85dec5b 100644 --- a/async-collaboration/comments/setup/slatejs.mdx +++ b/async-collaboration/comments/setup/slatejs.mdx @@ -1,5 +1,6 @@ --- -title: "SlateJS Setup" +title: "Slate.js comments setup" +description: "Integrate Velt Comments with the Slate.js rich-text editor to enable inline text comments, mentions, and replies on specific selections of editor content." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/spreadjs.mdx b/async-collaboration/comments/setup/spreadjs.mdx index 67ed4c5f3..cafb1ce0a 100644 --- a/async-collaboration/comments/setup/spreadjs.mdx +++ b/async-collaboration/comments/setup/spreadjs.mdx @@ -1,6 +1,6 @@ --- title: "SpreadJS Setup" -description: "Add Velt comments to a SpreadJS workbook with the Velt SpreadJS comments extension." +description: "Add Velt comments to a SpreadJS spreadsheet workbook with view-only cell and range overlays that preserve your workbook data and use durable anchors." --- ![Add text comments in a spreadsheet](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/stream.mdx b/async-collaboration/comments/setup/stream.mdx index 204048aa5..4d6631c3c 100644 --- a/async-collaboration/comments/setup/stream.mdx +++ b/async-collaboration/comments/setup/stream.mdx @@ -1,5 +1,6 @@ --- -title: "Stream Setup" +title: "Stream comments setup" +description: "Set up Velt Stream comments to display a continuously scrolling feed of comments anchored to a container, ideal for live chat-style discussions and broadcasts." --- ![](/gifs/View-Stream-Comments.gif) diff --git a/async-collaboration/comments/setup/superdoc.mdx b/async-collaboration/comments/setup/superdoc.mdx index 34487cdc0..7c6789e90 100644 --- a/async-collaboration/comments/setup/superdoc.mdx +++ b/async-collaboration/comments/setup/superdoc.mdx @@ -1,5 +1,6 @@ --- -title: "SuperDoc Setup" +title: "SuperDoc comments setup" +description: "Add Velt text comments to a SuperDoc DOCX editor with view-only overlay highlights and durable text-occurrence anchors that preserve original document content." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/text.mdx b/async-collaboration/comments/setup/text.mdx index 41f3065ea..8022ef7e2 100644 --- a/async-collaboration/comments/setup/text.mdx +++ b/async-collaboration/comments/setup/text.mdx @@ -1,5 +1,6 @@ --- -title: "Text Setup" +title: "Text comments setup" +description: "Set up Velt text comments to let users select and comment on any text content in your app with highlights, replies, and mentions on selected ranges." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/tinymce.mdx b/async-collaboration/comments/setup/tinymce.mdx index 72958213f..eab83d9af 100644 --- a/async-collaboration/comments/setup/tinymce.mdx +++ b/async-collaboration/comments/setup/tinymce.mdx @@ -1,6 +1,6 @@ --- title: "TinyMCE Setup" -description: "Add Velt text comments to a TinyMCE editor with the Velt TinyMCE comments plugin." +description: "Add Velt text comments to a TinyMCE editor with view-only overlay highlights that preserve your TinyMCE content, schema, undo history, and saved HTML." --- ![Add text comments in an editor](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/tiptap.mdx b/async-collaboration/comments/setup/tiptap.mdx index 407a99553..0894645f5 100644 --- a/async-collaboration/comments/setup/tiptap.mdx +++ b/async-collaboration/comments/setup/tiptap.mdx @@ -1,5 +1,6 @@ --- -title: "Tiptap Setup" +title: "Tiptap comments setup" +description: "Integrate Velt Comments with the Tiptap rich-text editor to enable inline text comments, mentions, and replies on specific selections of editor content." --- ![](/gifs/Add-Text-Comments.gif) diff --git a/async-collaboration/comments/setup/video-player-setup/custom-video-player-setup.mdx b/async-collaboration/comments/setup/video-player-setup/custom-video-player-setup.mdx index 2ab96520a..06f8eb8a9 100644 --- a/async-collaboration/comments/setup/video-player-setup/custom-video-player-setup.mdx +++ b/async-collaboration/comments/setup/video-player-setup/custom-video-player-setup.mdx @@ -1,6 +1,6 @@ --- -title: "Custom Video Player Setup" -description: Use this guide to add collaboration into your own custom video player. +title: "Custom video player comments setup" +description: "Add Velt comments and reactions to your own custom video player by integrating VeltComments, VeltCommentTool, and reaction components with playback events." --- ![](/gifs/custom-video-player.gif) diff --git a/async-collaboration/comments/setup/video-player-setup/video-player-setup.mdx b/async-collaboration/comments/setup/video-player-setup/video-player-setup.mdx index a6ef5085c..a3300b455 100644 --- a/async-collaboration/comments/setup/video-player-setup/video-player-setup.mdx +++ b/async-collaboration/comments/setup/video-player-setup/video-player-setup.mdx @@ -1,6 +1,6 @@ --- -title: "Prebuilt Video Player Setup" -description: Use this guide if you want to set up a prebuilt video player from our SDK with collaborative features built in. +title: "Prebuilt video player setup" +description: "Set up the prebuilt VeltVideoPlayer component to add a collaborative video player with built-in time-anchored comments, reactions, and playback controls." --- ![](/gifs/video-comment.gif) diff --git a/async-collaboration/comments/standalone-components/comment-composer/customize-behavior.mdx b/async-collaboration/comments/standalone-components/comment-composer/customize-behavior.mdx index d27e4224c..db7662a1f 100644 --- a/async-collaboration/comments/standalone-components/comment-composer/customize-behavior.mdx +++ b/async-collaboration/comments/standalone-components/comment-composer/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Comment Composer behavior" +description: "Customize the standalone Comment Composer by passing custom context metadata, props from VeltCommentComposerProps, and event handlers for submitted comments." --- For type definitions, see [`VeltCommentComposerProps`](/api-reference/sdk/models/data-models#veltcommentcomposerprops). diff --git a/async-collaboration/comments/standalone-components/comment-composer/overview.mdx b/async-collaboration/comments/standalone-components/comment-composer/overview.mdx index 7b13393b4..36ce00425 100644 --- a/async-collaboration/comments/standalone-components/comment-composer/overview.mdx +++ b/async-collaboration/comments/standalone-components/comment-composer/overview.mdx @@ -1,6 +1,7 @@ --- -title: "Comment Standalone Composer" +title: "Comment Composer" sidebarTitle: "Overview" +description: "Add a standalone Comment Composer anywhere in your app to let users write comments outside the default Velt UI, with full control over placement and context." --- The Comment Standalone Composer enables you to add comments anywhere in your application. It's designed to work seamlessly with other Velt components and APIs: diff --git a/async-collaboration/comments/standalone-components/comment-composer/setup.mdx b/async-collaboration/comments/standalone-components/comment-composer/setup.mdx index 5fcfa1311..79456f490 100644 --- a/async-collaboration/comments/standalone-components/comment-composer/setup.mdx +++ b/async-collaboration/comments/standalone-components/comment-composer/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Comment Composer setup" +description: "Install the standalone VeltCommentComposer component to add a comment-writing UI on hotkey, in a custom sidebar, below articles, or overlaid on images." --- ## Add Comment Composer Component diff --git a/async-collaboration/comments/standalone-components/comment-pin/customize-behavior.mdx b/async-collaboration/comments/standalone-components/comment-pin/customize-behavior.mdx index 108ba5134..d75e64583 100644 --- a/async-collaboration/comments/standalone-components/comment-pin/customize-behavior.mdx +++ b/async-collaboration/comments/standalone-components/comment-pin/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Comment Pin behavior" +description: "Customize the standalone Comment Pin with click event callbacks, custom actions, and event hooks for navigation, analytics, and opening custom comment dialogs." --- ## `commentPinClicked` Event diff --git a/async-collaboration/comments/standalone-components/comment-pin/overview.mdx b/async-collaboration/comments/standalone-components/comment-pin/overview.mdx index 42e03fbbb..2d758bccf 100644 --- a/async-collaboration/comments/standalone-components/comment-pin/overview.mdx +++ b/async-collaboration/comments/standalone-components/comment-pin/overview.mdx @@ -1,6 +1,7 @@ --- title: "Comment Pin" sidebarTitle: "Overview" +description: "Use the standalone Comment Pin component to manually position comment annotations in complex UIs where you need precise control over pin placement and metadata." --- The Comment Pin component allows you to manually set the position of Comment Annotations. diff --git a/async-collaboration/comments/standalone-components/comment-pin/setup.mdx b/async-collaboration/comments/standalone-components/comment-pin/setup.mdx index cef03115c..b34af6ec3 100644 --- a/async-collaboration/comments/standalone-components/comment-pin/setup.mdx +++ b/async-collaboration/comments/standalone-components/comment-pin/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Comment Pin setup" +description: "Set up the standalone VeltCommentPin with onCommentAdd metadata and manual commentType to render and position comment annotations at custom coordinates." --- diff --git a/async-collaboration/comments/standalone-components/comment-thread/customize-behavior.mdx b/async-collaboration/comments/standalone-components/comment-thread/customize-behavior.mdx index 5e344fb33..a8087ca4c 100644 --- a/async-collaboration/comments/standalone-components/comment-thread/customize-behavior.mdx +++ b/async-collaboration/comments/standalone-components/comment-thread/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Comment Thread behavior" +description: "Customize the standalone Comment Thread with onCommentClick callbacks, annotation ID props, and handlers for navigation, context fetching, and state updates." --- ## 1. `onCommentClick` Callback diff --git a/async-collaboration/comments/standalone-components/comment-thread/overview.mdx b/async-collaboration/comments/standalone-components/comment-thread/overview.mdx index 844dd63c4..431b444a2 100644 --- a/async-collaboration/comments/standalone-components/comment-thread/overview.mdx +++ b/async-collaboration/comments/standalone-components/comment-thread/overview.mdx @@ -1,6 +1,7 @@ --- title: "Standalone Comment Thread" sidebarTitle: "Overview" +description: "Render existing comment annotations anywhere with the standalone Comment Thread component to build kanban boards, custom sidebars, and other custom comment UIs." --- - You can use the Standalone Comment Thread component to build things such as: diff --git a/async-collaboration/comments/standalone-components/comment-thread/setup.mdx b/async-collaboration/comments/standalone-components/comment-thread/setup.mdx index 53b3a6090..9c2a74d65 100644 --- a/async-collaboration/comments/standalone-components/comment-thread/setup.mdx +++ b/async-collaboration/comments/standalone-components/comment-thread/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Comment Thread setup" +description: "Set up the standalone VeltCommentThread component using comment annotation IDs from getCommentAnnotations to render individual threads anywhere in your app." --- diff --git a/async-collaboration/notifications/customize-behavior.mdx b/async-collaboration/notifications/customize-behavior.mdx index 77714ee5b..ac434ea65 100644 --- a/async-collaboration/notifications/customize-behavior.mdx +++ b/async-collaboration/notifications/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title : "Customize Behavior" +title: "Customize in-app notifications behavior" +description: "Customize Velt in-app notifications with tab configuration, filtering, custom notification types, and unread counts on the notifications tool and inbox panel." --- # Configuration diff --git a/async-collaboration/notifications/overview.mdx b/async-collaboration/notifications/overview.mdx index e1e140b55..d1a69a268 100644 --- a/async-collaboration/notifications/overview.mdx +++ b/async-collaboration/notifications/overview.mdx @@ -1,6 +1,7 @@ --- -title: "In-app Notifications" +title: "In-app notifications" sidebarTitle: "Overview" +description: "Show in-app notifications for comments, mentions, and custom events with a built-in inbox component that surfaces all collaboration activity in one place." --- By default, the in-app notifications component is connected to Velt's Comments feature. All relevant comment notifications automatically show up here. diff --git a/async-collaboration/notifications/setup.mdx b/async-collaboration/notifications/setup.mdx index 2a6f478a7..d093b183a 100644 --- a/async-collaboration/notifications/setup.mdx +++ b/async-collaboration/notifications/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "In-app notifications setup" +description: "Enable Velt in-app notifications in the console and add the notifications components to your app to surface a real-time inbox of comments, mentions, and events." --- ![](/images/Notification_Dialog_Box.png) diff --git a/async-collaboration/reactions/customize-behavior.mdx b/async-collaboration/reactions/customize-behavior.mdx index 0430c89bb..9663f38a8 100644 --- a/async-collaboration/reactions/customize-behavior.mdx +++ b/async-collaboration/reactions/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize inline reactions behavior" +description: "Customize Velt inline reactions with custom emoji sets, reaction events, URL-based icons, and configurable reaction picker behavior across UI elements." --- ## setCustomReactions diff --git a/async-collaboration/reactions/overview.mdx b/async-collaboration/reactions/overview.mdx index 56c078f47..22089fb6d 100644 --- a/async-collaboration/reactions/overview.mdx +++ b/async-collaboration/reactions/overview.mdx @@ -1,6 +1,7 @@ --- -title: "Inline Reactions" +title: "Inline reactions" sidebarTitle: "Overview" +description: "Let users add emoji reactions to specific UI elements like posts and images with the VeltInlineReactionsSection component for quick emotional feedback." --- This allows users to add emoji reactions to specific parts of your UI (eg: posts, images etc). This is great for quick emotional responses or feedback. diff --git a/async-collaboration/reactions/setup.mdx b/async-collaboration/reactions/setup.mdx index df83188a7..5dfeccc23 100644 --- a/async-collaboration/reactions/setup.mdx +++ b/async-collaboration/reactions/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Inline reactions setup" +description: "Install VeltInlineReactionsSection to add emoji reactions anchored to specific elements like posts, images, and cards in your React, Next.js, or HTML app." --- diff --git a/async-collaboration/recorder/customize-behavior.mdx b/async-collaboration/recorder/customize-behavior.mdx index 036f9615c..66b57eaff 100644 --- a/async-collaboration/recorder/customize-behavior.mdx +++ b/async-collaboration/recorder/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Recorder behavior" +description: "Customize the Velt Recorder with AI transcription toggles, recording controls, pinned notes, and configuration props for audio, video, and screen modes." --- # AI diff --git a/async-collaboration/recorder/overview.mdx b/async-collaboration/recorder/overview.mdx index ba2b85348..386c9d85e 100644 --- a/async-collaboration/recorder/overview.mdx +++ b/async-collaboration/recorder/overview.mdx @@ -1,7 +1,7 @@ --- title: "Recorder" sidebarTitle: "Overview" -description: "The Recorder allows your users to create audio, screen, and video recordings." +description: "Let users record audio, screen, and video notes pinned to specific UI locations with the Velt Recorder, including transcription and playback control panels." --- diff --git a/async-collaboration/recorder/setup.mdx b/async-collaboration/recorder/setup.mdx index 4b9732b83..75b86389d 100644 --- a/async-collaboration/recorder/setup.mdx +++ b/async-collaboration/recorder/setup.mdx @@ -1,3 +1,7 @@ +--- +title: "Recorder setup" +description: "Set up the Velt Recorder by adding VeltRecorderTool with audio, video, screen, or all modes to let users capture and share rich recordings inside your app." +--- diff --git a/async-collaboration/suggestions/overview.mdx b/async-collaboration/suggestions/overview.mdx index f10197330..4010f7c37 100644 --- a/async-collaboration/suggestions/overview.mdx +++ b/async-collaboration/suggestions/overview.mdx @@ -1,6 +1,7 @@ --- title: "Suggestions (Beta)" sidebarTitle: "Suggestions" +description: "Add Google Docs–style suggestion mode to any input, editor, or component so human or AI agent edits become proposed changes that reviewers accept or reject." --- The Suggestions API adds **suggestion mode** to any input, editor, or custom component in your app. When it's on, edits from a human (or an AI agent) aren't written straight to your data — they're captured as proposed changes that a reviewer accepts or rejects from the comment dialog, diff-style, like Google Docs suggestions. On accept, your app applies the change. diff --git a/async-collaboration/view-analytics/customize-behavior.mdx b/async-collaboration/view-analytics/customize-behavior.mdx index 17b731b94..049f8af9f 100644 --- a/async-collaboration/view-analytics/customize-behavior.mdx +++ b/async-collaboration/view-analytics/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title : "Customize Behavior" +title: "Customize View Analytics behavior" +description: "Customize View Analytics with location filters, getUniqueViewsByUser APIs, and hooks like useUniqueViewsByUser to query viewers by document or component." --- ## getUniqueViewsByUser diff --git a/async-collaboration/view-analytics/overview.mdx b/async-collaboration/view-analytics/overview.mdx index 69ea88e74..d95eba7a3 100644 --- a/async-collaboration/view-analytics/overview.mdx +++ b/async-collaboration/view-analytics/overview.mdx @@ -1,6 +1,7 @@ --- title: "View Analytics" sidebarTitle: "Overview" +description: "Show who has viewed a document, page, or specific UI location with built-in View Analytics components that surface unique viewers and engagement insights." --- diff --git a/async-collaboration/view-analytics/setup.mdx b/async-collaboration/view-analytics/setup.mdx index 97cdba555..eb9381677 100644 --- a/async-collaboration/view-analytics/setup.mdx +++ b/async-collaboration/view-analytics/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "View Analytics setup" +description: "Install the VeltViewAnalytics component to display unique viewers, view counts, and engagement trends scoped by document or specific UI location IDs." --- ![](/images/Trends.png) diff --git a/get-started/advanced.mdx b/get-started/advanced.mdx index 05afc53e0..19eb04183 100644 --- a/get-started/advanced.mdx +++ b/get-started/advanced.mdx @@ -1,6 +1,6 @@ --- title: "Advanced Setup" -description: "Optional advanced configuration options for Velt SDK" +description: "Advanced Velt SDK configuration with Locations, Contacts, and initialization state detection to organize users and refine collaboration scope." --- Explore optional advanced configuration options to enhance your Velt implementation with locations, contacts, and initialization state detection. diff --git a/get-started/cli.mdx b/get-started/cli.mdx index e53850f5a..e33e37dfb 100644 --- a/get-started/cli.mdx +++ b/get-started/cli.mdx @@ -1,6 +1,6 @@ --- title: "Velt CLI" -description: "Use the add-velt CLI to scaffold Velt collaboration features into your Next.js app with a single command." +description: "Use the add-velt CLI to scaffold Velt comments, presence, and real-time collaboration into your Next.js app with a single terminal command." --- Add Velt real-time collaboration to an existing Next.js project from your terminal. The CLI installs dependencies, generates components, and auto-wires `VeltProvider` into your app layout. No manual configuration required. diff --git a/get-started/mcp-installer.mdx b/get-started/mcp-installer.mdx index 9efdd6b39..5887c6aec 100644 --- a/get-started/mcp-installer.mdx +++ b/get-started/mcp-installer.mdx @@ -1,6 +1,6 @@ --- title: "Velt Installation MCP" -description: "Use the Velt MCP server to install collaboration features into React and Next.js projects through your AI coding agent." +description: "Install Velt collaboration features into React and Next.js projects through the Velt MCP server with AI agents like Claude Code, Cursor, and Windsurf." --- Install Velt collaboration features into your React or Next.js project through an AI coding agent. The Velt MCP (Model Context Protocol) server connects to editors like Claude Code, Cursor, and Windsurf, enabling guided installation with plan generation, codebase scanning, and user approval, all through natural conversation. diff --git a/get-started/quickstart-old.mdx b/get-started/quickstart-old.mdx index 0d09b7ebd..78622cef6 100644 --- a/get-started/quickstart-old.mdx +++ b/get-started/quickstart-old.mdx @@ -1,6 +1,6 @@ --- -title: "Quickstart Old Copy" -description: "Quickstart for React. For other frameworks like `vue`, `angular`, `svelte`, `vanilla js` etc. check out the setup guide." +title: "Quickstart (Legacy v3)" +description: "Legacy v3 React quickstart for Velt. For current installs and other frameworks like Vue, Angular, Svelte, or vanilla JS, see the latest setup guide." --- diff --git a/get-started/quickstart.mdx b/get-started/quickstart.mdx index e0bc2d6d2..81d7859d3 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 and set up Velt in minutes in React, Next.js, Angular, Vue, or vanilla HTML to add comments, presence, and real-time collaboration to your app." --- 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. diff --git a/get-started/skills.mdx b/get-started/skills.mdx index da4bd29f9..da7dac05d 100644 --- a/get-started/skills.mdx +++ b/get-started/skills.mdx @@ -1,6 +1,6 @@ --- title: "Agent Skills" -description: "Use Velt Agent Skills to get accurate, best-practice code from AI coding agents like Claude Code, Cursor, and GitHub Copilot." +description: "Velt Agent Skills give Claude Code, Cursor, GitHub Copilot, and other AI coding agents accurate, best-practice patterns for building with the Velt SDK." --- Get better results from AI coding agents when building with Velt. Agent Skills are structured knowledge packages that teach your AI agent the correct Velt patterns, so it writes working code on the first try instead of guessing from outdated training data. diff --git a/global-styles/css-injection.mdx b/global-styles/css-injection.mdx index ea30bff7f..59f1f6f3c 100644 --- a/global-styles/css-injection.mdx +++ b/global-styles/css-injection.mdx @@ -1,5 +1,6 @@ --- -title: CSS Injection +title: "CSS Injection" +description: "Inject custom CSS into Velt components using client.injectCustomCss() to style collaboration UI inside the Shadow DOM with strings or URLs." --- diff --git a/global-styles/dark-mode.mdx b/global-styles/dark-mode.mdx index 24a4f28d2..050ab068d 100644 --- a/global-styles/dark-mode.mdx +++ b/global-styles/dark-mode.mdx @@ -1,5 +1,6 @@ --- -title: Dark Mode +title: "Dark Mode" +description: "Enable dark mode across all Velt collaboration components in React, Next.js, and other frameworks using client.setDarkMode for consistent theming." --- diff --git a/global-styles/global-styles.mdx b/global-styles/global-styles.mdx index 93179aa61..248abc9bc 100644 --- a/global-styles/global-styles.mdx +++ b/global-styles/global-styles.mdx @@ -1,5 +1,6 @@ --- -title: Global Styles +title: "Global Styles" +description: "Style every Velt component at once with global CSS variables for tool padding, icon sizes, colors, borders, and themes instead of per-component CSS." --- To edit the styling for all Velt components, you can use the following global CSS variables. This is recommended over editing the CSS for each tool individually. diff --git a/in-app-user-feedback/customize-behavior.mdx b/in-app-user-feedback/customize-behavior.mdx index 8fd7d7091..d8dc241de 100644 --- a/in-app-user-feedback/customize-behavior.mdx +++ b/in-app-user-feedback/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "In-App Feedback: Customize Behavior" +description: "Configure VeltUserRequestTool behavior to switch between Feedback and Bug Report modes, customize icons, labels, and routing for in-app user feedback." --- diff --git a/in-app-user-feedback/overview.mdx b/in-app-user-feedback/overview.mdx index d3c7c3926..4432525a6 100644 --- a/in-app-user-feedback/overview.mdx +++ b/in-app-user-feedback/overview.mdx @@ -1,3 +1,8 @@ +--- +title: "In-App User Feedback" +sidebarTitle: "Overview" +description: "Collect in-app user feedback and bug reports inside your product with Velt's VeltUserRequestTool, no third-party tools or popups required." +--- diff --git a/in-app-user-feedback/setup.mdx b/in-app-user-feedback/setup.mdx index 14fab647b..e0a7c10fb 100644 --- a/in-app-user-feedback/setup.mdx +++ b/in-app-user-feedback/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "In-App User Feedback Setup" +description: "Add the VeltUserRequestTool to your React or Next.js app to collect in-app user feedback and bug reports tied to documents and locations." --- diff --git a/integrations/ag-grid.mdx b/integrations/ag-grid.mdx index 3deb06008..2f2258f50 100644 --- a/integrations/ag-grid.mdx +++ b/integrations/ag-grid.mdx @@ -1,5 +1,6 @@ --- -title: AG Grid +title: "AG Grid Integration" +description: "Integrate Velt collaboration features like live selection and cursors with AG Grid by adding Velt data attributes to grid cells via cell renderers." --- ## How to add Velt attributes to AG Grid cells? diff --git a/key-concepts/overview.mdx b/key-concepts/overview.mdx index 171326676..e13f5d19d 100644 --- a/key-concepts/overview.mdx +++ b/key-concepts/overview.mdx @@ -1,3 +1,8 @@ +--- +title: "Key Concepts: Organizations, Folders, Documents, Locations" +sidebarTitle: "Overview" +description: "Learn how Velt structures collaboration data as Organizations, Folders, Documents, and Locations to control access and scope features precisely." +--- ## Overview diff --git a/live-co-editing/customize-behavior.mdx b/live-co-editing/customize-behavior.mdx index 85d5d159e..9481527bb 100644 --- a/live-co-editing/customize-behavior.mdx +++ b/live-co-editing/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Live Co-Editing: Customize Behavior" +description: "Configure Velt Live Co-Editing behavior including sync rules, conflict resolution, and CRDT options for real-time multi-user editing in your app." --- diff --git a/live-co-editing/customize-ui.mdx b/live-co-editing/customize-ui.mdx index d158a3a84..c67155c2a 100644 --- a/live-co-editing/customize-ui.mdx +++ b/live-co-editing/customize-ui.mdx @@ -1,5 +1,6 @@ --- -title: "Customize UI" +title: "Live Co-Editing: Customize UI" +description: "Customize the look and feel of Velt Live Co-Editing components including cursors, selections, and presence indicators with CSS variables and slots." --- diff --git a/live-co-editing/overview.mdx b/live-co-editing/overview.mdx index 88f1358a9..9104233a0 100644 --- a/live-co-editing/overview.mdx +++ b/live-co-editing/overview.mdx @@ -1,3 +1,8 @@ +--- +title: "Live Co-Editing (Beta)" +sidebarTitle: "Overview" +description: "Add seamless real-time co-editing to your app with Velt. Sync and merge app state across all connected clients with built-in CRDT conflict resolution." +--- diff --git a/live-co-editing/setup.mdx b/live-co-editing/setup.mdx index fd40910d9..785e4c960 100644 --- a/live-co-editing/setup.mdx +++ b/live-co-editing/setup.mdx @@ -1,3 +1,7 @@ +--- +title: "Live Co-Editing Setup" +description: "Set up Velt Live Co-Editing in your app to sync application state across users in real time with CRDT-based merging and conflict resolution." +--- diff --git a/mcp/mcp.mdx b/mcp/mcp.mdx index d127973a6..930ecbc12 100644 --- a/mcp/mcp.mdx +++ b/mcp/mcp.mdx @@ -1,5 +1,6 @@ --- -title: MCP Servers (Beta) +title: "MCP Servers (Beta)" +description: "Use Velt MCP servers to query your Velt data and browse Velt docs directly from Cursor, Windsurf, Claude Desktop, and other MCP-compatible clients." --- ## Overview diff --git a/migration/environments.mdx b/migration/environments.mdx index e605b2abb..d563e99e8 100644 --- a/migration/environments.mdx +++ b/migration/environments.mdx @@ -1,6 +1,6 @@ --- title: "Managing Different Environments" -description: "Manage production, staging, and development environments with Velt API keys" +description: "Manage production, staging, and development environments in Velt with separate API keys for fully isolated data, users, and configuration per env." --- Each API key in Velt represents a separate environment with completely isolated data and settings. diff --git a/migration/migrate-from-cord-to-velt.mdx b/migration/migrate-from-cord-to-velt.mdx index 23c20988a..7d7dd05d7 100644 --- a/migration/migrate-from-cord-to-velt.mdx +++ b/migration/migrate-from-cord-to-velt.mdx @@ -1,5 +1,6 @@ --- title: "Migrate from Cord to Velt" +description: "Migrate your Cord collaboration data, comments, threads, and users to Velt with a managed migration path now that Cord has shut down." --- Cord has shut down their service. We are providing a migration path for all the Cord users to migrate to Velt. diff --git a/migration/migrate-from-liveblocks-to-velt.mdx b/migration/migrate-from-liveblocks-to-velt.mdx index 01f6c10c0..372954524 100644 --- a/migration/migrate-from-liveblocks-to-velt.mdx +++ b/migration/migrate-from-liveblocks-to-velt.mdx @@ -1,5 +1,6 @@ --- title: "Migrate from Liveblocks to Velt" +description: "Move comments, threads, and collaboration data from Liveblocks to Velt with a guided migration path covering data export, transformation, and cutover." --- For customers facing limitations with Liveblocks (eg: features, security, pricing, etc.), we provide an easy path to migrate to Velt. diff --git a/permission-management/share-and-invite/customize-ui/parts.mdx b/permission-management/share-and-invite/customize-ui/parts.mdx index 0170334b1..b6b6d2e0c 100644 --- a/permission-management/share-and-invite/customize-ui/parts.mdx +++ b/permission-management/share-and-invite/customize-ui/parts.mdx @@ -1,3 +1,8 @@ +--- +title: "Share & Invite UI: Parts" +description: "Use CSS parts to target specific elements inside Velt's Share and Invite component Shadow DOM and style them without breaking encapsulation." +--- + diff --git a/permission-management/share-and-invite/customize-ui/slots.mdx b/permission-management/share-and-invite/customize-ui/slots.mdx index 366987b26..a7be0457b 100644 --- a/permission-management/share-and-invite/customize-ui/slots.mdx +++ b/permission-management/share-and-invite/customize-ui/slots.mdx @@ -1,5 +1,6 @@ --- -title: "Slots" +title: "Share & Invite UI: Slots" +description: "Replace parts of Velt's User Invite Tool with your own templates using named slots, including a fully custom button slot in React and Next.js." --- diff --git a/permission-management/share-and-invite/customize-ui/variables.mdx b/permission-management/share-and-invite/customize-ui/variables.mdx index f4cc906d5..3123ca535 100644 --- a/permission-management/share-and-invite/customize-ui/variables.mdx +++ b/permission-management/share-and-invite/customize-ui/variables.mdx @@ -1 +1,6 @@ +--- +title: "Share & Invite UI: CSS Variables" +description: "Update CSS variables to restyle Velt's User Invite Tool. See the Global Styles page for the full list of supported tokens and theme customizations." +--- + To update CSS variables for the User Invite Tool, please refer to [Global Styles](/global-styles/global-styles) \ No newline at end of file diff --git a/permission-management/share-and-invite/overview.mdx b/permission-management/share-and-invite/overview.mdx index 78289d3d6..4fd871b53 100644 --- a/permission-management/share-and-invite/overview.mdx +++ b/permission-management/share-and-invite/overview.mdx @@ -1,7 +1,7 @@ --- title: "Invite" sidebarTitle: "Overview" -description: "A widget to invite others to collaborate together on a project" +description: "Drop in Velt's Invite widget to let users share projects and invite collaborators with managed permissions, roles, and access control built in." --- diff --git a/permission-management/share-and-invite/setup.mdx b/permission-management/share-and-invite/setup.mdx index 68663d845..79c69b105 100644 --- a/permission-management/share-and-invite/setup.mdx +++ b/permission-management/share-and-invite/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Share & Invite Setup" +description: "Add the VeltUserInviteTool to your React or Next.js app to let users share projects and invite collaborators with permission management built in." --- diff --git a/realtime-collaboration/crdt/overview.mdx b/realtime-collaboration/crdt/overview.mdx index 5933e26b6..c0dbbce89 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. +title: CRDT Collaborative Editing Overview +description: "Add real-time collaborative editing to your app with Velt's Yjs-based CRDT engine for Tiptap, BlockNote, CodeMirror, ReactFlow, and custom 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. diff --git a/realtime-collaboration/crdt/setup/blocknote.mdx b/realtime-collaboration/crdt/setup/blocknote.mdx index b512f3b41..849301dfe 100644 --- a/realtime-collaboration/crdt/setup/blocknote.mdx +++ b/realtime-collaboration/crdt/setup/blocknote.mdx @@ -1,6 +1,6 @@ --- -title: BlockNote Editor -description: Setup Multiplayer Editing for BlockNote Editor. +title: BlockNote Collaborative Editor Setup +description: "Add real-time multiplayer editing to BlockNote with Velt's Yjs-based CRDT SDK for React and Next.js apps, including setup, sync, and presence." --- The `@veltdev/blocknote-crdt-react` and `@veltdev/blocknote-crdt` libraries enable real-time collaborative editing on BlockNote Editors. The collaboration editing engine is built on top of [Yjs](https://docs.yjs.dev/) and Velt SDK. diff --git a/realtime-collaboration/crdt/setup/codemirror.mdx b/realtime-collaboration/crdt/setup/codemirror.mdx index 413dfad5c..d4daa831d 100644 --- a/realtime-collaboration/crdt/setup/codemirror.mdx +++ b/realtime-collaboration/crdt/setup/codemirror.mdx @@ -1,6 +1,6 @@ --- -title: CodeMirror Editor -description: Setup Multiplayer Editing for CodeMirror Editor. +title: CodeMirror Collaborative Editor Setup +description: "Enable real-time multiplayer code editing in CodeMirror using Velt's Yjs-based CRDT SDK for React and Next.js apps with shared cursors and sync." --- The `@veltdev/codemirror-crdt-react` and `@veltdev/codemirror-crdt` libraries enable real-time collaborative editing on CodeMirror Editors. The collaboration editing engine is built on top of [Yjs](https://docs.yjs.dev/) and Velt SDK. diff --git a/realtime-collaboration/crdt/setup/core-stores/array.mdx b/realtime-collaboration/crdt/setup/core-stores/array.mdx index 781cdea57..e6d939004 100644 --- a/realtime-collaboration/crdt/setup/core-stores/array.mdx +++ b/realtime-collaboration/crdt/setup/core-stores/array.mdx @@ -1,6 +1,6 @@ --- -title: Array Store -description: Add real-time collaborative lists and collections to your application using Velt CRDT. +title: CRDT Array Store Setup +description: "Build real-time collaborative lists and collections with Velt's CRDT array store, powered by Yjs Y.Array, for React, Next.js, and other frameworks." --- Complete [Steps 1-2](/realtime-collaboration/crdt/setup/core#setup) on the Core setup page before continuing. Those steps install dependencies and initialize Velt. diff --git a/realtime-collaboration/crdt/setup/core-stores/map.mdx b/realtime-collaboration/crdt/setup/core-stores/map.mdx index afdd6c524..da6a9f78d 100644 --- a/realtime-collaboration/crdt/setup/core-stores/map.mdx +++ b/realtime-collaboration/crdt/setup/core-stores/map.mdx @@ -1,6 +1,6 @@ --- -title: Map Store -description: Add real-time collaborative key-value data to your application using Velt CRDT. +title: CRDT Map Store Setup +description: "Sync real-time collaborative key-value data with Velt's CRDT map store, backed by Yjs Y.Map, for React, Next.js, and custom framework integrations." --- Complete [Steps 1-2](/realtime-collaboration/crdt/setup/core#setup) on the Core setup page before continuing. Those steps install dependencies and initialize Velt. diff --git a/realtime-collaboration/crdt/setup/core-stores/text.mdx b/realtime-collaboration/crdt/setup/core-stores/text.mdx index 594519988..89f789adf 100644 --- a/realtime-collaboration/crdt/setup/core-stores/text.mdx +++ b/realtime-collaboration/crdt/setup/core-stores/text.mdx @@ -1,6 +1,6 @@ --- -title: Text Store -description: Add real-time collaborative text data to your application using Velt CRDT. +title: CRDT Text Store Setup +description: "Add real-time collaborative text editing to your app with Velt's CRDT text store, backed by Yjs Y.Text, for React, Next.js, and other frameworks." --- Complete [Steps 1-2](/realtime-collaboration/crdt/setup/core#setup) on the Core setup page before continuing. Those steps install dependencies and initialize Velt. diff --git a/realtime-collaboration/crdt/setup/core-stores/xml.mdx b/realtime-collaboration/crdt/setup/core-stores/xml.mdx index 96e9fb391..3a93f9a27 100644 --- a/realtime-collaboration/crdt/setup/core-stores/xml.mdx +++ b/realtime-collaboration/crdt/setup/core-stores/xml.mdx @@ -1,6 +1,6 @@ --- -title: XML Store -description: Add real-time collaborative XML/tree data to your application using Velt CRDT. +title: CRDT XML Store Setup +description: "Sync real-time collaborative XML and tree-structured data with Velt's CRDT XML store, backed by Yjs Y.Xml, for React, Next.js, and custom frameworks." --- Complete [Steps 1-2](/realtime-collaboration/crdt/setup/core#setup) on the Core setup page before continuing. Those steps install dependencies and initialize Velt. diff --git a/realtime-collaboration/crdt/setup/core.mdx b/realtime-collaboration/crdt/setup/core.mdx index 8d196fdea..2e8cb94dd 100644 --- a/realtime-collaboration/crdt/setup/core.mdx +++ b/realtime-collaboration/crdt/setup/core.mdx @@ -1,6 +1,6 @@ --- -title: Core Setup -description: Setup Multiplayer Editing for any frameworks or custom implementations. +title: CRDT Core Library Setup +description: "Add Velt's Yjs-based CRDT engine to any framework or custom implementation with the core library for real-time multiplayer editing and data sync." --- ## Introduction diff --git a/realtime-collaboration/crdt/setup/reactflow.mdx b/realtime-collaboration/crdt/setup/reactflow.mdx index 516d55949..9e11a15f8 100644 --- a/realtime-collaboration/crdt/setup/reactflow.mdx +++ b/realtime-collaboration/crdt/setup/reactflow.mdx @@ -1,6 +1,6 @@ --- -title: React Flow Editor -description: Setup Multiplayer Editing for React Flow diagrams. +title: React Flow Collaborative Editor Setup +description: "Enable real-time multiplayer editing on React Flow diagrams and node graphs with Velt's Yjs-based CRDT SDK for React and Next.js apps." --- The `@veltdev/reactflow-crdt` library enables real-time collaborative editing on React Flow diagrams. The collaboration editing engine is built on top of [Yjs](https://docs.yjs.dev/) and Velt SDK. diff --git a/realtime-collaboration/crdt/setup/tiptap.mdx b/realtime-collaboration/crdt/setup/tiptap.mdx index b96ec9ba4..6fd0540ed 100644 --- a/realtime-collaboration/crdt/setup/tiptap.mdx +++ b/realtime-collaboration/crdt/setup/tiptap.mdx @@ -1,6 +1,6 @@ --- -title: Tiptap Editor -description: Setup Multiplayer Editing for Tiptap Editor. +title: Tiptap Collaborative Editor Setup +description: "Add real-time multiplayer editing to Tiptap with Velt's Yjs-based CRDT SDK for React and Next.js, including shared cursors, presence, and sync." --- Enable real-time collaborative editing on Tiptap Editors. The collaboration editing engine is built on top of [Yjs](https://docs.yjs.dev/) and Velt SDK. diff --git a/realtime-collaboration/cursors/customize-behavior.mdx b/realtime-collaboration/cursors/customize-behavior.mdx index 8471ace63..b887248f2 100644 --- a/realtime-collaboration/cursors/customize-behavior.mdx +++ b/realtime-collaboration/cursors/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Live Cursors Behavior" +description: "Customize Velt live cursors with avatar mode, custom colors, click effects, and visibility settings for real-time multiplayer cursor sharing." --- diff --git a/realtime-collaboration/cursors/overview.mdx b/realtime-collaboration/cursors/overview.mdx index fb8ba04c7..3a885acee 100644 --- a/realtime-collaboration/cursors/overview.mdx +++ b/realtime-collaboration/cursors/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Overview" -description: "Your users can view each other's cursors when interacting on the same document. This makes your app more alive. We handle the complexity of adapting the cursors to different screen sizes, differences in content etc." +title: "Live Cursors Overview" +description: "Show live multiplayer cursors in your app so users can see each other in real time, with automatic scaling across screen sizes and dynamic content." --- diff --git a/realtime-collaboration/cursors/setup.mdx b/realtime-collaboration/cursors/setup.mdx index 82aa8d28d..226349f81 100644 --- a/realtime-collaboration/cursors/setup.mdx +++ b/realtime-collaboration/cursors/setup.mdx @@ -1,3 +1,7 @@ +--- +title: "Live Cursors Setup" +description: "Install and configure Velt live cursors with the VeltCursor component for React, Next.js, and other frameworks to share real-time multiplayer cursors." +--- diff --git a/realtime-collaboration/flock-mode/customize-behavior.mdx b/realtime-collaboration/flock-mode/customize-behavior.mdx index 5b4354841..a309d657c 100644 --- a/realtime-collaboration/flock-mode/customize-behavior.mdx +++ b/realtime-collaboration/flock-mode/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Flock Mode Behavior" +description: "Configure Velt Flock Mode to enable Figma-style follow-along sessions, letting users follow a leader's clicks, scrolls, and navigation in real time." --- ## flockMode diff --git a/realtime-collaboration/flock-mode/overview.mdx b/realtime-collaboration/flock-mode/overview.mdx index f9f0d20dd..90ad27820 100644 --- a/realtime-collaboration/flock-mode/overview.mdx +++ b/realtime-collaboration/flock-mode/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Overview" -description: "This is like Figma's follow along feature. Start a shared session in a click. One person is the leader, and whatever they do - like clicking, scrolling, or navigating - happens automatically on everyone else's screen." +title: "Flock Mode Overview" +description: "Add Figma-style follow-along sessions to your app with Velt Flock Mode, mirroring a leader's clicks, scrolls, and navigation to every participant in real time." --- diff --git a/realtime-collaboration/flock-mode/setup.mdx b/realtime-collaboration/flock-mode/setup.mdx index 3a7211227..48fa3fe00 100644 --- a/realtime-collaboration/flock-mode/setup.mdx +++ b/realtime-collaboration/flock-mode/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Flock Mode Setup" +description: "Set up Velt Flock Mode follow-along sessions on the Presence component for React, Next.js, and other frameworks to mirror a leader's actions live." --- diff --git a/realtime-collaboration/huddle/customize-behavior.mdx b/realtime-collaboration/huddle/customize-behavior.mdx index ed02fbfb3..ab6d823f1 100644 --- a/realtime-collaboration/huddle/customize-behavior.mdx +++ b/realtime-collaboration/huddle/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title : "Customize Behavior" +title : "Customize Huddle Behavior" +description: "Customize Velt Huddle with audio, video, and screen share modes, plus participant limits and UI configuration for real-time voice and video sessions." --- ## type diff --git a/realtime-collaboration/huddle/setup.mdx b/realtime-collaboration/huddle/setup.mdx index 72162fc71..54b733021 100644 --- a/realtime-collaboration/huddle/setup.mdx +++ b/realtime-collaboration/huddle/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Huddle Setup" +description: "Install and configure the Velt Huddle component for in-app audio, video, and screen sharing in React, Next.js, and other frameworks." --- diff --git a/realtime-collaboration/huddle/webhooks.mdx b/realtime-collaboration/huddle/webhooks.mdx index b8a3dbe68..501bc3235 100644 --- a/realtime-collaboration/huddle/webhooks.mdx +++ b/realtime-collaboration/huddle/webhooks.mdx @@ -1,3 +1,8 @@ +--- +title: "Huddle Webhooks" +description: "Receive Velt Huddle webhook notifications when users create or join group audio, video, and screen share sessions, with payload schema and examples." +--- + The `Huddle` component will emit webhook notifications when a user creates or joins a group huddle. To read more about how to use webhooks with our SDK, [click here](https://docs.velt.dev/webhooks/basic). diff --git a/realtime-collaboration/live-selection/customize-behavior.mdx b/realtime-collaboration/live-selection/customize-behavior.mdx index b6532d676..e2a863cdd 100644 --- a/realtime-collaboration/live-selection/customize-behavior.mdx +++ b/realtime-collaboration/live-selection/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Live Selection Behavior" +description: "Configure Velt Live Selection element tracking, default targets, opt-in attributes, and highlight styling to show which UI elements collaborators focus on." --- ## enableDefaultElementsTracking diff --git a/realtime-collaboration/live-selection/overview.mdx b/realtime-collaboration/live-selection/overview.mdx index ce699197f..39718b7e6 100644 --- a/realtime-collaboration/live-selection/overview.mdx +++ b/realtime-collaboration/live-selection/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Overview" -description: "Your users can see what part of the document others are interacting with in real-time." +title: "Live Selection Overview" +description: "Show real-time collaborator focus on inputs, buttons, and contenteditable elements with Velt Live Selection, including avatars and highlight outlines." --- When Live Selection is enabled, users will see the users' avatar or name, and a highlight box around the element they are interacting with. diff --git a/realtime-collaboration/live-selection/setup.mdx b/realtime-collaboration/live-selection/setup.mdx index 0c19148c8..03636e959 100644 --- a/realtime-collaboration/live-selection/setup.mdx +++ b/realtime-collaboration/live-selection/setup.mdx @@ -1,3 +1,8 @@ +--- +title: "Live Selection Setup" +description: "Enable Velt Live Selection to highlight inputs, textareas, buttons, and contenteditable elements collaborators are focused on, with React and JS examples." +--- + ## Get the Live Selection Element and enable it When enabled, Live Selection will automatically detect and highlight user's presence on the following elements: diff --git a/realtime-collaboration/live-state-sync/overview.mdx b/realtime-collaboration/live-state-sync/overview.mdx index d4df10416..0b460378a 100644 --- a/realtime-collaboration/live-state-sync/overview.mdx +++ b/realtime-collaboration/live-state-sync/overview.mdx @@ -1,6 +1,6 @@ --- -title: Overview -description: Sync and broadcast data in real-time across all connected clients. +title: Live State Sync Overview +description: "Broadcast and synchronize shared app state across all connected clients in real time with Velt Live State Sync, including offline support and low latency." --- Live State Sync allows you to share and synchronize data in real-time across all connected clients. 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. diff --git a/realtime-collaboration/live-state-sync/redux-middleware.mdx b/realtime-collaboration/live-state-sync/redux-middleware.mdx index 1c39354bc..1ad5d59de 100644 --- a/realtime-collaboration/live-state-sync/redux-middleware.mdx +++ b/realtime-collaboration/live-state-sync/redux-middleware.mdx @@ -1,5 +1,6 @@ --- -title: Redux Middleware +title: Live State Sync Redux Middleware +description: "Sync Redux store state across all connected clients in real time using Velt's createLiveStateMiddleware for React and Next.js collaborative apps." --- If you are using Redux, you can use our middleware to sync state changes directly into your Redux store. diff --git a/realtime-collaboration/live-state-sync/setup.mdx b/realtime-collaboration/live-state-sync/setup.mdx index 63bc67efb..512ec8cd6 100644 --- a/realtime-collaboration/live-state-sync/setup.mdx +++ b/realtime-collaboration/live-state-sync/setup.mdx @@ -1,5 +1,6 @@ --- -title: Setup +title: Live State Sync Setup +description: "Set and read shared real-time data across clients with Velt Live State Sync getter and setter methods, including merge config and serializable payloads." --- # Getter and Setter Methods diff --git a/realtime-collaboration/presence/customize-behavior.mdx b/realtime-collaboration/presence/customize-behavior.mdx index 0411f632d..40f5ada83 100644 --- a/realtime-collaboration/presence/customize-behavior.mdx +++ b/realtime-collaboration/presence/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: "Customize Behavior" +title: "Customize Presence Behavior" +description: "Configure Velt Presence with inactivity timeouts, online status, idle detection, and avatar display options for real-time multiplayer user awareness." --- # Configuration diff --git a/realtime-collaboration/presence/overview.mdx b/realtime-collaboration/presence/overview.mdx index 5167a048d..c9d45e8ad 100644 --- a/realtime-collaboration/presence/overview.mdx +++ b/realtime-collaboration/presence/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Overview" -description: "Your users can see other users online on the document. This makes your app feel alive." +title: "Presence Overview" +description: "Show who's online on a document with Velt Presence, including live avatars, online status, and idle detection for real-time multiplayer awareness." --- diff --git a/realtime-collaboration/presence/setup.mdx b/realtime-collaboration/presence/setup.mdx index 13e279156..bd65c5e6c 100644 --- a/realtime-collaboration/presence/setup.mdx +++ b/realtime-collaboration/presence/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Presence Setup" +description: "Install and configure the Velt Presence component to display live avatars and online status across React, Next.js, and other frameworks." --- diff --git a/realtime-collaboration/single-editor-mode/customize-behavior.mdx b/realtime-collaboration/single-editor-mode/customize-behavior.mdx index 72bf16b88..80fde43e4 100644 --- a/realtime-collaboration/single-editor-mode/customize-behavior.mdx +++ b/realtime-collaboration/single-editor-mode/customize-behavior.mdx @@ -1,5 +1,6 @@ --- -title: Customize Behavior +title: Customize Single Editor Mode Behavior +description: "Configure Velt Single Editor Mode with custom read-only handling, single-tab editor limits, and APIs to control which user can edit at a time." --- ## enableSingleEditorMode diff --git a/realtime-collaboration/single-editor-mode/overview.mdx b/realtime-collaboration/single-editor-mode/overview.mdx index 11e98d95b..521e88956 100644 --- a/realtime-collaboration/single-editor-mode/overview.mdx +++ b/realtime-collaboration/single-editor-mode/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Overview" -description: "Allow only one user to edit at a time but still allow everyone to see the changes as they happen." +title: "Single Editor Mode Overview" +description: "Restrict editing to one user at a time while others view changes live with Velt Single Editor Mode, featuring low latency and offline conflict resolution." --- ## Latency diff --git a/realtime-collaboration/single-editor-mode/setup.mdx b/realtime-collaboration/single-editor-mode/setup.mdx index 2489728b5..3e89c9c5b 100644 --- a/realtime-collaboration/single-editor-mode/setup.mdx +++ b/realtime-collaboration/single-editor-mode/setup.mdx @@ -1,6 +1,6 @@ --- -title: Setup -description: Enable Single Editor Mode to allow only one user to edit at a time while others remain in read-only mode. +title: Single Editor Mode Setup +description: "Enable Velt Single Editor Mode in your React or Next.js app to lock editing to one user at a time while keeping all viewers in real-time read-only sync." --- ## Prerequisites diff --git a/realtime-collaboration/video-player-sync/overview.mdx b/realtime-collaboration/video-player-sync/overview.mdx index 818915a0e..68e93d19c 100644 --- a/realtime-collaboration/video-player-sync/overview.mdx +++ b/realtime-collaboration/video-player-sync/overview.mdx @@ -1,3 +1,7 @@ +--- +title: "Video Player Sync Overview" +description: "Synchronize video playback across all viewers in real time with Velt Video Player Sync, so users can watch the same video together in your app." +--- ## Video Player Sync diff --git a/realtime-collaboration/video-player-sync/setup.mdx b/realtime-collaboration/video-player-sync/setup.mdx index 8efbd9c8e..87ff0958c 100644 --- a/realtime-collaboration/video-player-sync/setup.mdx +++ b/realtime-collaboration/video-player-sync/setup.mdx @@ -1,5 +1,6 @@ --- -title: "Setup" +title: "Video Player Sync Setup" +description: "Enable Velt Video Player Sync by adding the data-sync-video-player attribute to your video element for synchronized real-time multi-user playback." --- diff --git a/release-notes/3-0-0.mdx b/release-notes/3-0-0.mdx index fef2b70ad..8298f707e 100644 --- a/release-notes/3-0-0.mdx +++ b/release-notes/3-0-0.mdx @@ -1,5 +1,6 @@ --- -title: Version 3.0.0 +title: "Version 3.0.0 Release Notes" +description: "Release notes for Velt SDK v3.0.0, including Comments pagination, comment editing, Recorder shadow DOM controls, and other improvements." --- ## Change Log diff --git a/release-notes/version-4/blocknote-changelog.mdx b/release-notes/version-4/blocknote-changelog.mdx index b56657506..9d18caf10 100644 --- a/release-notes/version-4/blocknote-changelog.mdx +++ b/release-notes/version-4/blocknote-changelog.mdx @@ -1,7 +1,7 @@ --- title: "BlockNote CRDT Library" rss: true -description: Release Notes of Changes Affecting Velt BlockNote Library +description: "Release notes for the Velt BlockNote CRDT library (@veltdev/blocknote-crdt and @veltdev/blocknote-crdt-react) covering API and DX improvements." --- ### Libraries diff --git a/release-notes/version-4/codemirror-changelog.mdx b/release-notes/version-4/codemirror-changelog.mdx index 61870445b..dee4cb239 100644 --- a/release-notes/version-4/codemirror-changelog.mdx +++ b/release-notes/version-4/codemirror-changelog.mdx @@ -1,7 +1,7 @@ --- title: "CodeMirror CRDT Library" rss: true -description: Release Notes of Changes Affecting Velt CodeMirror Library +description: "Release notes for the Velt CodeMirror CRDT library (@veltdev/codemirror-crdt and @veltdev/codemirror-crdt-react) with CRDT store improvements." --- ### Libraries diff --git a/release-notes/version-4/crdt-core-changelog.mdx b/release-notes/version-4/crdt-core-changelog.mdx index 4f6f27a2b..fec48b699 100644 --- a/release-notes/version-4/crdt-core-changelog.mdx +++ b/release-notes/version-4/crdt-core-changelog.mdx @@ -1,7 +1,7 @@ --- title: "Core CRDT Library" rss: true -description: Release Notes of Changes Affecting All CRDT Libraries +description: "Version 4 release notes for the Velt Core CRDT libraries (@veltdev/crdt and @veltdev/crdt-react), shared across all CRDT integrations." --- ### Libraries diff --git a/release-notes/version-4/lexical-changelog.mdx b/release-notes/version-4/lexical-changelog.mdx index 654ff3088..17bbef15b 100644 --- a/release-notes/version-4/lexical-changelog.mdx +++ b/release-notes/version-4/lexical-changelog.mdx @@ -1,7 +1,7 @@ --- title: "Lexical Changelog" rss: true -description: Release Notes of Changes Affecting Velt Lexical Library +description: "Release notes for the Velt Lexical integration (@veltdev/lexical-velt-comments) including comment integration refactors and editor scenarios." --- diff --git a/release-notes/version-4/reactflow-changelog.mdx b/release-notes/version-4/reactflow-changelog.mdx index adb1e7e95..38d23e445 100644 --- a/release-notes/version-4/reactflow-changelog.mdx +++ b/release-notes/version-4/reactflow-changelog.mdx @@ -1,7 +1,7 @@ --- title: "React Flow CRDT Library" rss: true -description: Release Notes of Changes Affecting Velt React Flow Library +description: "Release notes for the Velt React Flow CRDT library (@veltdev/reactflow-crdt) covering production build fixes and CRDT improvements." --- ### Libraries diff --git a/release-notes/version-4/sdk-changelog.mdx b/release-notes/version-4/sdk-changelog.mdx index 4410f02a4..0e41ba004 100644 --- a/release-notes/version-4/sdk-changelog.mdx +++ b/release-notes/version-4/sdk-changelog.mdx @@ -1,7 +1,7 @@ --- title: "Velt SDK Changelog" rss: true -description: Release Notes of changes added to the core Velt SDK +description: "Version 4 release notes for the core Velt SDK packages (@veltdev/react, @veltdev/client, and @veltdev/sdk), with new features and bug fixes." --- ### Libraries diff --git a/release-notes/version-4/tiptap-changelog.mdx b/release-notes/version-4/tiptap-changelog.mdx index 83dc56475..aee635645 100644 --- a/release-notes/version-4/tiptap-changelog.mdx +++ b/release-notes/version-4/tiptap-changelog.mdx @@ -1,7 +1,7 @@ --- title: "Tiptap CRDT Library" rss: true -description: Release Notes of Changes Affecting Velt Tiptap CRDT Library +description: "Release notes for the Velt Tiptap CRDT library (@veltdev/tiptap-crdt and @veltdev/tiptap-crdt-react), with production tests and CRDT improvements." --- ### Libraries diff --git a/release-notes/version-4/upgrade-guide.mdx b/release-notes/version-4/upgrade-guide.mdx index 735fb334b..1c4659f3e 100644 --- a/release-notes/version-4/upgrade-guide.mdx +++ b/release-notes/version-4/upgrade-guide.mdx @@ -1,5 +1,6 @@ --- -title: Upgrade Guide +title: "Velt SDK v4 Upgrade Guide" +description: "Upgrade your Velt integration to v4 with multi-document support, advanced data querying, enhanced security, and reduced customization code." --- ## Overview diff --git a/release-notes/version-5/crdt-core-changelog.mdx b/release-notes/version-5/crdt-core-changelog.mdx index da9440734..2d6bf05fe 100644 --- a/release-notes/version-5/crdt-core-changelog.mdx +++ b/release-notes/version-5/crdt-core-changelog.mdx @@ -1,7 +1,7 @@ --- title: "Core CRDT Library" rss: true -description: Release Notes of Changes Affecting All CRDT Libraries +description: "Version 5 release notes for Velt Core CRDT libraries (@veltdev/crdt and @veltdev/crdt-react), shared across BlockNote, Tiptap, CodeMirror, and more." --- ### Libraries diff --git a/release-notes/version-5/sdk-changelog.mdx b/release-notes/version-5/sdk-changelog.mdx index da1a782ca..2e8396ae3 100644 --- a/release-notes/version-5/sdk-changelog.mdx +++ b/release-notes/version-5/sdk-changelog.mdx @@ -1,7 +1,7 @@ --- title: "Velt SDK Changelog" rss: true -description: Release Notes of changes added to the core Velt SDK +description: "Version 5 release notes for the core Velt SDK packages (@veltdev/react, @veltdev/client, and @veltdev/sdk), with new comment dialog primitives." --- ### Libraries diff --git a/release-notes/version-5/upgrade-guide.mdx b/release-notes/version-5/upgrade-guide.mdx index 40d19e422..3814913e1 100644 --- a/release-notes/version-5/upgrade-guide.mdx +++ b/release-notes/version-5/upgrade-guide.mdx @@ -1,5 +1,6 @@ --- -title: Upgrade Guide +title: "Velt SDK v5 Upgrade Guide" +description: "Upgrade Velt to v5 with 115+ comment dialog primitive components, standalone subcomponents, ID-based and context wrapper usage, and full styling control." --- ## Overview diff --git a/release-notes/version-5/velt-node-changelog.mdx b/release-notes/version-5/velt-node-changelog.mdx index 9906e0c5c..bb4bc7cd0 100644 --- a/release-notes/version-5/velt-node-changelog.mdx +++ b/release-notes/version-5/velt-node-changelog.mdx @@ -1,7 +1,7 @@ --- title: "Velt Node SDK Changelog" rss: true -description: Release Notes of changes added to the Velt Node.js/TypeScript SDK (@veltdev/node) +description: "Release notes for the Velt Node.js and TypeScript SDK (@veltdev/node), including new comment resolver save events and self-hosting features." --- ### Libraries diff --git a/release-notes/version-5/velt-py-changelog.mdx b/release-notes/version-5/velt-py-changelog.mdx index cdf356c00..889983ffc 100644 --- a/release-notes/version-5/velt-py-changelog.mdx +++ b/release-notes/version-5/velt-py-changelog.mdx @@ -1,6 +1,6 @@ --- title: "Python SDK (velt-py) Changelog" -description: Release notes for the velt-py Python SDK for self-hosting +description: "Release notes for the velt-py Python SDK, including self-hosting resolver auth with JWT/JWKS verification and new comment resolver save events." --- ### Libraries diff --git a/security/auth-tokens.mdx b/security/auth-tokens.mdx index 5f4ea19a9..7c3f04fbf 100644 --- a/security/auth-tokens.mdx +++ b/security/auth-tokens.mdx @@ -1,5 +1,6 @@ --- title: "Generating Auth Tokens" +description: "Generate Velt auth tokens from the Velt Console to authenticate your SDK calls and securely identify users in your collaboration backend." --- diff --git a/security/content-security-policy.mdx b/security/content-security-policy.mdx index b9c58cc94..06011eb63 100644 --- a/security/content-security-policy.mdx +++ b/security/content-security-policy.mdx @@ -1,3 +1,8 @@ +--- +title: "Content Security Policy (CSP)" +description: "Whitelist the Velt SDK domains and WebSocket endpoints in your Content Security Policy script-src and connect-src directives for secure embedding." +--- + ## Whitelisting Rules for Content Security Policy (CSP) If you have a Content Security Policy (CSP) enabled in your app configuration, ensure that the following URLs are whitelisted: diff --git a/security/jwt-tokens.mdx b/security/jwt-tokens.mdx index ad459ccc1..5aea026fa 100644 --- a/security/jwt-tokens.mdx +++ b/security/jwt-tokens.mdx @@ -1,6 +1,6 @@ --- title: "JWT Tokens" -description: "Generate JWT Tokens for additional security" +description: "Generate JWT tokens to add an extra layer of authentication to client.identify() in the Velt SDK and prevent user impersonation in your app." --- diff --git a/security/proxy-server.mdx b/security/proxy-server.mdx index 790d03f3b..c058a1ff8 100644 --- a/security/proxy-server.mdx +++ b/security/proxy-server.mdx @@ -1,5 +1,6 @@ --- -title: Proxy Server +title: "Proxy Server" +description: "Route Velt SDK traffic through a reverse proxy on your own domain for egress control, compliance, custom branding, and geo-routing of API calls." --- Route Velt SDK traffic through reverse proxies on your own domain. This keeps all Velt-related network calls branded to your infrastructure and satisfies strict network policies that prohibit direct connections to third-party services. diff --git a/security/supported-regions.mdx b/security/supported-regions.mdx index bd256cb0b..1434f78da 100644 --- a/security/supported-regions.mdx +++ b/security/supported-regions.mdx @@ -1,5 +1,6 @@ --- title: "Supported Regions" +description: "List of Velt supported data regions for persistent features like Comments, Notifications, and Recording across North America, Europe, and Asia." --- Persistent features like Comments, Notifications, Recording, etc. are available in the following regions: diff --git a/self-host-data/activity.mdx b/self-host-data/activity.mdx index 46d4e5cda..f811a5f68 100644 --- a/self-host-data/activity.mdx +++ b/self-host-data/activity.mdx @@ -1,6 +1,6 @@ --- title: "Activity" -description: "Self-host your activity log PII data while using Velt's components. Keep activity content, entity snapshots, and custom fields on your infrastructure with only minimal identifiers stored on Velt servers." +description: "Self-host Velt activity log PII data on your own infrastructure: keep activity content, entity snapshots, and custom fields private while using Velt UI." --- diff --git a/self-host-data/attachments.mdx b/self-host-data/attachments.mdx index 9ddbda2bb..d660d8b79 100644 --- a/self-host-data/attachments.mdx +++ b/self-host-data/attachments.mdx @@ -1,6 +1,6 @@ --- title: "Attachments" -description: "Self-host your comments file attachments data while using Velt's components. Keep attachment storage on your infrastructure with minimal metadata stored on Velt servers." +description: "Self-host Velt comment file attachments on your own storage and infrastructure while keeping only minimal attachment metadata on Velt servers." --- diff --git a/self-host-data/field-inventory.mdx b/self-host-data/field-inventory.mdx index 59fce84ad..78fc1b82a 100644 --- a/self-host-data/field-inventory.mdx +++ b/self-host-data/field-inventory.mdx @@ -1,6 +1,6 @@ --- -title: "Complete Field Inventory" -description: "An exhaustive, ground-truthed inventory of every persisted self-hosting field — Velt's DB vs. your DB — with type, example value, description, and notes for comments, reactions, recordings, notifications, activity, and attachments." +title: "Self-Hosting: Complete Field Inventory" +description: "Detailed field-by-field inventory of Velt self-hosting data splits across comments, reactions, recordings, notifications, activity, and attachments." --- > **Companion to the [Self-Hosting Overview](/self-host-data/overview).** That guide's field-inventory diff --git a/self-host-data/notifications.mdx b/self-host-data/notifications.mdx index 31a976039..936dabb4d 100644 --- a/self-host-data/notifications.mdx +++ b/self-host-data/notifications.mdx @@ -1,6 +1,6 @@ --- title: "Notifications" -description: "Self-host your custom notification PII data while using Velt's notification components. Keep notification content on your infrastructure with only minimal identifiers stored on Velt servers." +description: "Self-host Velt custom notification PII content on your own infrastructure while Velt stores only minimal identifiers and routes the notification UI." --- diff --git a/self-host-data/overview.mdx b/self-host-data/overview.mdx index e705ccd1b..c85c7809c 100644 --- a/self-host-data/overview.mdx +++ b/self-host-data/overview.mdx @@ -1,6 +1,6 @@ --- -title: "Overview" -description: "Self-host user-generated content and PII on your own infrastructure while Velt stores only minimal structural identifiers. Learn the data-provider model, what gets stored where, and how to register providers." +title: "Self-Hosting Overview" +description: "Self-host Velt comments, reactions, recordings, notifications, activity, and attachments PII on your infrastructure using the data-provider resolver model." --- By default, Velt stores all collaboration data (comments, reactions, recordings, notifications, activity, attachments) in Velt's managed backend. **Self-hosting** lets you split that storage so sensitive content and PII never leave your infrastructure: diff --git a/self-host-data/recordings.mdx b/self-host-data/recordings.mdx index db03db2d3..63e41e4d2 100644 --- a/self-host-data/recordings.mdx +++ b/self-host-data/recordings.mdx @@ -1,6 +1,6 @@ --- title: "Recordings" -description: "Self-host your recording annotation PII data while using Velt's components. Keep recorded files, identity, transcription, and attachment URLs on your infrastructure with only minimal identifiers stored on Velt servers." +description: "Self-host Velt recording annotation PII: store recorded files, user identity, transcriptions, and attachment URLs on your infrastructure with Velt UI." --- diff --git a/ui-customization/conditional-templates.mdx b/ui-customization/conditional-templates.mdx index c1f9bd7ab..7c16b3895 100644 --- a/ui-customization/conditional-templates.mdx +++ b/ui-customization/conditional-templates.mdx @@ -1,5 +1,6 @@ --- title: "Conditional Templates" +description: "Conditionally show or hide parts of Velt wireframes using VeltIf or the veltIf attribute, with expressions based on Template Variables data models." --- - Conditional Templates let you conditionally show or hide parts of the Velt Component Wireframes. diff --git a/ui-customization/custom-action-component.mdx b/ui-customization/custom-action-component.mdx index 9309ee115..7d5be3954 100644 --- a/ui-customization/custom-action-component.mdx +++ b/ui-customization/custom-action-component.mdx @@ -1,5 +1,6 @@ --- title: "Action Components" +description: "Use the Velt Action Component to add custom buttons, actions, filtering, sorting, and grouping to Comment Sidebar, Notifications, and Comment Dialog." --- - A customizable button component that can be used to add custom actions and extend the functionality of any Velt component. Some examples include: diff --git a/ui-customization/features/async/activity-logs/activity-logs-primitives.mdx b/ui-customization/features/async/activity-logs/activity-logs-primitives.mdx index 4be7698c1..b070acce0 100644 --- a/ui-customization/features/async/activity-logs/activity-logs-primitives.mdx +++ b/ui-customization/features/async/activity-logs/activity-logs-primitives.mdx @@ -1,6 +1,6 @@ --- title: Activity Logs Primitives -description: Standalone primitive components for building custom Activity Logs interfaces. +description: "Standalone primitive components for building fully custom Activity Logs interfaces — compose audit trails, history feeds, and event timelines from scratch." --- diff --git a/ui-customization/features/async/activity-logs/activity-logs-wireframe-variables.mdx b/ui-customization/features/async/activity-logs/activity-logs-wireframe-variables.mdx index 3d5fad383..02d5d49aa 100644 --- a/ui-customization/features/async/activity-logs/activity-logs-wireframe-variables.mdx +++ b/ui-customization/features/async/activity-logs/activity-logs-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Activity Logs Wireframe Variables -description: Template variables exposed by the Activity Logs wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Activity Logs wireframe — bind audit event, actor, and timestamp data to drive dynamic content and conditional rendering." --- diff --git a/ui-customization/features/async/area/wireframe-variables.mdx b/ui-customization/features/async/area/wireframe-variables.mdx index be6fc0d33..710686765 100644 --- a/ui-customization/features/async/area/wireframe-variables.mdx +++ b/ui-customization/features/async/area/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Area Wireframe Variables -description: Template variables exposed by the Area wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Area wireframe — bind area selection, region, and annotation data to drive dynamic content and conditional rendering." --- diff --git a/ui-customization/features/async/arrows/custom-button.mdx b/ui-customization/features/async/arrows/custom-button.mdx index 486855775..0e70c2e1e 100644 --- a/ui-customization/features/async/arrows/custom-button.mdx +++ b/ui-customization/features/async/arrows/custom-button.mdx @@ -1,5 +1,6 @@ --- -title: "Custom Button" +title: "Arrow Tool Custom Button" +description: "Replace the default Velt Arrow Tool trigger button with your own custom button component to match your design system, brand colors, and icon styling." --- diff --git a/ui-customization/features/async/arrows/parts.mdx b/ui-customization/features/async/arrows/parts.mdx index 18ddd3369..524075e2d 100644 --- a/ui-customization/features/async/arrows/parts.mdx +++ b/ui-customization/features/async/arrows/parts.mdx @@ -1,3 +1,8 @@ +--- +title: "Arrow Tool Parts" +description: "CSS ::part() selectors exposed by the Velt Arrow Tool — target the container, button container, and button icon inside the component's Shadow DOM." +--- + diff --git a/ui-customization/features/async/arrows/slots.mdx b/ui-customization/features/async/arrows/slots.mdx index 128f9f325..a87623c53 100644 --- a/ui-customization/features/async/arrows/slots.mdx +++ b/ui-customization/features/async/arrows/slots.mdx @@ -1,5 +1,6 @@ --- -title: "Slots" +title: "Arrow Tool Slots" +description: "Replace the Velt Arrow Tool button and other elements using named slots to inject custom HTML and components into specific parts of the wireframe." --- diff --git a/ui-customization/features/async/arrows/variables.mdx b/ui-customization/features/async/arrows/variables.mdx index fd5d10369..0611fa611 100644 --- a/ui-customization/features/async/arrows/variables.mdx +++ b/ui-customization/features/async/arrows/variables.mdx @@ -1 +1,6 @@ +--- +title: "Arrow Tool CSS Variables" +description: "Update CSS variables for the Velt Arrow Tool via Global Styles to customize colors, sizing, and theming across the arrow annotation component." +--- + To update CSS variables for the Arrow Tool, please refer to [Global Styles](/global-styles/global-styles) \ No newline at end of file diff --git a/ui-customization/features/async/comments/autocomplete-wireframe-variables.mdx b/ui-customization/features/async/comments/autocomplete-wireframe-variables.mdx index 80122be36..559324059 100644 --- a/ui-customization/features/async/comments/autocomplete-wireframe-variables.mdx +++ b/ui-customization/features/async/comments/autocomplete-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Autocomplete Wireframe Variables -description: Template variables exposed by the Autocomplete wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Autocomplete wireframe — bind @mention suggestion, user list, and search query data for dynamic rendering and filtering." --- diff --git a/ui-customization/features/async/comments/comment-bubble/primitives.mdx b/ui-customization/features/async/comments/comment-bubble/primitives.mdx index 9ef6071c3..bc12afe29 100644 --- a/ui-customization/features/async/comments/comment-bubble/primitives.mdx +++ b/ui-customization/features/async/comments/comment-bubble/primitives.mdx @@ -1,6 +1,6 @@ --- title: Comment Bubble Primitives -description: Primitive-based components for building custom Comment Bubble interfaces with maximum flexibility. +description: "Primitive components for building custom Comment Bubble UIs — compose floating avatars, unread indicators, and comments count from low-level building blocks." --- diff --git a/ui-customization/features/async/comments/comment-bubble/wireframe-variables.mdx b/ui-customization/features/async/comments/comment-bubble/wireframe-variables.mdx index a70948b5d..ce88d6a44 100644 --- a/ui-customization/features/async/comments/comment-bubble/wireframe-variables.mdx +++ b/ui-customization/features/async/comments/comment-bubble/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Comment Bubble Wireframe Variables -description: Template variables exposed by the Comment Bubble wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Comment Bubble wireframe — bind avatar, unread state, and comments count data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/comments/comment-bubble/wireframes.mdx b/ui-customization/features/async/comments/comment-bubble/wireframes.mdx index e21b318fd..c1f16af32 100644 --- a/ui-customization/features/async/comments/comment-bubble/wireframes.mdx +++ b/ui-customization/features/async/comments/comment-bubble/wireframes.mdx @@ -1,6 +1,6 @@ --- title: Comment Bubble Wireframes -description: Wireframe components for building custom Comment Bubble interfaces with maximum flexibility. +description: "Wireframe components for building custom Comment Bubble UIs — override avatars, unread icons, and comments count with your own HTML and design system." --- diff --git a/ui-customization/features/async/comments/comment-dialog-structure.mdx b/ui-customization/features/async/comments/comment-dialog-structure.mdx index f9234de3f..c679bf65d 100644 --- a/ui-customization/features/async/comments/comment-dialog-structure.mdx +++ b/ui-customization/features/async/comments/comment-dialog-structure.mdx @@ -1,6 +1,6 @@ --- title: "Comment Dialog — Structure" -description: "Canonical structure for the Velt Comment Dialog Wireframe (React & HTML mirrors). Order follows your provided JSX/HTML. Parent/child is defined only by the extension path. Direct children are marked with (Leaf) when they have no descendants." +description: "Canonical Velt Comment Dialog wireframe structure for React and HTML — parent/child paths, leaf nodes, and the full component tree for customization." --- > **Conventions** diff --git a/ui-customization/features/async/comments/comment-dialog/primitives.mdx b/ui-customization/features/async/comments/comment-dialog/primitives.mdx index c274a29d2..a90e42f6d 100644 --- a/ui-customization/features/async/comments/comment-dialog/primitives.mdx +++ b/ui-customization/features/async/comments/comment-dialog/primitives.mdx @@ -1,6 +1,6 @@ --- title: Comment Dialog Primitives -description: 98+ primitive components for building custom Comment Dialog interfaces with maximum flexibility. +description: "98+ primitive components for building custom Comment Dialog UIs — compose threads, composers, reactions, and toolbars from low-level Velt building blocks." --- diff --git a/ui-customization/features/async/comments/comment-dialog/wireframe-variables.mdx b/ui-customization/features/async/comments/comment-dialog/wireframe-variables.mdx index d7468f094..e4a5f3035 100644 --- a/ui-customization/features/async/comments/comment-dialog/wireframe-variables.mdx +++ b/ui-customization/features/async/comments/comment-dialog/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Comment Dialog Wireframe Variables -description: Template variables exposed by the Comment Dialog wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Comment Dialog wireframe — bind annotation, thread, author, status, and reaction data for dynamic content and UI." --- diff --git a/ui-customization/features/async/comments/comment-dialog/wireframes.mdx b/ui-customization/features/async/comments/comment-dialog/wireframes.mdx index 32644c980..713aa2770 100644 --- a/ui-customization/features/async/comments/comment-dialog/wireframes.mdx +++ b/ui-customization/features/async/comments/comment-dialog/wireframes.mdx @@ -1,6 +1,6 @@ --- title: Comment Dialog Wireframes -description: Wireframe components for building custom Comment Dialog interfaces with maximum flexibility. +description: "Wireframe components for building custom Comment Dialog UIs — override threads, composer, header, reactions, and toolbar with your own HTML and styling." --- diff --git a/ui-customization/features/async/comments/comment-pin/primitives.mdx b/ui-customization/features/async/comments/comment-pin/primitives.mdx index 0a417a737..21f6a4b0b 100644 --- a/ui-customization/features/async/comments/comment-pin/primitives.mdx +++ b/ui-customization/features/async/comments/comment-pin/primitives.mdx @@ -1,6 +1,6 @@ --- title: Comment Pin Primitives -description: Primitive-based components for building custom Comment Pin interfaces with maximum flexibility. +description: "Primitive components for building custom Comment Pin UIs — compose pin markers, avatars, and unread badges from low-level Velt building blocks." --- diff --git a/ui-customization/features/async/comments/comment-pin/wireframes.mdx b/ui-customization/features/async/comments/comment-pin/wireframes.mdx index 5a5ddc3d4..116ebe42f 100644 --- a/ui-customization/features/async/comments/comment-pin/wireframes.mdx +++ b/ui-customization/features/async/comments/comment-pin/wireframes.mdx @@ -1,6 +1,6 @@ --- title: Comment Pin Wireframes -description: Wireframe components for building custom Comment Pin interfaces with maximum flexibility. +description: "Wireframe components for building custom Comment Pin UIs — override pin markers, avatars, and unread badges with your own HTML and design system." --- diff --git a/ui-customization/features/async/comments/comment-player-timeline.mdx b/ui-customization/features/async/comments/comment-player-timeline.mdx index 450ceac0d..daed3cd04 100644 --- a/ui-customization/features/async/comments/comment-player-timeline.mdx +++ b/ui-customization/features/async/comments/comment-player-timeline.mdx @@ -1,5 +1,6 @@ --- title: "Comment Player Timeline" +description: "Customize the Velt Comment Player Timeline component — disable Shadow DOM, style timestamped video comments, and theme the scrubber to match your player." --- ![](/images/customization/comments/comment-player-timeline/comment-player-timeline.png) diff --git a/ui-customization/features/async/comments/comment-sidebar-button/primitives.mdx b/ui-customization/features/async/comments/comment-sidebar-button/primitives.mdx index dae8d4904..fba43b1fd 100644 --- a/ui-customization/features/async/comments/comment-sidebar-button/primitives.mdx +++ b/ui-customization/features/async/comments/comment-sidebar-button/primitives.mdx @@ -1,6 +1,6 @@ --- title: Comments Sidebar Button Primitives -description: Primitive-based components for building custom Comments Sidebar Button interfaces with maximum flexibility. +description: "Primitive components for building custom Comments Sidebar Button UIs — compose the trigger button, badge, and icon from low-level Velt building blocks." --- diff --git a/ui-customization/features/async/comments/comment-sidebar-button/wireframe-variables.mdx b/ui-customization/features/async/comments/comment-sidebar-button/wireframe-variables.mdx index 39b36342b..1ed48d952 100644 --- a/ui-customization/features/async/comments/comment-sidebar-button/wireframe-variables.mdx +++ b/ui-customization/features/async/comments/comment-sidebar-button/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Comment Sidebar Button Wireframe Variables -description: Template variables exposed by the Comment Sidebar Button wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Comment Sidebar Button wireframe — bind unread count, label, and active state data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/comments/comment-sidebar-button/wireframes.mdx b/ui-customization/features/async/comments/comment-sidebar-button/wireframes.mdx index 71695787e..9ef80d930 100644 --- a/ui-customization/features/async/comments/comment-sidebar-button/wireframes.mdx +++ b/ui-customization/features/async/comments/comment-sidebar-button/wireframes.mdx @@ -1,6 +1,6 @@ --- title: Comments Sidebar Button Wireframes -description: Wireframe components for building custom Comments Sidebar Button interfaces with maximum flexibility. +description: "Wireframe components for building custom Comments Sidebar Button UIs — override the trigger button, badge, and label with your own HTML and styling." --- diff --git a/ui-customization/features/async/comments/comment-sidebar-structure-v2.mdx b/ui-customization/features/async/comments/comment-sidebar-structure-v2.mdx index 641c0e529..9db30d04f 100644 --- a/ui-customization/features/async/comments/comment-sidebar-structure-v2.mdx +++ b/ui-customization/features/async/comments/comment-sidebar-structure-v2.mdx @@ -1,6 +1,6 @@ --- title: "Comments Sidebar V2 — Structure" -description: "Canonical structure for the Velt Comments Sidebar V2 Wireframe. Order follows the provided JSX. Parent/child is defined ONLY by dot-path extensions. Direct children with no descendants are marked (Leaf)." +description: "Canonical Velt Comments Sidebar V2 wireframe structure — parent/child dot-paths, leaf nodes, and the full component tree reference for React customization." --- > **Conventions** diff --git a/ui-customization/features/async/comments/comment-sidebar-structure.mdx b/ui-customization/features/async/comments/comment-sidebar-structure.mdx index 9fd6abb91..0aecc4ed4 100644 --- a/ui-customization/features/async/comments/comment-sidebar-structure.mdx +++ b/ui-customization/features/async/comments/comment-sidebar-structure.mdx @@ -1,6 +1,6 @@ --- title: "Comments Sidebar — Structure" -description: "Canonical structure for the Velt Comments Sidebar Wireframe (React only). Order follows your provided JSX. Parent/child is defined ONLY by dot-path extensions. Direct children with no descendants are marked (Leaf)." +description: "Canonical Velt Comments Sidebar wireframe structure for React — parent/child dot-paths, leaf nodes, and the full component tree reference for customization." --- > **Conventions** diff --git a/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-components.mdx b/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-components.mdx index 273aa2df2..0b7889475 100644 --- a/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-components.mdx +++ b/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-components.mdx @@ -1,6 +1,6 @@ --- title: "Comment Sidebar v1 Wireframes" -description: "Comment Sidebar Component." +description: "Wireframe components for building custom Comment Sidebar v1 UIs — override the header, filters, threads list, and search panel with your own HTML." --- diff --git a/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-v2-primitives.mdx b/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-v2-primitives.mdx index 9445695a1..e5ab645db 100644 --- a/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-v2-primitives.mdx +++ b/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-v2-primitives.mdx @@ -1,6 +1,6 @@ --- title: Comment Sidebar V2 Primitives -description: 56+ primitive components for building custom Comment Sidebar V2 interfaces with maximum flexibility. +description: "56+ primitive components for building custom Comment Sidebar V2 UIs — compose threads, filters, search, and header from low-level Velt building blocks." --- diff --git a/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-v2-wireframes.mdx b/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-v2-wireframes.mdx index b795cc33c..fe47494f2 100644 --- a/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-v2-wireframes.mdx +++ b/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-v2-wireframes.mdx @@ -1,6 +1,6 @@ --- title: "Comment Sidebar v2 Wireframes" -description: "Comment Sidebar V2 Component — primitive-based wireframe with 27+ standalone primitives." +description: "Primitive-based Comment Sidebar V2 wireframe with 27+ standalone primitives — override the header, filters, threads list, and search with your own HTML." --- diff --git a/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-wireframe-variables.mdx b/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-wireframe-variables.mdx index aa4077ace..67371389e 100644 --- a/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-wireframe-variables.mdx +++ b/ui-customization/features/async/comments/comment-sidebar/comment-sidebar-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Comment Sidebar Wireframe Variables -description: Template variables exposed by the Comment Sidebar wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Comment Sidebar wireframe — bind thread, filter, search, and unread count data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/comments/comment-tool-wireframe-variables.mdx b/ui-customization/features/async/comments/comment-tool-wireframe-variables.mdx index 9e50319c5..0ef5acc41 100644 --- a/ui-customization/features/async/comments/comment-tool-wireframe-variables.mdx +++ b/ui-customization/features/async/comments/comment-tool-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Comment Tool Wireframe Variables -description: Template variables exposed by the Comment Tool wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Comment Tool wireframe — bind toggle state, mode, and label data for dynamic rendering and conditional comment tool UI." --- diff --git a/ui-customization/features/async/comments/comment-tool.mdx b/ui-customization/features/async/comments/comment-tool.mdx index 082628dd2..d428279f3 100644 --- a/ui-customization/features/async/comments/comment-tool.mdx +++ b/ui-customization/features/async/comments/comment-tool.mdx @@ -1,6 +1,6 @@ --- title: Comment Tool -description: The button to add new comments. +description: "Customize the Velt Comment Tool — the button used to enter comment mode and add new comments anywhere in your app via wireframes, slots, and styling." --- diff --git a/ui-customization/features/async/comments/comment-video-player.mdx b/ui-customization/features/async/comments/comment-video-player.mdx index 0cdef398b..834d9a9b2 100644 --- a/ui-customization/features/async/comments/comment-video-player.mdx +++ b/ui-customization/features/async/comments/comment-video-player.mdx @@ -1,5 +1,6 @@ --- title: "Velt Video Player" +description: "Customize the Velt Video Player component for video comments — disable Shadow DOM, override playback controls, and style timestamps to match your app." --- ![](/images/customization/comments/velt-video-player/video-player.png) diff --git a/ui-customization/features/async/comments/confirm-dialog.mdx b/ui-customization/features/async/comments/confirm-dialog.mdx index d66febfdd..607ad9c2f 100644 --- a/ui-customization/features/async/comments/confirm-dialog.mdx +++ b/ui-customization/features/async/comments/confirm-dialog.mdx @@ -1,6 +1,6 @@ --- title: Confirmation Dialog -description: The Confirmation Dialog that appears when you delete a comment annotation. +description: "Customize the Velt Confirmation Dialog that appears when deleting a comment annotation — override the title, message, and action buttons with your own UI." --- diff --git a/ui-customization/features/async/comments/inline-comments-section/primitives.mdx b/ui-customization/features/async/comments/inline-comments-section/primitives.mdx index d186449cf..3f708f680 100644 --- a/ui-customization/features/async/comments/inline-comments-section/primitives.mdx +++ b/ui-customization/features/async/comments/inline-comments-section/primitives.mdx @@ -1,6 +1,6 @@ --- title: Inline Comments Section Primitives -description: Primitive-based components for building custom Inline Comments Section interfaces with maximum flexibility. +description: "Primitive components for building custom Inline Comments Section UIs — compose inline thread lists, composers, and reactions from low-level Velt blocks." --- diff --git a/ui-customization/features/async/comments/inline-comments-section/wireframe-variables.mdx b/ui-customization/features/async/comments/inline-comments-section/wireframe-variables.mdx index f77735846..f8beb2627 100644 --- a/ui-customization/features/async/comments/inline-comments-section/wireframe-variables.mdx +++ b/ui-customization/features/async/comments/inline-comments-section/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Inline Comments Section Wireframe Variables -description: Template variables exposed by the Inline Comments Section wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Inline Comments Section wireframe — bind thread, comment, and target element data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/comments/inline-comments-section/wireframes.mdx b/ui-customization/features/async/comments/inline-comments-section/wireframes.mdx index 853ea27a8..c4b90f424 100644 --- a/ui-customization/features/async/comments/inline-comments-section/wireframes.mdx +++ b/ui-customization/features/async/comments/inline-comments-section/wireframes.mdx @@ -1,6 +1,6 @@ --- title: Inline Comments Section Wireframes -description: Wireframe components for building custom Inline Comments Section interfaces with maximum flexibility. +description: "Wireframe components for building custom Inline Comments Section UIs — override inline thread lists, composers, and reactions with your own HTML." --- diff --git a/ui-customization/features/async/comments/multithread-comments/primitives.mdx b/ui-customization/features/async/comments/multithread-comments/primitives.mdx index 85e1c891b..9ac9b88e5 100644 --- a/ui-customization/features/async/comments/multithread-comments/primitives.mdx +++ b/ui-customization/features/async/comments/multithread-comments/primitives.mdx @@ -1,6 +1,6 @@ --- title: MultiThread Comment Dialog Primitives -description: Primitive-based components for building custom MultiThread Comment Dialog interfaces with maximum flexibility. +description: "Primitive components for building custom Multithread Comment Dialog UIs — compose multiple threads, composers, and reactions from low-level Velt blocks." --- diff --git a/ui-customization/features/async/comments/multithread-comments/wireframe-variables.mdx b/ui-customization/features/async/comments/multithread-comments/wireframe-variables.mdx index 720c224b2..a1084b0d3 100644 --- a/ui-customization/features/async/comments/multithread-comments/wireframe-variables.mdx +++ b/ui-customization/features/async/comments/multithread-comments/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Multithread Comments Wireframe Variables -description: Template variables exposed by the Multithread Comments wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Multithread Comments wireframe — bind thread list, active thread, and reply data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/comments/multithread-comments/wireframes.mdx b/ui-customization/features/async/comments/multithread-comments/wireframes.mdx index aad7a70c2..98c11eb9d 100644 --- a/ui-customization/features/async/comments/multithread-comments/wireframes.mdx +++ b/ui-customization/features/async/comments/multithread-comments/wireframes.mdx @@ -1,6 +1,6 @@ --- title: MultiThread Comment Dialog Wireframes -description: Wireframe components for building custom MultiThread Comment Dialog interfaces with maximum flexibility. +description: "Wireframe components for building custom Multithread Comment Dialog UIs — override the thread list, active thread, and replies with your own HTML." --- diff --git a/ui-customization/features/async/comments/persistent-comment-mode-banner.mdx b/ui-customization/features/async/comments/persistent-comment-mode-banner.mdx index 683bb954d..e83025f1f 100644 --- a/ui-customization/features/async/comments/persistent-comment-mode-banner.mdx +++ b/ui-customization/features/async/comments/persistent-comment-mode-banner.mdx @@ -1,6 +1,6 @@ --- title: Persistent Comment Mode Banner -description: The persistent comment mode banner that appears when persistent mode is enabled and user is adding a comment. +description: "Customize the Velt Persistent Comment Mode Banner shown when persistent commenting is enabled and a user is adding a comment — override copy and styling." --- We recommend that you familiarize yourselves with [UI Customization Concepts](/ui-customization/overview) before attempting to modify any components. diff --git a/ui-customization/features/async/comments/standalone-components/comment-composer.mdx b/ui-customization/features/async/comments/standalone-components/comment-composer.mdx index dfe18ad96..ed4beb86e 100644 --- a/ui-customization/features/async/comments/standalone-components/comment-composer.mdx +++ b/ui-customization/features/async/comments/standalone-components/comment-composer.mdx @@ -1,5 +1,6 @@ --- title: Comment Composer +description: "Velt Comment Composer standalone component — a thin wrapper around the Comment Dialog Composer for embedding rich comment input anywhere in your app." --- We recommend that you familiarize yourselves with [UI Customization Concepts](/ui-customization/overview) before attempting to modify any components. diff --git a/ui-customization/features/async/comments/standalone-components/comment-thread.mdx b/ui-customization/features/async/comments/standalone-components/comment-thread.mdx index 54fc5f6e8..5385450e6 100644 --- a/ui-customization/features/async/comments/standalone-components/comment-thread.mdx +++ b/ui-customization/features/async/comments/standalone-components/comment-thread.mdx @@ -1,5 +1,6 @@ --- title: Comment Thread +description: "Velt Comment Thread standalone component — a thin wrapper around the Comment Dialog for embedding a full comment thread UI anywhere in your app." --- We recommend that you familiarize yourselves with [UI Customization Concepts](/ui-customization/overview) before attempting to modify any components. diff --git a/ui-customization/features/async/comments/text-comment-primitives.mdx b/ui-customization/features/async/comments/text-comment-primitives.mdx index 104735d0c..f275bc067 100644 --- a/ui-customization/features/async/comments/text-comment-primitives.mdx +++ b/ui-customization/features/async/comments/text-comment-primitives.mdx @@ -1,6 +1,6 @@ --- title: Text Comment Primitives -description: Primitive-based components for building custom Text Comment interfaces with maximum flexibility. +description: "Primitive components for building custom Text Comment UIs — compose inline text annotations, highlights, and threaded replies from low-level Velt blocks." --- diff --git a/ui-customization/features/async/comments/text-comment-wireframe-variables.mdx b/ui-customization/features/async/comments/text-comment-wireframe-variables.mdx index 0fc54f14a..dc4aade06 100644 --- a/ui-customization/features/async/comments/text-comment-wireframe-variables.mdx +++ b/ui-customization/features/async/comments/text-comment-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Text Comment Wireframe Variables -description: Template variables exposed by the Text Comment wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Text Comment wireframe — bind highlighted text, annotation, and selection range data for dynamic content and UI." --- diff --git a/ui-customization/features/async/comments/text-comment/text-comment-tool/primitives.mdx b/ui-customization/features/async/comments/text-comment/text-comment-tool/primitives.mdx index 35fe1a755..74bc88e6c 100644 --- a/ui-customization/features/async/comments/text-comment/text-comment-tool/primitives.mdx +++ b/ui-customization/features/async/comments/text-comment/text-comment-tool/primitives.mdx @@ -1,6 +1,6 @@ --- title: Text Comment Tool Primitives -description: Primitive-based components for building custom Text Comment Tool interfaces with maximum flexibility. +description: "Primitive components for building custom Text Comment Tool UIs — compose the text annotation trigger button, icon, and label from low-level Velt blocks." --- diff --git a/ui-customization/features/async/comments/text-comment/text-comment-tool/wireframes.mdx b/ui-customization/features/async/comments/text-comment/text-comment-tool/wireframes.mdx index 89542d234..c930fca1b 100644 --- a/ui-customization/features/async/comments/text-comment/text-comment-tool/wireframes.mdx +++ b/ui-customization/features/async/comments/text-comment/text-comment-tool/wireframes.mdx @@ -1,6 +1,6 @@ --- title: Text Comment Tool Wireframes -description: Wireframe components for building custom Text Comment Tool interfaces with maximum flexibility. +description: "Wireframe components for building custom Text Comment Tool UIs — override the text annotation trigger button, icon, and label with your own HTML." --- We recommend that you familiarize yourselves with [UI Customization Concepts](/ui-customization/overview) before attempting to modify any components. diff --git a/ui-customization/features/async/comments/text-comment/text-comment-toolbar/primitives.mdx b/ui-customization/features/async/comments/text-comment/text-comment-toolbar/primitives.mdx index 4f43ea962..01c8aa78b 100644 --- a/ui-customization/features/async/comments/text-comment/text-comment-toolbar/primitives.mdx +++ b/ui-customization/features/async/comments/text-comment/text-comment-toolbar/primitives.mdx @@ -1,6 +1,6 @@ --- title: Text Comment Toolbar Primitives -description: Primitive-based components for building custom Text Comment Toolbar interfaces with maximum flexibility. +description: "Primitive components for building custom Text Comment Toolbar UIs — compose formatting controls, action buttons, and selection menus from Velt blocks." --- diff --git a/ui-customization/features/async/comments/text-comment/text-comment-toolbar/wireframes.mdx b/ui-customization/features/async/comments/text-comment/text-comment-toolbar/wireframes.mdx index 42be99e07..50e13d3fa 100644 --- a/ui-customization/features/async/comments/text-comment/text-comment-toolbar/wireframes.mdx +++ b/ui-customization/features/async/comments/text-comment/text-comment-toolbar/wireframes.mdx @@ -1,6 +1,6 @@ --- title: Text Comment Toolbar Wireframes -description: Wireframe components for building custom Text Comment Toolbar interfaces with maximum flexibility. +description: "Wireframe components for building custom Text Comment Toolbar UIs — override formatting controls, action buttons, and selection menus with your own HTML." --- diff --git a/ui-customization/features/async/inline-reactions.mdx b/ui-customization/features/async/inline-reactions.mdx index 793a567f6..ca1f15d3a 100644 --- a/ui-customization/features/async/inline-reactions.mdx +++ b/ui-customization/features/async/inline-reactions.mdx @@ -1,6 +1,6 @@ --- title: Inline Reactions Section -description: This component is used to render the reaction tool and all the reactions. +description: "Customize the Velt Inline Reactions Section — render the reaction tool and emoji reactions inline anywhere in your app, with wireframe and styling control." --- diff --git a/ui-customization/features/async/notifications/notifications-panel/primitives.mdx b/ui-customization/features/async/notifications/notifications-panel/primitives.mdx index e7863087b..a6f91f856 100644 --- a/ui-customization/features/async/notifications/notifications-panel/primitives.mdx +++ b/ui-customization/features/async/notifications/notifications-panel/primitives.mdx @@ -1,6 +1,6 @@ --- title: Notifications Panel Primitives -description: Primitive components for building custom Notifications panel interfaces. +description: "Primitive components for building custom Notifications Panel UIs — compose notification lists, filters, badges, and action buttons from low-level Velt blocks." --- diff --git a/ui-customization/features/async/notifications/notifications-panel/wireframe-variables.mdx b/ui-customization/features/async/notifications/notifications-panel/wireframe-variables.mdx index a607fef8c..6ca7c2cf6 100644 --- a/ui-customization/features/async/notifications/notifications-panel/wireframe-variables.mdx +++ b/ui-customization/features/async/notifications/notifications-panel/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Notifications Panel Wireframe Variables -description: Template variables exposed by the Notifications Panel wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Notifications Panel wireframe — bind notification, unread count, and filter data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/notifications/notifications-panel/wireframes.mdx b/ui-customization/features/async/notifications/notifications-panel/wireframes.mdx index 24d2d6b0d..a3575c294 100644 --- a/ui-customization/features/async/notifications/notifications-panel/wireframes.mdx +++ b/ui-customization/features/async/notifications/notifications-panel/wireframes.mdx @@ -1,6 +1,6 @@ --- title: Notifications Panel Wireframes -description: Wireframes for the Notifications Panel. +description: "Wireframe components for building custom Notifications Panel UIs — override the notifications list, filters, badges, and actions with your own HTML." --- diff --git a/ui-customization/features/async/notifications/notifications-tool/primitives.mdx b/ui-customization/features/async/notifications/notifications-tool/primitives.mdx index 4ae6b5d08..cada37c66 100644 --- a/ui-customization/features/async/notifications/notifications-tool/primitives.mdx +++ b/ui-customization/features/async/notifications/notifications-tool/primitives.mdx @@ -1,6 +1,6 @@ --- title: Notifications Tool Primitives -description: Pprimitive components for building custom Notifications tool interfaces with maximum flexibility. +description: "Primitive components for building custom Notifications Tool UIs — compose the bell icon, unread badge, and trigger button from low-level Velt blocks." --- diff --git a/ui-customization/features/async/notifications/notifications-tool/wireframe-variables.mdx b/ui-customization/features/async/notifications/notifications-tool/wireframe-variables.mdx index abb41e9c2..10d6662f7 100644 --- a/ui-customization/features/async/notifications/notifications-tool/wireframe-variables.mdx +++ b/ui-customization/features/async/notifications/notifications-tool/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Notifications Tool Wireframe Variables -description: Template variables exposed by the Notifications Tool wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Notifications Tool wireframe — bind unread count, bell state, and toggle data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/notifications/notifications-tool/wireframes.mdx b/ui-customization/features/async/notifications/notifications-tool/wireframes.mdx index 95bb58b37..5e6f3d4de 100644 --- a/ui-customization/features/async/notifications/notifications-tool/wireframes.mdx +++ b/ui-customization/features/async/notifications/notifications-tool/wireframes.mdx @@ -1,6 +1,6 @@ --- title: Notifications Tool Wireframes -description: Wireframes for the Notifications Tool. +description: "Wireframe components for building custom Notifications Tool UIs — override the bell icon, unread badge, and trigger button with your own HTML and styling." --- diff --git a/ui-customization/features/async/reactions-wireframe-variables.mdx b/ui-customization/features/async/reactions-wireframe-variables.mdx index 0236f4c00..498e97a7b 100644 --- a/ui-customization/features/async/reactions-wireframe-variables.mdx +++ b/ui-customization/features/async/reactions-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Reactions Wireframe Variables -description: Template variables exposed by the Reactions wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Reactions wireframe — bind emoji, reaction count, and reactor list data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/recorder/control-panel.mdx b/ui-customization/features/async/recorder/control-panel.mdx index 6e422e163..6e6f1b639 100644 --- a/ui-customization/features/async/recorder/control-panel.mdx +++ b/ui-customization/features/async/recorder/control-panel.mdx @@ -1,6 +1,6 @@ --- title: Control Panel -description: Recorder control panel component. +description: "Customize the Velt Recorder Control Panel — override record, pause, stop, and mic toggle controls with your own buttons, layout, and styling." --- diff --git a/ui-customization/features/async/recorder/media-source-settings.mdx b/ui-customization/features/async/recorder/media-source-settings.mdx index 3d6b65e12..525e5eb18 100644 --- a/ui-customization/features/async/recorder/media-source-settings.mdx +++ b/ui-customization/features/async/recorder/media-source-settings.mdx @@ -1,6 +1,6 @@ --- title: Media Source Settings -description: Media source settings component. +description: "Customize the Velt Media Source Settings component — override camera, microphone, and screen capture source selection UI with your own design." --- We recommend that you familiarize yourselves with [UI Customization Concepts](/ui-customization/overview) before attempting to modify any components. diff --git a/ui-customization/features/async/recorder/recorder-player.mdx b/ui-customization/features/async/recorder/recorder-player.mdx index d67c0eb2d..65eca6585 100644 --- a/ui-customization/features/async/recorder/recorder-player.mdx +++ b/ui-customization/features/async/recorder/recorder-player.mdx @@ -1,6 +1,6 @@ --- title: Recorder player -description: Recorder player component. This is the small player that appears when a recording is done. +description: "Customize the Velt Recorder Player — the small video player shown after a recording finishes, with override-able playback controls, timeline, and styling." --- diff --git a/ui-customization/features/async/recorder/recorder-tool.mdx b/ui-customization/features/async/recorder/recorder-tool.mdx index 7d0d939b1..c3739e182 100644 --- a/ui-customization/features/async/recorder/recorder-tool.mdx +++ b/ui-customization/features/async/recorder/recorder-tool.mdx @@ -1,6 +1,6 @@ --- title: Recorder Tool -description: The button to add new recordings. +description: "Customize the Velt Recorder Tool — the trigger button used to start new screen, camera, and audio recordings, with wireframe and slot-based overrides." --- diff --git a/ui-customization/features/async/recorder/recording-preview-steps-dialog.mdx b/ui-customization/features/async/recorder/recording-preview-steps-dialog.mdx index 506b499be..288d94243 100644 --- a/ui-customization/features/async/recorder/recording-preview-steps-dialog.mdx +++ b/ui-customization/features/async/recorder/recording-preview-steps-dialog.mdx @@ -1,6 +1,6 @@ --- title: Recording Preview Steps Dialog -description: Recording preview steps dialog component. +description: "Customize the Velt Recording Preview Steps Dialog — override the multi-step pre-record setup UI for permissions, media source, and countdown selection." --- diff --git a/ui-customization/features/async/recorder/subtitles.mdx b/ui-customization/features/async/recorder/subtitles.mdx index 550f85371..ce308210d 100644 --- a/ui-customization/features/async/recorder/subtitles.mdx +++ b/ui-customization/features/async/recorder/subtitles.mdx @@ -1,6 +1,6 @@ --- title: Subtitles -description: Subtitles component. +description: "Customize the Velt Subtitles component for recordings — override caption rendering, positioning, fonts, and styling for accessibility and brand consistency." --- diff --git a/ui-customization/features/async/recorder/transcription-wireframe-variables.mdx b/ui-customization/features/async/recorder/transcription-wireframe-variables.mdx index 6c4edf31c..2dbcb715d 100644 --- a/ui-customization/features/async/recorder/transcription-wireframe-variables.mdx +++ b/ui-customization/features/async/recorder/transcription-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Transcription Wireframe Variables -description: Template variables exposed by the Transcription, Subtitles, and Subtitles Dialog wireframes — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Transcription, Subtitles, and Subtitles Dialog wireframes — bind caption, speaker, and timestamp data for dynamic rendering." --- diff --git a/ui-customization/features/async/recorder/transcription.mdx b/ui-customization/features/async/recorder/transcription.mdx index 6912def7c..4f826e7a0 100644 --- a/ui-customization/features/async/recorder/transcription.mdx +++ b/ui-customization/features/async/recorder/transcription.mdx @@ -1,6 +1,6 @@ --- title: Transcription -description: Transcription component. +description: "Customize the Velt Transcription component — override the transcript viewer, speaker labels, timestamps, and search UI for recorded videos and audio." --- diff --git a/ui-customization/features/async/recorder/video-editor.mdx b/ui-customization/features/async/recorder/video-editor.mdx index 190181a89..ac65af4b9 100644 --- a/ui-customization/features/async/recorder/video-editor.mdx +++ b/ui-customization/features/async/recorder/video-editor.mdx @@ -1,6 +1,6 @@ --- title: Video Editor -description: Video editor component. +description: "Customize the Velt Video Editor component — override trim, crop, and clip controls for editing screen recordings, with wireframe and styling support." --- diff --git a/ui-customization/features/async/recorder/wireframe-variables.mdx b/ui-customization/features/async/recorder/wireframe-variables.mdx index a8171f6d2..d40c6a5f2 100644 --- a/ui-customization/features/async/recorder/wireframe-variables.mdx +++ b/ui-customization/features/async/recorder/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Recorder Wireframe Variables -description: Template variables exposed by the Recorder wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Recorder wireframe — bind recording state, duration, and media source data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/rewriter/wireframe-variables.mdx b/ui-customization/features/async/rewriter/wireframe-variables.mdx index 2c06d24c8..21a3312dd 100644 --- a/ui-customization/features/async/rewriter/wireframe-variables.mdx +++ b/ui-customization/features/async/rewriter/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Rewriter Wireframe Variables -description: Template variables exposed by the Rewriter wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Rewriter wireframe — bind AI suggestion, prompt, and original text data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/async/view-analytics/wireframe-variables.mdx b/ui-customization/features/async/view-analytics/wireframe-variables.mdx index dc263a422..c2e431231 100644 --- a/ui-customization/features/async/view-analytics/wireframe-variables.mdx +++ b/ui-customization/features/async/view-analytics/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: View Analytics Wireframe Variables -description: Template variables exposed by the View Analytics wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the View Analytics wireframe — bind viewer, view count, and last-seen timestamp data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/realtime/cursors-wireframe-variables.mdx b/ui-customization/features/realtime/cursors-wireframe-variables.mdx index ef46e692b..c84b9ae72 100644 --- a/ui-customization/features/realtime/cursors-wireframe-variables.mdx +++ b/ui-customization/features/realtime/cursors-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Cursors Wireframe Variables -description: Template variables exposed by the Cursors wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Cursors wireframe — bind user identity, cursor color, and pointer position data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/realtime/cursors.mdx b/ui-customization/features/realtime/cursors.mdx index a6304d46b..5639e6266 100644 --- a/ui-customization/features/realtime/cursors.mdx +++ b/ui-customization/features/realtime/cursors.mdx @@ -1,6 +1,6 @@ --- title: Cursors -description: The Cursors component displays the cursors of users in a document. +description: "Customize the Velt Cursors component — display live multiplayer cursors with user names, colors, and avatars, and override styling with wireframes." --- diff --git a/ui-customization/features/realtime/huddle/parts.mdx b/ui-customization/features/realtime/huddle/parts.mdx index 62d6e2337..ee08ef127 100644 --- a/ui-customization/features/realtime/huddle/parts.mdx +++ b/ui-customization/features/realtime/huddle/parts.mdx @@ -1,3 +1,8 @@ +--- +title: "Huddle Tool Parts" +description: "CSS ::part() selectors exposed by the Velt Huddle Tool — target the container, button container, and button icon inside the component's Shadow DOM." +--- + diff --git a/ui-customization/features/realtime/huddle/slots.mdx b/ui-customization/features/realtime/huddle/slots.mdx index b647c1853..e9b9249ed 100644 --- a/ui-customization/features/realtime/huddle/slots.mdx +++ b/ui-customization/features/realtime/huddle/slots.mdx @@ -1,5 +1,6 @@ --- -title: "Slots" +title: "Huddle Tool Slots" +description: "Replace parts of the Velt Huddle Tool using named slots to inject custom HTML and components into the join button, participant list, and controls." --- diff --git a/ui-customization/features/realtime/huddle/variables.mdx b/ui-customization/features/realtime/huddle/variables.mdx index 0fba63195..b8c8a7f46 100644 --- a/ui-customization/features/realtime/huddle/variables.mdx +++ b/ui-customization/features/realtime/huddle/variables.mdx @@ -1 +1,6 @@ +--- +title: "Huddle Tool CSS Variables" +description: "Update CSS variables for the Velt Huddle Tool via Global Styles to customize colors, sizing, and theming across the voice and video huddle component." +--- + To update CSS variables for the Huddle Tool, please refer to [Global Styles](/global-styles/global-styles) \ No newline at end of file diff --git a/ui-customization/features/realtime/huddle/wireframe-variables.mdx b/ui-customization/features/realtime/huddle/wireframe-variables.mdx index a124c8ed4..fefb52ae8 100644 --- a/ui-customization/features/realtime/huddle/wireframe-variables.mdx +++ b/ui-customization/features/realtime/huddle/wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Huddle Wireframe Variables -description: Template variables exposed by the Huddle wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Huddle wireframe — bind participant list, audio state, and call status data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/realtime/live-selection-wireframe-variables.mdx b/ui-customization/features/realtime/live-selection-wireframe-variables.mdx index 60fb1b698..6f12e7d36 100644 --- a/ui-customization/features/realtime/live-selection-wireframe-variables.mdx +++ b/ui-customization/features/realtime/live-selection-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Live Selection Wireframe Variables -description: Template variables exposed by the Live Selection wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Live Selection wireframe — bind selected element, user, and selection range data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/realtime/live-selection.mdx b/ui-customization/features/realtime/live-selection.mdx index 60a11be1f..dcf302a60 100644 --- a/ui-customization/features/realtime/live-selection.mdx +++ b/ui-customization/features/realtime/live-selection.mdx @@ -1,5 +1,6 @@ --- title: "Live Selection" +description: "Customize the Velt Live Selection component — toggle default styling and use velt-live-selection CSS classes to highlight elements and text users select." --- ## 1. Enable/Disable Default Styling diff --git a/ui-customization/features/realtime/presence-wireframe-variables.mdx b/ui-customization/features/realtime/presence-wireframe-variables.mdx index 19fc850d7..2f3224a5f 100644 --- a/ui-customization/features/realtime/presence-wireframe-variables.mdx +++ b/ui-customization/features/realtime/presence-wireframe-variables.mdx @@ -1,6 +1,6 @@ --- title: Presence Wireframe Variables -description: Template variables exposed by the Presence wireframe — read them with velt-data, velt-if, and velt-class to drive dynamic content, conditional rendering, and class toggling. +description: "Template variables exposed by the Presence wireframe — bind user avatar, name, online state, and color data for dynamic rendering and conditional UI." --- diff --git a/ui-customization/features/realtime/presence.mdx b/ui-customization/features/realtime/presence.mdx index 0c0800e1f..ec5088710 100644 --- a/ui-customization/features/realtime/presence.mdx +++ b/ui-customization/features/realtime/presence.mdx @@ -1,6 +1,6 @@ --- title: Presence -description: The Presence component displays the avatars of users in a room. +description: "Customize the Velt Presence component — display avatars of users currently in a room or document, with override-able stack layout, tooltips, and styling." --- diff --git a/ui-customization/features/realtime/single-editor-mode.mdx b/ui-customization/features/realtime/single-editor-mode.mdx index 537cf1359..29501c2c1 100644 --- a/ui-customization/features/realtime/single-editor-mode.mdx +++ b/ui-customization/features/realtime/single-editor-mode.mdx @@ -1,6 +1,6 @@ --- title: Single Editor Mode -description: Wireframes for the Single Editor Mode Panel. +description: "Customize the Velt Single Editor Mode Panel — wireframes for the takeover banner that shows when one user is editing and others are locked to view-only." --- We recommend that you familiarize yourselves with [UI Customization Concepts](/ui-customization/overview) before attempting to modify any components. diff --git a/ui-customization/layout.mdx b/ui-customization/layout.mdx index 969a40bf9..8c9bf06e5 100644 --- a/ui-customization/layout.mdx +++ b/ui-customization/layout.mdx @@ -1,5 +1,6 @@ --- title: Layout Customization +description: "Customize the layout of Velt components by replacing default HTML with your own components, wireframes, and primitive-based structures for full control." --- # Overview diff --git a/ui-customization/localisation.mdx b/ui-customization/localisation.mdx index 6a33d5154..16f69e455 100644 --- a/ui-customization/localisation.mdx +++ b/ui-customization/localisation.mdx @@ -1,5 +1,6 @@ --- title: Localisation +description: "Localize all static strings visible in Velt SDK components by providing translations for supported locales to customize labels, tooltips, and messages." --- Localize all static strings visible in the SDK Components. diff --git a/ui-customization/overview.mdx b/ui-customization/overview.mdx index 462624311..a9c36cf82 100644 --- a/ui-customization/overview.mdx +++ b/ui-customization/overview.mdx @@ -1,5 +1,6 @@ --- -title: Overview +title: UI Customization Overview +description: "Customize Velt components five ways: layout via wireframes, styling, template variables, conditional templates, and action components for full UI control." --- Velt Components can be customized in 5 key ways: diff --git a/ui-customization/setup.mdx b/ui-customization/setup.mdx index f0a176999..43cd41138 100644 --- a/ui-customization/setup.mdx +++ b/ui-customization/setup.mdx @@ -1,5 +1,6 @@ --- title: Setup Wireframes +description: "Set up Velt wireframes as global templates that override default component rendering with your own HTML structure, styling, and nested wireframe components." --- # Understanding Wireframes diff --git a/ui-customization/styling.mdx b/ui-customization/styling.mdx index ac25a4829..ec200916d 100644 --- a/ui-customization/styling.mdx +++ b/ui-customization/styling.mdx @@ -1,5 +1,6 @@ --- title: CSS Customization +description: "Style Velt components with custom CSS, themes, and CSS variables — or visually design themes with the Velt Theme Playground for instant preview." --- diff --git a/ui-customization/template-variables.mdx b/ui-customization/template-variables.mdx index b1fca169e..87f3d4344 100644 --- a/ui-customization/template-variables.mdx +++ b/ui-customization/template-variables.mdx @@ -1,5 +1,6 @@ --- title: "Template Variables" +description: "Use Velt Template Variables to render dynamic data inside components and drive conditional templates, dynamic CSS classes, and runtime UI state." --- Template variables allow you to: diff --git a/webhooks/advanced.mdx b/webhooks/advanced.mdx index cecfd0356..0f528a550 100644 --- a/webhooks/advanced.mdx +++ b/webhooks/advanced.mdx @@ -1,5 +1,6 @@ --- -title: Advanced Webhooks +title: "Advanced Webhooks" +description: "Set up advanced Velt webhooks for enterprise plans to receive real-time event notifications on your endpoints with custom routing and signatures." --- diff --git a/webhooks/basic.mdx b/webhooks/basic.mdx index 0beda3d6f..3ffecd1f3 100644 --- a/webhooks/basic.mdx +++ b/webhooks/basic.mdx @@ -1,5 +1,6 @@ --- -title: Basic Webhooks +title: "Basic Webhooks" +description: "Configure a webhook endpoint in the Velt Console to receive real-time event notifications for Comments, Huddle, and CRDT activity in your app." --- Set up a webhook endpoint to receive real-time notifications for the following Velt events: