Skip to content

Commit 3b63c42

Browse files
committed
feat(search): integrate organization sources and private assistant
1 parent cc128f1 commit 3b63c42

420 files changed

Lines changed: 39912 additions & 3232 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎apps/docs/content/docs/search/confluence.mdx‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,24 +7,26 @@ import { Callout } from 'fumadocs-ui/components/callout'
77
import { Step, Steps } from 'fumadocs-ui/components/steps'
88
import { Image } from '@/components/ui/image'
99

10-
Search pages and blog posts from selected Confluence Cloud spaces. A Sim workspace admin configures the source, and each teammate connects their Confluence account.
10+
Search pages and blog posts from selected Confluence Cloud spaces. A Sim organization admin configures the source, and each teammate connects their Confluence account.
1111

1212
Search indexes each page's own text, including supported local callouts and code blocks. It does not expand Include Page, Excerpt Include, or third-party macros into that page. Referenced pages can be indexed separately with their own access rules.
1313

14+
These steps use your organization's **Integrations** page. For workspace Search, use **Search → Add source** instead; **Create & Invite** is the workspace equivalent of **Add source**.
15+
1416
## Choose a connection method
1517

1618
| Method | Who supplies the content? | What teammates do |
1719
| --- | --- | --- |
1820
| **Admin or service account** | One account syncs content, space permissions, page restrictions, and group membership. | Connect their own Confluence account so Sim can match their Atlassian identity to those permissions. |
1921
| **Member accounts** | Sim syncs content separately through connected members' accounts. | Connect their own Confluence account to establish which pages they can access. |
2022

21-
Use **Admin or service account** when you have a dedicated account that can read the intended spaces and their permissions. Use **Member accounts** when each person should supply their own connection. Available methods depend on your workspace's enabled features.
23+
Use **Admin or service account** when you have a dedicated account that can read the intended spaces and their permissions. Use **Member accounts** when each person should supply their own connection. Available methods depend on your organization's enabled features.
2224

2325
**Everyone still connects in both methods.** With a central account, teammates supply their identity; they do not configure another central crawl or choose spaces again.
2426

2527
## Before you start
2628

27-
- Be a **Sim workspace admin** to add the source.
29+
- Be a **Sim organization admin** to add the source.
2830
- Use a Confluence Cloud site such as `your-team.atlassian.net`. This connector does not connect to Server or Data Center.
2931
- Each teammate needs a verified Sim email matching their active Atlassian account's email.
3032
- For a central crawl, grant its account access to Confluence, the chosen spaces, and any restricted pages you want indexed. Admin status alone does not bypass page restrictions. It also needs permission to read space permissions and the user/group directory.
@@ -38,7 +40,7 @@ On hosted Sim, personal connections authorize the existing Sim app. Teammates do
3840

3941
### Choose Confluence
4042

41-
Open **Search**, click **Add source**, and choose **Confluence**. Click **Set up** or **Continue setup** if prompted. Select your **Connection method**.
43+
Open **Integrations**, click **Add source**, and choose **Confluence**. Click **Set up** or **Continue setup** if prompted. Select your **Connection method**.
4244

4345
</Step>
4446
<Step>
@@ -70,9 +72,9 @@ Keep **Content Type** at its default for pages, or choose blog posts or both. Le
7072

7173
### Save and connect your identity
7274

73-
Click **Connect & Sync** for a central account, or **Create & Invite** for member accounts. Back in Search, click **Connect account** on the Confluence row and finish the connection in the new tab. Sign in using the Atlassian email that matches your verified Sim email, and authorize the configured site.
75+
Click **Connect & Sync** for a central account, or **Add source** for member accounts. Back in Integrations, click **Connect account** on the Confluence row and finish the connection in the new tab. Sign in using the Atlassian email that matches your verified Sim email, and authorize the configured site.
7476

75-
Each teammate completes this last step. A previously authorized account may already be connected. Return to Search to see indexing status and your searchable document count.
77+
Each teammate completes this last step. A previously authorized account may already be connected. Return to Integrations to see indexing status and your searchable document count.
7678

7779
</Step>
7880
</Steps>
@@ -158,9 +160,9 @@ Search manages the schedule and hides item limits. Published/current content is
158160

159161
## Teammates and ongoing sync
160162

