Skip to content

Commit 09976fd

Browse files
waleedlatif1waleedlatif1
authored
feat(docs): add Sim Search user guides (#9403)
1 parent ce56a1b commit 09976fd

7 files changed

Lines changed: 153 additions & 0 deletions

File tree

‎apps/docs/content/docs/search/ask-questions.mdx‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
---
2+
title: Ask questions
3+
description: Get answers from your connected apps, check the sources, and ask follow-up questions.
4+
---
5+
6+
import { Image } from '@/components/ui/image'
7+
8+
Ask Sim a question when you want an explanation, a summary, or an answer drawn from your connected apps. Keep the conversation open as you check the sources and ask follow-ups.
9+
10+
Your organization must enable Search and make a source available to you. [Connect your account](/search/connect-your-account) if that source requires a personal connection.
11+
12+
## Ask your first question
13+
14+
1. Open **Home** in the organization sidebar. From a workspace, open the workspace menu and select **Back to organization** first.
15+
2. If the conversation mode picker is shown, choose **Search** before sending your first message.
16+
3. Ask a specific question and press **Enter**.
17+
18+
For example:
19+
20+
> What belongs in a product requirements document? Use the Confluence template and cite it. Keep the answer to three short bullets.
21+
22+
<Image
23+
src="/static/search/answer-with-citations.webp"
24+
alt="A Search conversation answering a question about a product requirements template, with inline Confluence citations and a source count below the answer"
25+
width={1512}
26+
height={900}
27+
variant="result"
28+
background="san-francisco"
29+
/>
30+
31+
Include the project, topic, or timeframe that matters. If you know where the answer lives, name the app or document:
32+
33+
> Find our launch plan in Confluence. Summarize the scope and the launch date, with sources.
34+
35+
Search mode finds and reads information. Use **Build** in a new conversation when you want Sim to take actions or change resources.
36+
37+
## Check the sources
38+
39+
Select an inline citation to open the supporting document. To review the conversation's references together:
40+
41+
1. Select the book icon and source count beneath the answer.
42+
2. Select **View all sources** to open the **Sources** panel beside the conversation.
43+
3. Select a source title to open the original.
44+
45+
Check the source's date and context before relying on a detail. If documents disagree, ask Sim to compare them and identify the difference. If the answer is incomplete, narrow the question or name another source to check.
46+
47+
## Follow up in the same conversation
48+
49+
You don't need to repeat the original question. Ask for the next useful detail:
50+
51+
> Turn the template's sections into a short checklist of information I need to gather.
52+
53+
> What belongs in the out-of-scope section?
54+
55+
> Which parts are filled in, and which are still placeholders?
56+
57+
Review the cited material for each answer. A summary can miss context, and an unavailable source can leave a gap. Sim can only retrieve content allowed by your account and the organization's source settings.
58+
59+
## Start from a document
60+
61+
If you already found the right document in **Search**, open its **…** menu and select **Summarize**. Sim starts a conversation focused on that result. Continue with questions about its decisions, dates, or next steps.
62+
63+
Your conversations remain private to you. Copying a source link does not give someone else access to the original document.
64+
65+
## Related docs
66+
67+
- [Find content](/search/find-content): Search directly, filter results, and reopen recent sources.
68+
- [Connect your account](/search/connect-your-account): Check source connections and recover access.
69+
- [Use Sim Search in Slack](/search/slack#use-sim-search-in-slack): Ask questions from Slack when your organization has enabled it.

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

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
---
2+
title: Find content
3+
description: Find a document, narrow the results, and open the original.
4+
---
5+
6+
import { Image } from '@/components/ui/image'
7+
8+
Use **Search** when you want to find a page, message, or file in your connected apps. Start with a project name or a phrase you remember, then narrow the results.
9+
10+
Your organization must enable Search and make a source available to you. [Connect your account](/search/connect-your-account) if that source requires a personal connection.
11+
12+
## Find a document
13+
14+
1. Open **Search** in the organization sidebar. If you're in a workspace, open the workspace menu and select **Back to organization** first.
15+
2. Enter a title, project name, or distinctive phrase, such as `product requirements`.
16+
3. Press **Enter** or select the arrow to search.
17+
18+
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.
19+
20+
## Narrow the results
21+
22+
Use the filters beneath the search field:
23+
24+
<Image
25+
src="/static/search/search-filters.webp"
26+
alt="Search field with Confluence selected as the source and Any time selected as the date filter"
27+
width={1400}
28+
height={250}
29+
variant="detail"
30+
background="san-francisco"
31+
/>
32+
33+
| Filter | Use it to |
34+
| --- | --- |
35+
| **All sources** | Choose one app, such as Confluence or Google Drive. |
36+
| **Any time** | Search without a date restriction. |
37+
| **Past week** or **Past month** | Focus on recently updated content. |
38+
| **Custom range** | Choose a start and end date. |
39+
40+
Filters update the results. Return to **All sources** and **Any time** to broaden the search again.
41+
42+
If a query is too broad, add a detail you know: try `product requirements template` instead of `requirements`. Search coverage and the dates available depend on the source.
43+
44+
## Use a result
45+
46+
Open the **…** menu beside a result:
47+
48+
- **Summarize** starts a Search conversation about that document. Ask a follow-up to explore it further.
49+
- **Copy link** copies the original source link. Anyone you send it to still needs access in that app.
50+
51+
For an answer that combines several documents, [ask a question in Search](/search/ask-questions).
52+
53+
## Return to something you found
54+
55+
Open **Search** again to see **Recently viewed** sources and **Recent searches**. Select a source to reopen it, or a query to search again.
56+
57+
This history is private to your account in the current organization. **Clear history** removes both lists.
58+
59+
## If you can't find it
60+
61+
- **No results:** try a shorter phrase, remove the date filter, or choose **All sources**. Confirm that your connected account can open the original content.
62+
- **Some apps couldn't be searched:** the results shown may be incomplete. Retry, or open **Integrations** to check whether an account needs reconnecting.
63+
- **Search couldn't run:** select **Try again**. If the problem continues, check your connection in **Integrations**.
64+
- **A source is missing:** ask your organization admin whether it is available to you.
65+
66+
An empty result does not prove a document is absent. Provider search limits and your organization's source settings can affect what you find. See [access and freshness](/search#access-and-freshness).
67+
68+
## Related docs
69+
70+
- [Ask questions](/search/ask-questions): Get an answer with sources and follow up in the same conversation.
71+
- [Connect your account](/search/connect-your-account): Connect or reconnect a source.

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@ Search queries your connected sources when you ask. Results reflect your account
77

88
Use **Search** to find documents directly, or ask Sim on **Home** for an answer with sources. [Sim Search in Slack](/search/slack) and [Search MCP](/search/mcp) use the same retrieval and access rules. Search mode can search and read sources; it does not expose arbitrary integration actions.
99

10+
## Use Search
11+
12+
- [Find content](/search/find-content): Search for a document, narrow the results, and open the original.
13+
- [Ask questions](/search/ask-questions): Get an answer with sources and explore it in a conversation.
14+
15+
Already invited to Sim? Start with either guide and [connect your account](/search/connect-your-account) when your source requires it. The setup below is for organization admins adding sources.
16+
1017
## Add your first source
1118

1219
1. An organization admin opens **Settings → Sources → Add source** and chooses a provider.

‎apps/docs/content/docs/search/meta.json‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
{
22
"title": "Search",
33
"pages": [
4+
"---User guides---",
5+
"find-content",
6+
"ask-questions",
7+
"---Connect sources---",
48
"connect-your-account",
59
"coda",
610
"confluence",

‎apps/docs/public/static/search/answer-with-citations.webp‎

96.1 KB
Loading

‎apps/docs/public/static/search/search-filters.webp‎

8.46 KB
Loading

‎apps/sim/lib/mothership/generated/docs-manifest.ts‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -437,9 +437,11 @@ export const DOCS_MANIFEST: readonly string[] = [
437437
'platform/workspaces.mdx',
438438
'quick-reference.mdx',
439439
'search.mdx',
440+
'search/ask-questions.mdx',
440441
'search/coda.mdx',
441442
'search/confluence.mdx',
442443
'search/connect-your-account.mdx',
444+
'search/find-content.mdx',
443445
'search/fireflies.mdx',
444446
'search/generic-secrets.mdx',
445447
'search/github.mdx',

0 commit comments

Comments
 (0)