Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .mintignore
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,19 @@ scripts/
# build (e.g. "Could not parse import/exports with acorn").
.pipeline-scratch/
.claude/

# Internal repo docs, authoring templates, and the repo README — not docs pages.
# These were being published as /CLAUDE, /README, /SKILLS_SYNC_PIPELINE, and
# /WIREFRAME_VARIABLES_TEMPLATE on the live site.
/CLAUDE.md
/README.md
/SKILLS_SYNC_PIPELINE.md
/WIREFRAME_VARIABLES_TEMPLATE.md

# Scratch release-notes pipeline artifacts left in the repo root.
/temp-release-notes.mdx
/temp-release-notes-input.mdx

# GitHub workflow + automation docs (e.g. the release-note pipeline README,
# which references internal repositories).
.github/
2 changes: 1 addition & 1 deletion SKILLS_SYNC_PIPELINE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Every push to `velt-js/docs/main` touching one of the watched paths runs `.githu

```
async-collaboration/** realtime-collaboration/**
api-reference/rest-apis/** self-host-data/**
api-reference/rest-apis/** self-hosting/partial/**
security/** webhooks/**
get-started/** backend-sdks/**
ui-customization/** permission-management/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Use this API to add notifications.
</ParamField>

<ParamField body="isNotificationResolverUsed" type="boolean">
Set to `true` to enable [Notification Resolver](/self-host-data/notifications) mode.
Set to `true` to enable [Notification Resolver](/self-hosting/partial/notifications) mode.
When enabled, `displayHeadlineMessageTemplate` and `displayBodyMessage` are not required — notification content is resolved from your own infrastructure at read time.
</ParamField>

Expand Down Expand Up @@ -99,7 +99,7 @@ Use this API to add notifications.
</ParamField>

<ParamField body="notificationSource" type="string">
Source identifier for the notification. Set to `'custom'` for notifications that should be routed through the [Notification Resolver](/self-host-data/notifications). Other values include `'comment'`, `'huddle'`, and `'crdt'`.
Source identifier for the notification. Set to `'custom'` for notifications that should be routed through the [Notification Resolver](/self-hosting/partial/notifications). Other values include `'comment'`, `'huddle'`, and `'crdt'`.
</ParamField>

<ParamField body="notificationSourceData" type="object">
Expand Down Expand Up @@ -247,7 +247,7 @@ When context is provided, notifications will be filtered based on the specified

## **Example Request with Notification Resolver**

Use this when notification content (headline, body) is stored on your own infrastructure and resolved at read time via the [Notification Resolver](/self-host-data/notifications). Omit `displayHeadlineMessageTemplate` and `displayBodyMessage` and set `notificationSource` to `'custom'`.
Use this when notification content (headline, body) is stored on your own infrastructure and resolved at read time via the [Notification Resolver](/self-hosting/partial/notifications). Omit `displayHeadlineMessageTemplate` and `displayBodyMessage` and set `notificationSource` to `'custom'`.

```JSON
{
Expand Down
2 changes: 1 addition & 1 deletion api-reference/sdk/api/api-methods.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3839,7 +3839,7 @@ Set the data providers for self hosting data.
- Params: [`VeltDataProvider`](/api-reference/sdk/models/data-models#veltdataprovider)
- Returns: `void`
- React Hook: `n/a`
- [Full Documentation →](/self-host-data/overview)
- [Full Documentation →](/self-hosting/partial/overview)

#### setAnonymousUserDataProvider()
Register a provider to resolve email → userId mappings for anonymous users tagged by email in comments.
Expand Down
10 changes: 5 additions & 5 deletions api-reference/sdk/models/data-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4524,7 +4524,7 @@ Self-hosting configuration that maps Velt collections to custom Firestore paths.

| Property | Type | Required | Description |
| ----------------------- | -------- | -------- | ---------------------------------------------------------------------------------------------------------- |
| `userNotificationIndex` | `string` | No | Path to the global, per-user notification index collection (org-independent). Required for cross-organization "For You" notifications. See [Cross-Organization Notifications](/self-host-data/notifications#cross-organization-notifications). |
| `userNotificationIndex` | `string` | No | Path to the global, per-user notification index collection (org-independent). Required for cross-organization "For You" notifications. See [Cross-Organization Notifications](/self-hosting/partial/notifications#cross-organization-notifications). |

#### NotificationSettingsLayout

Expand Down Expand Up @@ -5809,7 +5809,7 @@ Element type of [`ResolverConfig.additionalSaveEvents`](#resolverconfig).

Enum defining module names for user-related resolver operations. Used in data provider events to identify which module triggered the resolver call.

[Self-Host User Data →](/self-host-data/users#debugging)
[Self-Host User Data →](/self-hosting/partial/users#debugging)

| Name | Value | Description |
| ------------------------- | ------------------------- | -------------------------------------------------------- |
Expand All @@ -5825,7 +5825,7 @@ Enum defining module names for user-related resolver operations. Used in data pr

Enum defining module names for comment-related resolver operations. Used in data provider events to identify which module triggered the resolver call.

[Self-Host Comment Data →](/self-host-data/comments#debugging)
[Self-Host Comment Data →](/self-hosting/partial/comments#debugging)

| Name | Value | Description |
| ------------------------- | ------------------------- | -------------------------------------------------- |
Expand All @@ -5839,7 +5839,7 @@ Enum defining module names for comment-related resolver operations. Used in data

Enum defining module names for reaction-related resolver operations. Used in data provider events to identify which module triggered the resolver call.

[Self-Host Reaction Data →](/self-host-data/reactions#debugging)
[Self-Host Reaction Data →](/self-hosting/partial/reactions#debugging)

| Name | Value | Description |
| -------------------------- | -------------------------- | ------------------------------------------------- |
Expand All @@ -5852,7 +5852,7 @@ Enum defining module names for reaction-related resolver operations. Used in dat

Enum defining module names for recorder-related resolver operations. Used in data provider events to identify which module triggered the resolver call.

[Self-Host Recording Data →](/self-host-data/recordings#debugging)
[Self-Host Recording Data →](/self-hosting/partial/recordings#debugging)

| Name | Value | Description |
| -------------------------- | -------------------------- | ------------------------------------------------- |
Expand Down
2 changes: 1 addition & 1 deletion async-collaboration/comments/customize-behavior.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2240,7 +2240,7 @@ contactElement.updateContactListScopeForOrganizationUsers(['all', 'organization'

Register a provider to resolve email → `userId` mappings for users who are tagged by email in comments but are not part of the contact list. When a comment is saved and a tagged contact or `to` recipient has an email but no `userId`, the SDK calls the provider to look up the `userId` and backfills it into the comment data before persisting.

[Full implementation guide →](/self-host-data/users#anonymous-user-resolution)
[Full implementation guide →](/self-hosting/partial/users#anonymous-user-resolution)

#### autoCompleteScrollConfig

Expand Down
2 changes: 1 addition & 1 deletion backend-sdks/python.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5226,4 +5226,4 @@ sdk.selfHosting.comments.saveComments(request)
## Resources

- [Velt-Py PyPI Package](https://pypi.org/project/velt-py)
- [Self-Host Data Documentation](/self-host-data/overview)
- [Partial Self Hosting Documentation](/self-hosting/partial/overview)
103 changes: 92 additions & 11 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,14 @@
"ignore": [
".claude/**",
"node_modules/**",
"scripts/**"
"scripts/**",
".github/**",
"CLAUDE.md",
"README.md",
"SKILLS_SYNC_PIPELINE.md",
"WIREFRAME_VARIABLES_TEMPLATE.md",
"temp-release-notes.mdx",
"temp-release-notes-input.mdx"
],
"navigation": {
"tabs": [
Expand Down Expand Up @@ -341,17 +348,39 @@
]
},
{
"group": "Self-Host Data",
"group": "Self Hosting",
"pages": [
"self-host-data/overview",
"self-host-data/users",
"self-host-data/comments",
"self-host-data/reactions",
"self-host-data/attachments",
"self-host-data/recordings",
"self-host-data/activity",
"self-host-data/notifications",
"self-host-data/field-inventory"
{
"group": "Partial Self Hosting",
"pages": [
"self-hosting/partial/overview",
"self-hosting/partial/users",
"self-hosting/partial/comments",
"self-hosting/partial/reactions",
"self-hosting/partial/attachments",
"self-hosting/partial/recordings",
"self-hosting/partial/activity",
"self-hosting/partial/notifications",
"self-hosting/partial/field-inventory"
]
},
{
"group": "Full Self Hosting",
"pages": [
"self-hosting/full/overview",
{
"group": "GCP",
"pages": [
"self-hosting/full/gcp/overview",
"self-hosting/full/gcp/install",
"self-hosting/full/gcp/upgrade",
"self-hosting/full/gcp/reference"
]
},
"self-hosting/full/aws",
"self-hosting/full/azure"
]
}
]
},
{
Expand Down Expand Up @@ -1632,6 +1661,58 @@
{
"source": "/realtime-collaboration/crdt/version-history",
"destination": "/realtime-collaboration/crdt/overview"
},
{
"source": "/self-host-data/overview",
"destination": "/self-hosting/partial/overview"
},
{
"source": "/self-host-data/users",
"destination": "/self-hosting/partial/users"
},
{
"source": "/self-host-data/comments",
"destination": "/self-hosting/partial/comments"
},
{
"source": "/self-host-data/reactions",
"destination": "/self-hosting/partial/reactions"
},
{
"source": "/self-host-data/attachments",
"destination": "/self-hosting/partial/attachments"
},
{
"source": "/self-host-data/recordings",
"destination": "/self-hosting/partial/recordings"
},
{
"source": "/self-host-data/activity",
"destination": "/self-hosting/partial/activity"
},
{
"source": "/self-host-data/notifications",
"destination": "/self-hosting/partial/notifications"
},
{
"source": "/self-host-data/field-inventory",
"destination": "/self-hosting/partial/field-inventory"
},
{
"source": "/self-host-data",
"destination": "/self-hosting/partial/overview"
},
{
"source": "/self-hosting",
"destination": "/self-hosting/partial/overview"
},
{
"source": "/self-hosting/full",
"destination": "/self-hosting/full/overview"
},
{
"source": "/self-hosting/full/gcp",
"destination": "/self-hosting/full/gcp/overview"
}
],
"logo": {
Expand Down
4 changes: 2 additions & 2 deletions release-notes/version-4/sdk-changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -871,7 +871,7 @@ commentElement.on('composerTextChange').subscribe((event) => {

### New Features

- [**Self-hosting**]: Added attachment resolver support for config-based endpoints. Configure `saveConfig` and `deleteConfig` URLs for file uploads and deletions. [Learn more](/self-host-data/attachments)
- [**Self-hosting**]: Added attachment resolver support for config-based endpoints. Configure `saveConfig` and `deleteConfig` URLs for file uploads and deletions. [Learn more](/self-hosting/partial/attachments)

<Tabs>
<Tab title="React / Next.js">
Expand Down Expand Up @@ -5733,7 +5733,7 @@ Note after this update, if you plan to go back to older version of the SDK befor
### New Features
- [**Self-hosting**]: Added support to disable getting user resolver requests for organization, document and folder users. Helps optimize performance by avoiding unnecessary user data requests
- Sometimes you may have a lot of users within your organization, document or folder. In such cases, you may want to disable user resolver requests for organization, document and folder users and instead use [custom autocomplete feature](/async-collaboration/comments/customize-behavior#customautocompletesearch).
- Learn more about [user data provider](/self-host-data/users)
- Learn more about [user data provider](/self-hosting/partial/users)

<Tabs>
<Tab title="React / Next.js">
Expand Down
Loading