161-
Existing workspace members see the configured Confluence source and their own **Connect account** or **Reconnect** action. Add new teammates through your usual Sim workspace or SSO onboarding, then have them connect Confluence from Search. Connecting a Confluence account does not add someone to the Sim workspace.
163+
Existing organization members see the configured Confluence source and their own **Connect account** or **Reconnect** action. Add new teammates through your Sim organization invitation or SSO onboarding, then have them connect Confluence from Integrations. Connecting a Confluence account does not add someone to the Sim organization.
162164

163-
With a central account, Sim applies space access together with the page's restrictions and inherited ancestor restrictions. Group membership is refreshed in the background. With member accounts, each person's provider listing determines the pages available to them. A Sim workspace admin does not automatically receive access to every Confluence document.
165+
With a central account, Sim applies space access together with the page's restrictions and inherited ancestor restrictions. Group membership is refreshed in the background. With member accounts, each person's provider listing determines the pages available to them. A Sim organization admin does not automatically receive access to every Confluence document.
164166

165167
New content and permission changes require a sync and processing before Search reflects them. Open **Manage** on the source to inspect errors, edit its configuration, or trigger a sync. If your own account needs authorization again, use **Reconnect** on the source row.
166168

‎apps/docs/content/docs/search/connect-your-account.mdx‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ Your admin configures the source once. You connect your own account so Sim can e
1212
<Steps>
1313
<Step>
1414

15-
### Join your workspace
15+
### Join your organization
1616

17-
Accept your Sim workspace invitation and sign in. Use a verified Sim email that matches your account at the source. If your company uses SSO, follow its sign-in process; SSO provisioning alone does not grant workspace access.
17+
Accept your Sim organization invitation or sign in through your organization's SSO. Use a verified Sim email that matches your account at the source. Organization Search does not require workspace access.
1818

1919
</Step>
2020
<Step>
2121

22-
### Open Search
22+
### Open Integrations
2323

24-
Find the source under **Sources** and select **Connect account**. If it is missing, ask a workspace admin to add it.
24+
Open **Integrations**, find the source, and select **Connect account**. If it is missing, ask an organization admin to add it.
2525

2626
<Image src="/static/search/connect-account.png" alt="Google Drive source row with Connect account" width={1280} height={720} />
2727

@@ -32,18 +32,20 @@ Find the source under **Sources** and select **Connect account**. If it is missi
3232

3333
In the new tab, select **Connect** and complete the provider's authorization. Choose the account associated with your verified Sim email. The provider may require your organization's SSO or app approval.
3434

35-
Return to Search when the connection completes. Keep the original tab open; **Open again** resumes the connection if a popup was blocked or closed.
35+
Return to Integrations when the connection completes. Keep the original tab open; **Open again** resumes the connection if a popup was blocked or closed.
3636

3737
</Step>
3838
<Step>
3939

4040
### Start searching
4141

42-
The source row shows indexing status and how many documents are available to you. Search for something you can already open in the source. The first sync may take time, especially for large accounts.
42+
The source row shows indexing status and how many documents are available to you. Open **Home → Search** and search for something you can already open in the source. Use **Assistant** to ask a question about your connected documents. The first sync may take time, especially for large accounts.
4343

4444
</Step>
4545
</Steps>
4646

47+
For a source configured inside a workspace, join that workspace and use its **Search** page instead. Organization and workspace sources are separate.
48+
4749
## Do I always need to connect?
4850

4951
| Source setup | Your next step |
@@ -63,8 +65,8 @@ Connecting one Google service does not connect all of them. Gmail, Calendar, and
6365
| **Reconnect** | Authorize the same source account again. |
6466
| **Finish connecting in the other tab** | Finish authorization, or use **Open again**. Allow popups for Sim. |
6567
| No results | Check the source's filters and sync status with your admin. Confirm you can open the document at the source. |
66-
| Needs admin attention | Ask the workspace admin to inspect **Manage** for the source error. |
68+
| Needs admin attention | Ask your admin to inspect **Manage** for the source error. |
6769

6870
<Callout type="info">
69-
Your Sim workspace role does not override document access at the source. Connecting a different account or receiving a Search link does not share someone else's mailbox, private calendar, or restricted documents with you.
71+
Your Sim role does not override document access at the source. Connecting a different account or receiving a Search link does not share someone else's mailbox, private calendar, or restricted documents with you.
7072
</Callout>

