diff --git a/apps/docs/content/docs/meta.json b/apps/docs/content/docs/meta.json index 255c174d82c..34d116d24fe 100644 --- a/apps/docs/content/docs/meta.json +++ b/apps/docs/content/docs/meta.json @@ -5,12 +5,13 @@ "./introduction/index", "./getting-started/index", "./desktop/index", + "---Sim Search---", + "search", "---Build---", "chat", "workflows", "agents", "---Workspace---", - "search", "knowledgebase", "tables", "files", diff --git a/apps/docs/content/docs/search/ask-questions.mdx b/apps/docs/content/docs/search/ask-questions.mdx index bad4d1bf436..27f7e1b135a 100644 --- a/apps/docs/content/docs/search/ask-questions.mdx +++ b/apps/docs/content/docs/search/ask-questions.mdx @@ -12,7 +12,7 @@ Your organization must enable Search and make a source available to you. [Connec ## Ask your first question 1. Open **Home** in the organization sidebar. From a workspace, open the workspace menu and select **Back to organization** first. -2. If the conversation mode picker is shown, choose **Search** before sending your first message. +2. If Home shows a conversation-mode menu, choose **Search** before sending your first message. Members without builder access start in Search automatically and can ask immediately. 3. Ask a specific question and press **Enter**. For example: @@ -32,7 +32,7 @@ Include the project, topic, or timeframe that matters. If you know where the ans > Find our launch plan in Confluence. Summarize the scope and the launch date, with sources. -Search mode finds and reads information. Use **Build** in a new conversation when you want Sim to take actions or change resources. +Search mode finds and reads information. You can also ask it to [draft content from the findings](/search/ask-questions#draft-from-your-sources); the draft stays in the conversation until you choose where to use it. ## Check the sources @@ -56,10 +56,79 @@ You don't need to repeat the original question. Ask for the next useful detail: 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. +## Summarize and compare + +Specify what you want extracted, rather than just “summarize this.” + +| Task | Example prompt | +| --- | --- | +| Compare options | “Compare these two vendor proposals against our evaluation requirements. Cite the evidence and distinguish missing information from requirements a vendor does not meet.” | +| Catch up on a project | “Summarize Atlas updates from the past two weeks. Separate decisions, blockers, and next steps. Include owners only where the sources name them, and cite each item.” | +| Find an owner | “Who owns the launch checklist? Cite the document that assigns responsibility.” | +| Resolve a disagreement | “These documents give different dates. Compare their context and identify what is confirmed.” | +| Understand a decision | “Find the decision about Atlas authentication. Summarize the options, chosen approach, and trade-offs. Distinguish final decisions from proposals and cite the decision record.” | +| Find troubleshooting steps | “Find our SSO sign-in troubleshooting guide. Summarize the checks in order, cite the source, and identify when to escalate.” | +| Understand a policy | “What does our travel policy say about hotels and meals? Cite the policy sections, identify regional differences, and flag cases it doesn't address.” | +| Compare feedback with a proposal | “Compare onboarding feedback with the new proposal. Show each need, whether the proposal addresses it, and the supporting source. Mark gaps explicitly.” | + +Follow up with “Which decisions changed an earlier plan?” or “Turn the gaps into questions for our review.” + +If the sources don't assign an owner or confirm a date, ask Sim to say so. Include the timeframe you care about, and distinguish a document's update date from the event it describes. A live search is still subject to provider freshness and retrieval limits. + +## Prepare for a meeting + +Connect Google Calendar and the apps that hold your team's documents, such as Confluence and Google Drive. Then ask Sim to bring the meeting details and relevant project context together: + +> Find the Atlas readiness review on November 16, 2026 in my calendar. Use the Atlas project pages in Confluence and the readiness update and pilot feedback in Google Drive to prepare a brief: meeting time, decisions needed, open questions, and what I should read beforehand. Cite the sources. + +Use your own meeting name and date. Naming the meeting and its related documents helps Sim find the right context. If you need a particular time zone, include it in the request. + +Follow up with “Turn the open questions into a proposed agenda” or “Which items need an update from each owner?” Check the event citation for scheduling details and the document citations for project facts. The proposed agenda is a draft; it doesn't change the calendar event. + +Atlas readiness brief showing the November 16 meeting at 10:00–10:30 AM Pacific with a Google Calendar citation + +## Draft from your sources + +Once you've checked the findings, ask Sim to turn them into a brief, update, email, FAQ, or presentation outline in the same conversation. Include the **source material, audience, format, and constraints**: + +> Using the Atlas launch brief and approved rollout decision, draft an internal launch announcement for customer success. Keep it under 200 words. Include what is changing, who it affects, and what the team needs to do. Keep source references next to factual claims and mark unconfirmed details as questions. + +If you haven't found the evidence yet, ask Sim to retrieve it first. You can combine retrieval and drafting in one request when the scope is clear. + +A refined Atlas launch update with links to the Google Drive launch brief and readiness update beside the supporting claims + +Continue with specific revisions: + +- “Cut this to half the length without losing the action items or source links.” +- “Separate confirmed facts from proposed next steps.” +- “Use the tone of this approved example: [paste an example].” +- “Turn this product overview into an FAQ for customer-facing teams. Cite each answer and list questions the overview doesn't resolve.” +- “Turn this into a six-slide outline with a title, three key points, and supporting sources for each slide.” + +Provide a style example or brand guidance when consistency matters. Check names, numbers, dates, links, and commitments against the sources. For an external audience, include only information intended for that audience and keep internal supporting material separate for your review. + +Copy the reviewed draft into the app where you want to use it. Search creates text in your conversation; it doesn't send or publish the draft or change source records. + ## Start from a document 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. +You can also paste a relevant excerpt or attach an image to add context. Search conversations accept images; retrieve PDF or spreadsheet content through connected sources. + Your conversations remain private to you. Copying a source link does not give someone else access to the original document. ## Related docs diff --git a/apps/docs/content/docs/search/connect-your-account.mdx b/apps/docs/content/docs/search/connect-your-account.mdx index 3a15f12be86..ca4f8e23ffd 100644 --- a/apps/docs/content/docs/search/connect-your-account.mdx +++ b/apps/docs/content/docs/search/connect-your-account.mdx @@ -3,6 +3,8 @@ title: Connect your account description: Authorize your provider accounts and manage their Search connections --- +import { Image } from '@/components/ui/image' + After your admin adds a source in **Settings → Sources**, connect your own account in **Integrations**. This applies to admins too. A service source usually still requires your personal connection. ## Connect and verify @@ -12,6 +14,17 @@ After your admin adds a source in **Settings → Sources**, connect your own acc 3. Complete authorization in the new tab. If the popup is blocked, allow it and select **Connect** again. 4. Return to **Search** or **Home** and search for content your account can open. Read a result and follow its source link. +Confluence in Integrations with the Connect button before an account has been authorized + +Once an account is connected, **Add account** lets you authorize another account for that provider. + The connection is usable when authorization completes; no initial indexing run is required. If a provider is missing, ask an admin to add it in **Sources**. `Not configured` means its app or deployment setup needs an admin's attention. You do not choose repositories, channels, labels, or an indexing method during personal authorization. Member mode uses your provider access; service mode further restricts results with the admin's source settings. diff --git a/apps/docs/content/docs/search/find-content.mdx b/apps/docs/content/docs/search/find-content.mdx index 7c30c8f6e46..a25613b8195 100644 --- a/apps/docs/content/docs/search/find-content.mdx +++ b/apps/docs/content/docs/search/find-content.mdx @@ -17,6 +17,15 @@ Your organization must enable Search and make a source available to you. [Connec 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. +Search results for the Atlas onboarding checklist in Confluence, with the organization sidebar and document excerpts + ## Narrow the results Use the filters beneath the search field: diff --git a/apps/docs/content/docs/search/index.mdx b/apps/docs/content/docs/search/index.mdx index 1ad975b2a1e..9a388ac3831 100644 --- a/apps/docs/content/docs/search/index.mdx +++ b/apps/docs/content/docs/search/index.mdx @@ -1,18 +1,29 @@ --- -title: Search -description: Find content in connected sources with your current account access +title: Sim Search +description: Find company knowledge, get answers with citations, and draft from connected sources. --- -Search queries your connected sources when you ask. Results reflect your account's current access and your organization's source settings. Search does not copy documents into a Sim vector index or wait for a background sync. - -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. +Sim Search helps you find and use information from your company's connected apps. Look up a document, ask a question across sources, catch up on a project, or turn what you find into a brief, update, or draft. ## Use Search -- [Find content](/search/find-content): Search for a document, narrow the results, and open the original. -- [Ask questions](/search/ask-questions): Get an answer with sources and explore it in a conversation. +| You want to… | Start here | +| --- | --- | +| Find and browse documents | [Find content](/search/find-content): open **Search** in the organization sidebar. | +| Get an explanation or compare sources | [Ask questions](/search/ask-questions): open **Home**; choose **Search** if the conversation-mode menu is shown. | +| Understand a particular result | Open the result's **… → Summarize** menu, then ask follow-up questions. | +| Create a draft from your findings | [Draft from your sources](/search/ask-questions#draft-from-your-sources): ask for an update, email, FAQ, or presentation outline in the conversation. | +| Prepare for a meeting | [Combine Calendar and project sources](/search/ask-questions#prepare-for-a-meeting) into a brief with decisions and reading material. | + +Members without builder access start in Search automatically on **Home** and can ask immediately without a mode menu. + +For example, ask “Why did the Atlas launch date change? Use the project documents in Confluence and Google Drive, and cite the sources.” Open the citations to check the evidence, then continue with “What does each owner need to do before launch?” + +Search mode retrieves and reads information and drafts text in your conversation. It does not send the draft or change source records. You choose where to use the reviewed result. + +Start with [Get started](/search/quickstart), then explore [Ask questions](/search/ask-questions) for more examples. [Connect your account](/search/connect-your-account) if your source requires a personal connection. The source setup below is for organization admins. -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. +When enabled by your organization, [Sim Search in Slack](/search/slack#use-sim-search-in-slack) and [Search MCP](/search/mcp) let you search from other tools using the same retrieval and access rules. ## Add your first source diff --git a/apps/docs/content/docs/search/meta.json b/apps/docs/content/docs/search/meta.json index 6dfd6f8c451..8bb053e9372 100644 --- a/apps/docs/content/docs/search/meta.json +++ b/apps/docs/content/docs/search/meta.json @@ -1,9 +1,11 @@ { - "title": "Search", + "title": "Sim Search", "pages": [ "---User guides---", + "quickstart", "find-content", "ask-questions", + "troubleshooting", "---Connect sources---", "connect-your-account", "coda", diff --git a/apps/docs/content/docs/search/quickstart.mdx b/apps/docs/content/docs/search/quickstart.mdx new file mode 100644 index 00000000000..ed769ee2182 --- /dev/null +++ b/apps/docs/content/docs/search/quickstart.mdx @@ -0,0 +1,64 @@ +--- +title: Get started +description: Connect an app, find a document, and turn it into a useful answer. +--- + +Use this walkthrough to go from a question to a useful answer. Choose a topic you know a little about, such as your team's onboarding guide or a current project. + +## 1. Connect your apps + +Open your organization's Sim home and select **Integrations** in the sidebar. Find an app you use and select **Connect**. Complete authorization with the work account that can open the content you need. + +Your admin must enable the source first. If you don't see it, ask them to check **Settings → Sources**. Some organization-managed sources have a different connection process; see [Connect your account](/search/connect-your-account). + +Once authorization finishes, you can search. You don't need to wait for a Sim indexing run. + +## 2. Find a document + +Select **Search** in the organization sidebar. Enter a few distinctive words and submit: + +> customer onboarding checklist + +Scan the titles and matching passages. Select a result to read it. If the results aren't what you expected, change the words or choose a source from **All sources**. + +You can also search with a question: + +> Where are the instructions for onboarding a new customer? + +## 3. Summarize what you found + +Open a result's **…** menu and choose **Summarize**. Sim opens a conversation on Home and uses that document as the starting point. + +Read the summary and follow its citations to check the source. Then ask: + +> Turn the onboarding steps in this document into a checklist. Keep the source references. + +## 4. Ask a broader question + +For a question across documents, open **Home**. If a conversation-mode menu is shown, select **Search** before sending your first message. Members without builder access start in Search automatically and can ask immediately: + +> What does a new account owner need to know about customer onboarding? Find the relevant guides, summarize the key steps, and cite the sources. + +You can continue in the same conversation: + +> Which steps require help from another team? + +## 5. Make the answer useful + +Ask for the output you need: + +> Turn those findings into a short welcome email I can review and send to a new teammate. + +The draft appears in the conversation. Review names, dates, commitments, and supporting sources before using it. + +## Make your next request specific + +Include a topic, a scope, and a desired result: + +> Summarize **Atlas launch decisions** from **the past two weeks** as **five bullets with sources and open questions**. + +For a more detailed request, reuse this pattern: + +> Using **[sources or topic]**, help me **[task]** for **[audience]**. Focus on **[scope and dates]**. Return **[format and length]**. Cite the sources and flag anything they don't establish. + +You don't need every element for a simple question. Replace the example names with your own projects and teams. See [Ask questions](/search/ask-questions) for examples of comparing documents, understanding decisions, and drafting from your sources. diff --git a/apps/docs/content/docs/search/troubleshooting.mdx b/apps/docs/content/docs/search/troubleshooting.mdx new file mode 100644 index 00000000000..c84181488fc --- /dev/null +++ b/apps/docs/content/docs/search/troubleshooting.mdx @@ -0,0 +1,69 @@ +--- +title: Troubleshooting +description: What to check when sources, results, or answers aren't what you expect. +--- + +## I don't see Search + +Check that you're in the intended organization. Ask your admin whether Search is enabled for your organization and account. + +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. + +## I can't connect an app + +Open **Integrations** and read the connection message. If the provider is missing or **Not configured**, ask an admin to check **Settings → Sources** and provider-app setup. If authorization opens a new tab, complete it and return to Sim. Allow the popup if your browser blocked it. + +Use **Reconnect** when prompted for an expired, revoked, or insufficient grant. Sign in with the work account that can open the content you need. For provider exceptions, see [Connect your account](/search/connect-your-account). + +## A document or message is missing + +Check these in order: + +1. **Organization:** Are you searching in the intended organization? +2. **Connection:** Is the relevant provider connected to the correct account? +3. **Access:** Can that account open the original content? +4. **Filters:** Try **All sources** and **Any time**, or narrow to the source you expect. +5. **Query:** Try the document title, a distinctive phrase, or a different description. +6. **Coverage:** Check for an incomplete-results message. Ask your admin whether source settings restrict the content. + +Try the query in the provider's own search as well. Its supported content, retention, and search limitations still apply. Waiting for a Sim indexing run will not resolve a live Search failure. + +## Some apps couldn't be searched + +The available results don't include every selected app. Narrow the source filter to the app you need and check its connection in **Integrations**. A temporary outage or rate limit may require trying again later; reconnect only when the connection needs it. + +## Coverage is incomplete + +Narrow the topic, source, or dates, or ask the assistant to refine the search. Treat the returned items as partial evidence. Don't interpret a partial or empty result as a complete list of everything that exists. + +## Search couldn't run + +Select **Try again**. If the failure persists, note the query, selected filters, approximate time, and error message for your admin or support contact. + +## The answer is incomplete or unsupported + +Name the relevant project or document and ask a narrower question: + +> Find the approved Atlas release date. Show the supporting source and say if you only found a proposed date. + +For a multi-part question, ask for one part first. If an answer has no source, ask which document supports it. Treat an unsupported detail as unconfirmed. + +## The answer looks out of date + +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. + +## I can't attach a PDF or spreadsheet in Search mode + +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. + +## A colleague sees different results + +Compare your organization, connected accounts, and source access. Sim searches as each person, so matching query text doesn't guarantee matching results. Sharing a link does not grant access. + +## A source link won't open + +Check that you're signed in to the right account in the source app. The item may have moved, been deleted, or had its permissions changed. Ask its owner or your admin to confirm the current location and access. + +## What should I include when asking for help? + +Send your admin or support contact the query, selected filters, expected source or document, visible connection status, approximately when you tried, and whether you can open the original. Include the error message if there is one. Share confidential material only through your organization's approved support channel. diff --git a/apps/docs/public/static/search/atlas-document-results.webp b/apps/docs/public/static/search/atlas-document-results.webp new file mode 100644 index 00000000000..42f8f732b17 Binary files /dev/null and b/apps/docs/public/static/search/atlas-document-results.webp differ diff --git a/apps/docs/public/static/search/atlas-readiness-brief.webp b/apps/docs/public/static/search/atlas-readiness-brief.webp new file mode 100644 index 00000000000..690dc855ba4 Binary files /dev/null and b/apps/docs/public/static/search/atlas-readiness-brief.webp differ diff --git a/apps/docs/public/static/search/connect-confluence.webp b/apps/docs/public/static/search/connect-confluence.webp new file mode 100644 index 00000000000..895480026a1 Binary files /dev/null and b/apps/docs/public/static/search/connect-confluence.webp differ diff --git a/apps/docs/public/static/search/launch-update-draft.webp b/apps/docs/public/static/search/launch-update-draft.webp new file mode 100644 index 00000000000..a393bba1c2d Binary files /dev/null and b/apps/docs/public/static/search/launch-update-draft.webp differ diff --git a/apps/sim/lib/mothership/generated/docs-manifest.ts b/apps/sim/lib/mothership/generated/docs-manifest.ts index 178477d1942..a9c8729a6aa 100644 --- a/apps/sim/lib/mothership/generated/docs-manifest.ts +++ b/apps/sim/lib/mothership/generated/docs-manifest.ts @@ -457,7 +457,9 @@ export const DOCS_MANIFEST: readonly string[] = [ 'search/lucid.mdx', 'search/mcp.mdx', 'search/notion.mdx', + 'search/quickstart.mdx', 'search/slack.mdx', + 'search/troubleshooting.mdx', 'search/zoom.mdx', 'tables.mdx', 'tables/using-in-workflows.mdx',