Skip to content

Commit 9f6e66e

Browse files
committed
fix(search): verify setup recovery and refresh guides
1 parent 931e7d3 commit 9f6e66e

46 files changed

Lines changed: 1430 additions & 121 deletions

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: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,8 @@ Keep **Content Type** at its default for pages, or choose blog posts or both. Le
6363
<Image
6464
src="/static/search/confluence-setup.jpg"
6565
alt="Confluence Search source configuration showing connection method, account, domain, and spaces"
66-
width={1280}
67-
height={720}
66+
width={1470}
67+
height={1277}
6868
/>
6969

7070
</Step>
@@ -164,7 +164,7 @@ Existing organization members see the configured Confluence source and their own
164164

165165
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.
166166

167-
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.
167+
New content and permission changes require a sync and processing before Search reflects them. Open the source under **Settings → Integrations → Providers** to inspect errors, edit its configuration, or trigger a sync. If your own account needs authorization again, use **Reconnect** on the source row.
168168

169169
## Troubleshooting
170170

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

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,8 @@ Accept your Sim organization invitation or sign in through your organization's S
2323

2424
Open **Integrations**, find the provider or source, and select **Connect account**. Your first connection may ask for required source settings, such as repository or project names. If the provider is missing, ask an organization admin to approve it.
2525

26-
<Image src="/static/search/connect-account.png" alt="Google Drive source row with Connect account" width={1280} height={720} />
26+
<Image src="/static/search/connect-account.png" alt="Organization Integrations with an approved Gmail provider and Connect account action" width={1470} height={1277} />
2727

28-
*Workspace Search is shown here. Organization sources are managed in Settings → Integrations.*
2928

3029
</Step>
3130
<Step>
@@ -67,7 +66,7 @@ Connecting one Google service does not connect all of them. Gmail, Calendar, and
6766
| **Reconnect** | Authorize the same source account again. |
6867
| **Finish connecting in the other tab** | Finish authorization, or use **Open again**. Allow popups for Sim. |
6968
| No results | Check the source's filters and sync status with your admin. Confirm you can open the document at the source. |
70-
| Needs admin attention | Ask your admin to inspect **Manage** for the source error. |
69+
| Needs admin attention | Ask your admin to open the source in **Settings → Integrations → Providers** to inspect its error. |
7170

7271
<Callout type="info">
7372
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.

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,8 @@ As a Sim organization admin, open **Settings → Integrations → Providers**, a
111111

112112
Enter the repository and keep **Sync documents with → Connected members** for the usual setup.
113113

114+
<Image src="/static/search/github-setup.jpg" alt="GitHub source configuration with account, repository, branch, and path fields" width={1470} height={1277} />
115+
114116
| Field | What to enter |
115117
|---|---|
116118
| Repository | `owner/repo`. Add another source for another repository. |
@@ -129,7 +131,7 @@ You can instead select an existing account under **Sync documents with** to supp
129131

130132
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).
131133

132-
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.
134+
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 the source under **Settings → Integrations → Providers** to inspect sync progress and errors.
133135

134136
</Step>
135137
</Steps>

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ import { Image } from '@/components/ui/image'
99

1010
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

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

1414
Admin setup uses your organization's **Settings → Integrations** page. Teammates do not need a personal GitLab connection. For workspace Search, use **Search → Add source** instead.
1515

@@ -61,7 +61,7 @@ Open **Settings → Integrations → Providers**, approve **GitLab**, then selec
6161
| Issue State / Labels / Milestone | Optional filters for issues. |
6262
| Max Items | Optional positive limit. Leave blank for all matching items. |
6363

64-
<Image src="/static/search/gitlab-options.jpg" alt="GitLab source configuration scrolled to repository and issue filters, item limit, and document details" width={1280} height={720} />
64+
<Image src="/static/search/gitlab-options.jpg" alt="GitLab source configuration scrolled to repository and issue filters, item limit, and document details" width={1470} height={1277} />
6565

6666
Select **Connect & Sync**. Sim validates the token and source policy, then starts indexing.
6767

@@ -72,7 +72,7 @@ Select **Connect & Sync**. Sim validates the token and source policy, then start
7272

7373
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.
7474

75-
Admins can open **Manage** on the source to review sync progress. Permission and membership changes are picked up during background refreshes.
75+
Admins can open the source under **Settings → Integrations → Providers** to review sync progress. Permission and membership changes are picked up during background refreshes.
7676

7777
</Step>
7878
</Steps>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Click **Add source**. Gmail appears in the **Sources** list. Each person, includ
3939
</Step>
4040
</Steps>
4141

42-
<Image src="/static/search/gmail-setup.jpg" alt="Gmail Search source configuration" width={1280} height={720} />
42+
<Image src="/static/search/gmail-setup.jpg" alt="Gmail Search source configuration" width={1470} height={1277} />
4343

4444
## Connect your account
4545

@@ -51,7 +51,7 @@ Teammates follow these same steps after joining the organization. Once an admin
5151

5252
## Source options
5353

54-
An admin can change these under **Manage** on the Gmail source. Filters apply separately to each connected mailbox.
54+
An admin can change these in the Gmail source's **Settings** tab. Filters apply separately to each connected mailbox.
5555