‎apps/docs/content/docs/search/github.mdx‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ import { Callout } from 'fumadocs-ui/components/callout'
77
import { Step, Steps } from 'fumadocs-ui/components/steps'
88
import { Image } from '@/components/ui/image'
99

10-
GitHub Search indexes text files from a repository on `github.com`. A workspace admin chooses the repository, then each person connects their GitHub account. Installing the GitHub App alone does not connect your teammates.
10+
GitHub Search indexes text files from a repository on `github.com`. An organization admin chooses the repository, then each person connects their GitHub account. Installing the GitHub App alone does not connect your teammates.
11+
12+
These steps use your organization's **Integrations** page. For workspace Search, use **Search → Add source** instead; **Create & Invite** is the workspace equivalent of **Add source**.
1113

1214
## Before you start
1315

@@ -100,7 +102,7 @@ In the App's sidebar, choose **Install App**, select the target account, and gra
100102

101103
### Open GitHub setup
102104

103-
As a Sim workspace admin, open **Search**, choose **Add source**, then **GitHub**.
105+
As a Sim organization admin, open **Integrations**, choose **Add source**, then **GitHub**.
104106

105107
</Step>
106108
<Step>
@@ -116,7 +118,7 @@ Enter the repository and keep **Sync documents with → Connected members** for
116118
| Path Filter | Optional prefix such as `docs/`. |
117119
| File Extensions | Optional comma-separated list, such as `.md, .txt, .mdx`. |
118120

119-
**Document details** controls the metadata stored with results. Its defaults are suitable for most sources. Select **Create & Invite** to save the source.
121+
**Document details** controls the metadata stored with results. Its defaults are suitable for most sources. Select **Add source** to save the source.
120122

121123
You can instead select an existing account under **Sync documents with** to supply file contents centrally. Teammates still connect their own accounts to establish which files they may find.
122124

@@ -125,7 +127,7 @@ You can instead select an existing account under **Sync documents with** to supp
125127

126128
### Connect your account
127129

128-
On the GitHub source row, select **Connect account** and authorize the App. Teammates repeat this step after joining the Sim workspace. For private repositories, both the person's account and the App installation must have access. GitHub also permits App user tokens to read public repositories without an installation; see [GitHub's permission rules](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app).
130+
On the GitHub source row, select **Connect account** and authorize the App. Teammates repeat this step after joining the Sim organization. For private repositories, both the person's account and the App installation must have access. GitHub also permits App user tokens to read public repositories without an installation; see [GitHub's permission rules](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/choosing-permissions-for-a-github-app).
129131

130132
With **Connected members**, indexing begins after someone connects. A dedicated indexing account can start syncing immediately; each teammate still connects before searching. Admins can open **Manage** on the source to inspect sync progress and errors.
131133

‎apps/docs/content/docs/search/gitlab.mdx‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,15 @@ import { Callout } from 'fumadocs-ui/components/callout'
77
import { Step, Steps } from 'fumadocs-ui/components/steps'
88
import { Image } from '@/components/ui/image'
99

10-
GitLab Search uses an administrator connection to sync a project's content and permissions. Teammates do not connect individual GitLab accounts. They sign in to the Sim workspace with a verified email matching their confirmed GitLab email.
10+
GitLab Search uses an administrator connection to sync a project's content and permissions. Teammates do not connect individual GitLab accounts. They sign in to the Sim organization with a verified email matching their confirmed GitLab email.
1111

1212
<Image src="/static/search/gitlab-setup.jpg" alt="GitLab source setup in Sim Search" width={1280} height={720} />
1313

14+
These steps use your organization's **Integrations** page. For workspace Search, use **Search → Add source** instead.
15+
1416
## Before you start
1517

16-
Use a self-managed GitLab instance running version **17.4 or later**. Setup needs both a Sim workspace admin and an active GitLab **instance administrator**. A project Maintainer or group Owner is insufficient.
18+
Use a self-managed GitLab instance running version **17.4 or later**. Setup needs both a Sim organization admin and an active GitLab **instance administrator**. A project Maintainer or group Owner is insufficient.
1719

1820
<Callout type="info">
1921
This Search path requires GitLab's administrator directory and settings APIs. GitLab.com projects do not support this setup. General knowledge-base GitLab connectors can still use project-readable tokens, but their knowledge-base access rules are different from Search's source permissions.
@@ -47,7 +49,7 @@ The token must read the project, users, inherited project membership, instance s
4749

