Skip to content

Commit 51d85c7

Browse files
committed
docs(search): remove stale mode instructions and clarify actions
1 parent 44c12fa commit 51d85c7

10 files changed

Lines changed: 29 additions & 28 deletions

File tree

‎apps/docs/content/docs/chat/index.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@ Ask Sim to build workflows, research a topic, create files, query tables, or act
3030

3131
## Start a chat [#how-it-works]
3232

33-
1. Select **New chat** in the sidebar.
34-
2. Choose **Build** for the workspace actions described in this section. Where available, **Search** answers questions from connected sources.
35-
3. Describe the task, its inputs, and the result you want.
33+
1. Select **New chat** in a workspace, or **Home** in the organization sidebar.
34+
2. Describe the task, its inputs, and the result you want.
35+
36+
For questions about connected sources, open **Search → Assistant** in the organization view. Use the **Search** tab to browse results. See [Sim Search](/search).
3637

3738
**Plan** helps research needs and develop a solution before implementation. It appears only for eligible platform administrators with **Super admin mode** enabled on a deployment that enables this capability. An organization Admin role alone does not enable it.
3839

@@ -43,7 +44,7 @@ For example:
4344
- "Create a workflow that takes a contract PDF, extracts key terms, and emails a summary to legal."
4445
- "Add a daily schedule to the prospect workflow and deploy it. At 8am America/New_York, find new high-fit prospects and post them to #outbound in Slack."
4546

46-
Chat can work across accessible resources. When you open Sim inside a workflow, that conversation is scoped to the workflow. In the organization view, **Build** requires permission to create organization workspaces; each action in an existing workspace still checks its access and enabled capabilities. Available actions depend on your role, connected accounts, workspace settings, and organization policy. Planning a solution does not by itself authorize deploying it or sending messages.
47+
Chat can work across accessible resources. When you open Sim inside a workflow, that conversation is scoped to the workflow. In the organization view, **Home** requires permission to create organization workspaces; each action in an existing workspace still checks its access and enabled capabilities. Available actions depend on your role, connected accounts, workspace settings, and organization policy. Planning a solution does not by itself authorize deploying it or sending messages.
4748

4849
## Add context [#adding-context]
4950

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,12 @@ You do not choose repositories, channels, labels, or an indexing method during p
3939
| Confluence service account | Connect Confluence. Both your account and the service connection must read the selected content. |
4040
| Coda | Connect personal Coda MCP. Service mode also verifies the parent document with its REST token. |
4141
| GitLab | No personal connection. Your verified Sim email must match current GitLab identity and permissions, or the admin's CSV mapping and project grant. |
42-
| [Generic Secrets, Member mode](/search/generic-secrets) | Select **Manage secrets** in Integrations and save your own values for Build and Plan. |
42+
| [Generic Secrets, Member mode](/search/generic-secrets) | Select **Manage secrets** in Integrations and save your own values for organization Home conversations. |
4343

4444
Gmail, Calendar, and Drive have separate grants. Connecting one does not authorize the others. Except for GitLab's permission model, a service account restricts resources rather than replacing your personal connection.
4545

46+
Creating Jira sprints requires the Jira sprint permission. If your account was connected before sprint actions were added, reconnect it to grant that permission. Existing Jira operations continue to use their existing permissions.
47+
4648
## Tool permissions
4749

4850
When Assistant integration actions are enabled, open **Integrations** and select **Tool permissions** beside your connected account. Set a preference for each operation or use the **Read-only tools** and **Write tools** group controls:
@@ -88,5 +90,3 @@ Live Search calls the provider for each request. Waiting for a Sim sync or retry
8890