5656
| Option | Behavior |
5757
| --- | --- |

apps/docs/content/docs/search/google-calendar.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ Keep the default date range for the previous and next 30 days, then click **Add
4141
</Step>
4242
</Steps>
4343

44-
<Image src="/static/search/google-calendar-setup.jpg" alt="Google Calendar Search source configuration" width={1280} height={720} />
44+
<Image src="/static/search/google-calendar-setup.jpg" alt="Google Calendar Search source configuration" width={1470} height={1277} />
4545

4646
<Callout type="info">
4747
`primary` means the connected person's main calendar. A calendar selected from the list is a specific calendar ID, even when it is your main calendar. That same ID applies to every member, and only members with access to it can search its events.
@@ -57,7 +57,7 @@ Teammates repeat only these connection steps after joining the organization. The
5757

5858
## Source options
5959

60-
An admin can change these under **Manage** on the source.
60+
An admin can change these in the source's **Settings** tab.
6161

6262
| Option | Behavior |
6363
| --- | --- |

apps/docs/content/docs/search/google-drive.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Select **Add source**, then **Connect account** on the source row. Use the Googl
5454

5555
This requires a Google Workspace domain and a Workspace super administrator to authorize domain-wide delegation. Consumer Gmail accounts cannot use this path.
5656

57-
<Image src="/static/search/google-drive-setup.jpg" alt="Google Drive Search service-account connection and source options" width={1280} height={720} />
57+
<Image src="/static/search/google-drive-setup.jpg" alt="Google Drive service-account setup with Crawl as and manual folder fields" width={1470} height={1277} />
5858

5959
<Steps>
6060
<Step>
@@ -95,7 +95,7 @@ These are Search's central crawl scopes. The general [Google service account gui
9595

9696
In Google Drive's Search setup, choose **Service account**. Open the **Service account** picker, choose its connection action, and paste the JSON key into **Add Google Service Account**. Give it a name and add it. Sim returns you to the source form with that credential selected.
9797

98-
<Image src="/static/search/google-service-account.jpg" alt="Add Google Service Account credential modal in Sim" width={1280} height={720} />
98+
<Image src="/static/search/google-service-account.jpg" alt="Add Google Service Account credential modal in Sim" width={1470} height={1277} />
9999

100100
</Step>
101101
<Step>
@@ -119,14 +119,14 @@ Set **Crawl as** to a Google Workspace administrator who can read groups, member
119119