4850
### Configure the source in Sim
4951

50-
Open **Search → Add source → GitLab**. Paste the token and enter your instance host explicitly.
52+
Open **Integrations → Add source → GitLab**. Paste the token and enter your instance host explicitly.
5153

5254
| Field | What to enter |
5355
|---|---|
@@ -68,7 +70,7 @@ Select **Connect & Sync**. Sim validates the token and source policy, then start
6870

6971
### Let teammates search
7072

71-
Invite teammates to the Sim workspace using their verified work email. Sim matches that email against the GitLab directory and applies project, feature, and confidential-issue permissions. No GitLab **Connect account** step is required.
73+
Invite teammates to the Sim organization using their verified work email. Sim matches that email against the GitLab directory and applies project, feature, and confidential-issue permissions. No GitLab **Connect account** step is required.
7274

7375
Admins can open **Manage** on the source to review sync progress. Permission and membership changes are picked up during background refreshes.
7476

‎apps/docs/content/docs/search/gmail.mdx‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,20 @@ import { Callout } from 'fumadocs-ui/components/callout'
77
import { Step, Steps } from 'fumadocs-ui/components/steps'
88
import { Image } from '@/components/ui/image'
99

10-
Search email threads from your own Gmail account. A workspace admin enables the source; each teammate connects their own account. An admin's connection does not make their mailbox available to the team.
10+
Search email threads from your own Gmail account. An organization admin enables the source; each teammate connects their own account. An admin's connection does not make their mailbox available to the team.
11+
12+
These steps use your organization's **Integrations** page. For workspace Search, use **Search → Add source** instead; **Create & Invite** is the workspace equivalent of **Add source**.
1113

1214
## Set up the source
1315

14-
These steps require a Sim workspace admin.
16+
These steps require a Sim organization admin.
1517

1618
<Steps>
1719
<Step>
1820

1921
### Add Gmail
2022

21-
Open **Search → Add source → Gmail**. Gmail uses **Member accounts**; there is no domain-wide or service-account crawl in Search.
23+
Open **Integrations → Add source → Gmail**. Gmail uses **Member accounts**; there is no domain-wide or service-account crawl in Search.
2224

2325
</Step>
2426
<Step>
@@ -32,7 +34,7 @@ Keep the defaults to search all dates and labels, excluding Promotions, Social,
3234

3335
### Create the source
3436

35-
Click **Create & Invite**. Gmail appears in the **Sources** list. Each person, including the admin, then connects their own account.
37+
Click **Add source**. Gmail appears in the **Sources** list. Each person, including the admin, then connects their own account.
3638

3739
</Step>
3840
</Steps>
@@ -41,11 +43,11 @@ Click **Create & Invite**. Gmail appears in the **Sources** list. Each person, i
4143

4244
## Connect your account
4345

44-
1. Join the Sim workspace and verify your Sim email address. Open **Search** and click **Connect account** beside Gmail.
46+
1. Join the Sim organization and verify your Sim email address. Open **Integrations** and click **Connect account** beside Gmail.
4547
2. Complete the connection in the tab that opens. Choose the Google account whose verified email matches your Sim email, and grant the requested permissions.
46-
3. Return to Search. The source shows its indexing status and the number of documents you can search.
48+
3. Return to Integrations. The source shows its indexing status and the number of documents you can search.
4749

48-
Teammates follow these same steps after joining the workspace. They do not configure the source again. If Gmail has not been added yet, ask a workspace admin to add it.
50+
Teammates follow these same steps after joining the organization. They do not configure the source again. If Gmail has not been added yet, ask an organization admin to add it.
4951

5052
## Source options
5153

@@ -76,7 +78,7 @@ Search schedules syncs hourly. The first sync and large mailboxes can take longe
7678
| No searchable documents | Check the source's labels, date range, category exclusions, and search filter. Allow the first sync to finish. |
7779
| Finish connecting in the other tab | Complete the Google flow. If the tab was blocked or closed, allow pop-ups and click **Open again**. |
7880
| Reconnect | Click **Reconnect** and authorize the same account again. |
79-
| Unavailable or needs admin attention | Ask the workspace admin to check source status and the deployment's Google OAuth configuration. |
81+
| Unavailable or needs admin attention | Ask your Sim admin to check source status and the deployment's Google OAuth configuration. |
8082

8183
## Self-hosted operator setup
8284

0 commit comments

Comments
 (0)