8991
- [Search access and freshness](/search#access-and-freshness)
9092
- [Knowledge-base connectors](/knowledgebase/connectors)
91-
92-
Creating Jira sprints requires the Jira sprint permission. If your account was connected before sprint actions were added, reconnect it to grant that permission. Existing Jira operations continue to use their existing permissions.

‎apps/docs/content/docs/search/find-content.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,10 @@ Your organization must enable Search and make a source available to you. [Connec
1818
Read the title and excerpt to find the relevant result. Each result shows its source, with an author and date when available. Select the title to open the original.
1919

2020
<Image
21-
src="/static/search/atlas-document-results.webp"
22-
alt="Search results for the Atlas onboarding checklist in Confluence, with the organization sidebar and document excerpts"
23-
width={2660}
24-
height={900}
21+
src="/static/search/organization-search.png"
22+
alt="Organization Search with the Search and Assistant tabs above the search field"
23+
width={1440}
24+
height={1000}
2525
variant="overview"
2626
background="san-francisco"
2727
/>
@@ -54,10 +54,10 @@ If a query is too broad, add a detail you know: try `product requirements templa
5454

5555
Open the **…** menu beside a result:
5656

57-
- **Summarize** starts a Search conversation about that document. Ask a follow-up to explore it further.
57+
- **Summarize** opens **Search → Assistant** with that document. Ask a follow-up to explore it further.
5858
- **Copy link** copies the original source link. Anyone you send it to still needs access in that app.
5959

60-
For an answer that combines several documents, [ask a question in Search](/search/ask-questions).
60+
For an answer that combines several documents, [ask a question in Assistant](/search/ask-questions).
6161

6262
## Return to something you found
6363

‎apps/docs/content/docs/search/generic-secrets.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
---
22
title: Generic Secrets
3-
description: Store shared or personal secrets for Build and Plan
3+
description: Store shared or personal secrets for organization Home conversations
44
---
55

6-
Generic Secrets stores values that Build and Plan can use in code and requests. It uses the same [secrets editor as workspaces](/platform/credentials) and does not connect an external account or add searchable documents.
6+
Generic Secrets stores values that Sim can use in code and requests from an organization **Home** conversation, including **Plan** when available. It uses the same [secrets editor as workspaces](/platform/credentials) and does not connect an external account or add searchable documents.
77

88
## Add the source
99

1010
An organization admin opens **Settings → Sources → Add source → Generic Secrets** and chooses a mode:
1111

12-
| Mode | Manage values | Use in Build and Plan |
12+
| Mode | Manage values | Use in Home |
1313
| --- | --- | --- |
14-
| **Organization** | Admins open **Secrets** from the source in Settings. | Members with Build access use shared values. Members cannot open the editor to view them. |
14+
| **Organization** | Admins open **Secrets** from the source in Settings. | Members with Home access use shared values. Members cannot open the editor to view them. |
1515
| **Member** | Each person opens **Integrations → Generic Secrets → Manage secrets**. | Each person uses only their own values in the organization. |
1616

1717
Only the selected mode is active. To change it, select **Configure** on the source.
1818

1919
## Use a secret
2020

2121
1. Save a name and value in the editor.
22-
2. Ask Build or Plan to run code that needs that secret.
23-
3. The mode sees available names and mounts the names needed by `run_code` or `run_function` as environment variables. Code can use them in requests such as `curl` without putting values in the prompt.
22+
2. Open **Home** in the organization sidebar and ask Sim to run code that needs that secret.
23+
3. Sim sees available names and mounts the names needed by `run_code` or `run_function` as environment variables. Code can use them in requests such as `curl` without putting values in the prompt.
2424

2525
In an organization conversation targeting a workspace, an organization secret takes precedence over a workspace secret with the same name. Member mode resolves the current member's values and cannot use another member's secrets.
2626

27-
Generic Secrets is available only in **Build** and **Plan**. Search mode, Search MCP, and Sim Search in Slack cannot mount these values. Workspace secrets remain a separate resource.
27+
**Search**, including **Assistant**, Search MCP, and Sim Search in Slack cannot mount these values. Workspace secrets remain a separate resource.
2828

2929
## Remove the source
3030

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Gmail Search finds matching messages in your connected mailbox. **Member account
99

1010
An admin adds **Gmail** in **Settings → Sources**, chooses **Member accounts**, and saves. Members select **Integrations → Gmail → Connect**, then search for a known message and read it.
1111

12-
Member mode has no admin label, date, category, or mailbox filters. Search does not send or modify messages, though the shared personal connection may request broader workflow scopes.
12+
Member mode has no admin label, date, category, or mailbox filters. Search and document-read requests do not send or modify messages. When integration actions are enabled, **Search → Assistant** can create drafts or send email using your connected account, subject to tool permissions and organization policy. Writes ask for [review](/search/ask-questions#review-actions) by default.
1313

1414
## Set up a central service account
1515

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Availability depends on deployment configuration and organization policy. Google
8282
| [Slack](/search/slack) | Accessible messages and files through real-time search | Member only |
8383
| [Zoom](/search/zoom) | Past meetings and available artifacts; requires organization enablement | Member only |
8484

85-
**Generic Secrets** is also offered in Sources. Its **Organization** and **Member** modes store secrets for Build and Plan; they do not add searchable content. See [Generic Secrets](/search/generic-secrets).
85+
**Generic Secrets** is also offered in Sources. Its **Organization** and **Member** modes store secrets for organization Home conversations; they do not add searchable content. See [Generic Secrets](/search/generic-secrets).
8686

8787
## Access and freshness
8888

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Sim resolves your accessible Atlassian sites and sends Jira Query Language (JQL)
1919

2020
Search returns summaries and descriptions. Reads fetch the issue and available comments with the same account. Jira enforces project permissions, issue security, and app-access restrictions. Bounded responses may omit comments; open Jira for the full discussion.
2121

22-
Search checks up to four accessible sites by default. A native query can select a cloud site ID and follow its continuation cursor. Changes follow Jira's search freshness. Live Search does not crawl attachments or retain an indexed issue copy, and does not edit issues. The shared account connection can request broader workflow permissions.
22+
Search checks up to four accessible sites by default. A native query can select a cloud site ID and follow its continuation cursor. Changes follow Jira's search freshness. Live Search does not crawl attachments or retain an indexed issue copy. Search and document-read requests do not edit issues. When integration actions are enabled, **Search → Assistant** can create or update issues, add comments, and create sprints using your connected account, subject to tool permissions and organization policy. These writes ask for [review](/search/ask-questions#review-actions) by default.
2323

2424
## Troubleshooting
2525

@@ -40,7 +40,7 @@ Follow [Atlassian OAuth setup](/platform/self-hosting/integrations-oauth#atlassi
4040
https://<your-sim-domain>/api/auth/oauth2/callback/jira
4141
```
4242

43-
Search reads only, but the shared app also supports workflows. If only the app owner can connect, check **Distribution**. After client/scope changes, update the organization's saved provider configuration and reconnect affected members.
43+
The shared app supports Search retrieval, supported Assistant actions, and workflows. If only the app owner can connect, check **Distribution**. After client/scope changes, update the organization's saved provider configuration and reconnect affected members.
4444

4545
## Related docs
4646

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: What to check when sources, results, or answers aren't what you exp
77

88
Check that you're in the intended organization. Ask your admin whether Search is enabled for your organization and account.
99

10-
A missing conversation-mode menu on **Home** is expected for members without builder access: Home starts in Search automatically, so you can ask immediately. If the menu is shown, choose **Search** before sending your first message.
10+
Open **Search** in the organization sidebar, then select **Assistant** to ask a question. Access to Search does not require permission to create organization workspaces.
1111

1212
## I can't connect an app
1313

@@ -52,9 +52,9 @@ For a multi-part question, ask for one part first. If an answer has no source, a
5252

5353
Open the original source and compare it with the answer. Specify the relevant dates, and ask Sim to distinguish final decisions from earlier proposals. If documents disagree, ask it to explain the conflict with citations rather than combine them into one answer.
5454

55-
## I can't attach a PDF or spreadsheet in Search mode
55+
## I can't attach a PDF or spreadsheet in Assistant [#i-cant-attach-a-pdf-or-spreadsheet-in-search-mode]
5656

57-
Search conversations accept image attachments. Find document content through a connected source, use **Summarize** on its search result, or paste a relevant excerpt into your question. Don't assume that other Sim modes' upload capabilities apply to Search.
57+
Assistant accepts image attachments. Find document content through a connected source, use **Summarize** on its search result, or paste a relevant excerpt into your question. Other Chat surfaces support different upload types.
5858

5959
## A colleague sees different results
6060

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A workflow Zoom connection does not authorize Search. Its dedicated app registra
1717

1818
## Search and read meetings
1919

20-
Ask Sim on **Home**: “Search Zoom for deployment rollback decisions last week and cite the transcript.” Use short plain keywords such as `deployment rollback`. Zoom matches topics, agendas, and available meeting content.
20+
Open **Search → Assistant** and ask Sim: “Search Zoom for deployment rollback decisions last week and cite the transcript.” Use short plain keywords such as `deployment rollback`. Zoom matches topics, agendas, and available meeting content.
2121

2222
Results identify past occurrences by UUID rather than recurring meeting number. Use native kind `meeting` when sending multiple queries to one account. `startDate` and `endDate` use actual start time, with an exclusive end. Continue `nextCursor` with the same account, query, and filters; rerun an expired continuation. [Zoom's Meetings API](https://developers.zoom.us/docs/api/meetings/) documents a 15-minute page-token lifetime; restart Search if the MCP continuation expires.
2323

-103 KB
Binary file not shown.

0 commit comments

Comments
 (0)