120120
Sim exports Docs and Slides as text and Sheets as XLSX spreadsheets. Supported uploaded files use the knowledge-base document pipeline, including PDF and Office formats. Unsupported files and oversized exports cannot be indexed; Google limits Workspace exports to 10 MB. See [Drive export formats](https://developers.google.com/workspace/drive/api/guides/ref-export-formats) and [download limits](https://developers.google.com/workspace/drive/api/guides/manage-downloads).
121121

122-
Search schedules syncs hourly. Content, deletions, and permissions refresh in the background; results are not a live read from Drive. Admins can inspect progress and errors through **Manage** on the source.
122+
Search schedules syncs hourly. Content, deletions, and permissions refresh in the background; results are not a live read from Drive. Admins can inspect progress and errors by opening the source under **Settings → Integrations → Providers**.
123123

124124
## Troubleshooting
125125

126126
| Problem | Next step |
127127
| --- | --- |
128128
| Directory access failed | Check the delegated scopes and the **Crawl as** user's administrator privileges. A normal Google OAuth credential cannot supply this central Search path. |
129-
| An existing central source uses a normal Google OAuth account | Replace it with a delegated service account. If the source is **Disabled**, choose **Resume** first. Then open **Manage**, select or add the delegated service account, and choose **Change indexing account**. A **Paused** source can change credentials before you resume it. |
129+
| An existing central source uses a normal Google OAuth account | Open the source's **Settings** tab, select or add a delegated service account, and choose **Change indexing account**. If the source is **Paused** or **Disabled**, choose **Resume** after updating the account. |
130130
| Missing files in a central crawl | Open them as the **Crawl as** user. Delegation does not grant that user access to all domain files. Check folder and file-type filters. |
131131
| A teammate sees no results | Confirm their verified Sim email matches the Drive permission or group membership. For member accounts, finish their personal Drive connection too. |
132132
| A public or shared-link file is missing | Check **Openly shared files**. Link-only sharing does not grant Search access. A named user or group permission can still make the file searchable. |

apps/docs/content/docs/search/index.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,8 @@ In **Integrations**, select **Connect account** if prompted—even if you create
3939
</Step>
4040
</Steps>
4141

42-
<Image src="/static/search/add-source.jpg" alt="Sim Search source catalog with Set up actions" width={1280} height={720} />
42+
<Image src="/static/search/add-source.jpg" alt="Sim Search source catalog with Set up actions" width={1470} height={1277} />
4343

44-
*Workspace Search is shown here. Organization sources are managed in Settings → Integrations.*
4544

4645
Source availability depends on the deployment and organization policy. An unavailable source needs operator configuration before setup can continue.
4746

@@ -78,7 +77,7 @@ Some member sources offer **Sync documents with**. **Connected members** uses me
7877

7978
Invite people through the organization's **Settings → Members**, or use your organization's [SSO provisioning](/platform/enterprise/sso). Share the organization's **Home** or **Integrations** URL. People need their own Sim account and organization membership; they do not need access to a workspace. Connecting an external account alone does not grant organization membership.
8079

81-
Organization admins manage source configuration and sync status through **Manage** under **Settings → Integrations → Providers**. Other members connect or reconnect their own accounts. See [Connect your account](/search/connect-your-account) for the teammate walkthrough.
80+
Organization admins manage source configuration and sync status by opening a source under **Settings → Integrations → Providers**. Other members connect or reconnect their own accounts. See [Connect your account](/search/connect-your-account) for the teammate walkthrough.
8281

8382
## Search, Assistant, and MCP
8483

@@ -103,7 +102,9 @@ Search runs background syncs on an hourly schedule. Large sources, provider limi
103102

104103
A completed sync means the source was checked; some documents may still be indexing. The source row shows how many documents you can search and whether indexing failed for any documents you can access.
105104

106-
As an admin, open **Manage → Documents** and select **Failed** from the status dropdown to inspect those files. Use the search field to find a document by name. **Settings** contains the source configuration and **Sync history** shows recent runs. Select **Retry indexing** beside a file to try again. **Exclude** removes a file from search; select **Excluded** and then **Restore** to include it again. Fix a disconnected account or source configuration before retrying a sync that needs attention.
105+
As an admin, open the source under **Settings → Integrations → Providers**. In **Documents**, select **Failed** from the status dropdown to inspect those files. Use the search field to find a document by name. **Settings** contains the source configuration and **Sync history** shows recent runs. Select **Retry indexing** beside a file to try again. **Exclude** removes a file from search; select **Excluded** and then **Restore** to include it again. Fix a disconnected account or source configuration before retrying a sync that needs attention.
106+
107+
<Image src="/static/search/source-documents.jpg" alt="Source document page with search, status filtering, indexing recovery, and header actions" width={1470} height={1277} />
107108

108109
Temporary indexing-capacity waits retry automatically in the background. If automatic retries are exhausted, the document appears as failed so an admin can retry it. Other searchable documents remain available while this work finishes.
109110

apps/docs/content/docs/search/jira.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,9 @@ If you already know the project keys, use the switch beside **Projects** to sele
4747

4848
<Image
4949
src="/static/search/jira-setup.jpg"
50-
alt="Jira Search source setup with member accounts, an example site, and a project key"
51-
width={1280}
52-
height={720}
50+
alt="Jira Search source setup with member accounts and required site and project fields"
51+
width={1470}
52+
height={1277}
5353
/>
5454

5555
</Step>
@@ -88,7 +88,7 @@ Search manages the sync schedule. Item limits and sync frequency are not setup d
8888

8989
Existing organization members see the same source configuration and their own **Connect account**, **Reconnect**, or indexing status. They do not choose projects again. Invite new teammates to the Sim organization through its Members settings or SSO onboarding, then have them open Integrations and connect Jira. A Jira authorization does not grant Sim organization membership.
9090

91-
Sim checks Jira separately using each connected person's account. Issue content and tags become searchable as processing finishes; changes and lost issue access are picked up by later syncs. The source row reports the number of documents searchable by the current viewer. Admins can open **Manage** to review sync status or update the source.
91+
Sim checks Jira separately using each connected person's account. Issue content and tags become searchable as processing finishes; changes and lost issue access are picked up by later syncs. The source row reports the number of documents searchable by the current viewer. Admins can open the source under **Settings → Integrations → Providers** to review sync status or update the source.
9292

9393
## Troubleshooting
9494

apps/docs/content/docs/search/slack.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import { Image } from '@/components/ui/image'
88

99
Slack Search indexes channel messages and threads. A Sim organization admin configures your Slack app once, then each teammate authorizes their own Slack account. Their results are limited to the selected public channels and private channels they can access. DMs and group DMs are not indexed.
1010

11-
<Image src="/static/search/slack-setup.jpg" alt="Slack source setup in Sim Search" width={1280} height={720} />
11+
<Image src="/static/search/slack-setup.jpg" alt="Slack app setup for Sim Search with application and client credential fields" width={1470} height={1277} />
1212

1313
## Before you start
1414

@@ -76,7 +76,7 @@ Select **Add source**. On the source row, each person selects **Connect account*
7676

7777
You can instead select an existing account under **Sync documents with** to supply message content centrally. Members still connect their own accounts to establish access. The selected account must itself be able to read the selected channels.
7878

79-
Admins can use **Manage** to inspect sync progress. Search reads the indexed content, so source changes appear after background syncing. Slack retention and API limits determine how much history is available.
79+
Admins can open the source under **Settings → Integrations → Providers** to inspect sync progress. Search reads the indexed content, so source changes appear after background syncing. Slack retention and API limits determine how much history is available.
8080

8181
## Permissions reference
8282

0 commit comments

Comments
 (0)