Skip to content

docs(search): add customer guides and sourced examples - #9405

Merged
mzxchandra merged 4 commits into
stagingfrom
codex/sim-search-docs
Oct 27, 2026
Merged

mzxchandra merged 4 commits into
stagingfrom
codex/sim-search-docs

Conversation

@mzxchandra

@mzxchandra mzxchandra commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Search customers need practical guidance for finding company knowledge and using answers from connected sources. Add a quickstart and troubleshooting guide; expand the existing question, document-search, and account-connection guides while preserving their URLs and admin setup guidance.

Get started includes a reusable prompt pattern. The Ask questions guide includes practical prompts for decision rationale, troubleshooting, policies, comparisons, and FAQs, and covers citations, follow-up questions, comparing sources, meeting preparation across Calendar, Drive, and Confluence, and drafting from sourced findings in the same conversation. It explains that Search does not send or publish drafts or change source records. Give Sim Search its own navigation section and regenerate the docs manifest for the two new pages.

Product update

Customers can follow an enterprise-search journey without workflow-builder access. Four real screenshots illustrate search, meeting preparation, drafting, and account connection using the shared docs Image component. All six referenced Search screenshots were checked for captured Codex cursors; affected captures were replaced.

Type of change

  • Documentation

Testing

  • PASS: focused MDX compilation for six pages, 24 navigation entries, 48 internal links including the drafting anchor, and image references.
  • PASS: all six affected local routes returned HTTP 200; rendered HTML includes the retained example prompts and excludes removed navigation links. The drafting section and sidebar were previously verified in the browser. Prior desktop, 390px, and media-viewer inspections also passed.
  • PASS: bun run check:docs-manifest and git diff --check. bun run check:api-validation passed before the documentation consolidation; no API changes.
  • PASS: manual staging product walkthrough with synthetic data covering retrieval, citations, source opening, drafting, and a meeting brief. This verifies the documented product examples, not deployment of this docs change.
  • No pre-deployment old-state fixtures are required: this change does not alter records or defaults.
  • NOT RUN: deployed docs route, navigation, and image-viewer checks; pending deployment. Full builds and repository suites are left to hosted CI.

Screenshots

Search results · Meeting brief · Draft with sources · Connect an account

@vercel

vercel Bot commented Oct 27, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
docs Ready Ready Preview Oct 27, 2026 10:53pm UTC

Request Review

@mzxchandra
mzxchandra marked this pull request as ready for review October 27, 2026 22:17

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 13 files

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Tip: Get a Slack DM when cubic finishes reviewing your PRs. Connect Slack

Turn on auto-fix | Re-trigger cubic

@greptile-apps

greptile-apps Bot commented Oct 27, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 4/5

[Low impact] The PR changes the guidance and navigation for Sim Search, not Search behavior.

The PR appears safe to merge with a non-blocking correction to the Search mode instructions.

Findings

  1. P2 Instructions require a hidden menu ▶

Summary

Adds customer-facing Sim Search guidance while keeping existing page URLs and admin setup instructions.

  • Members can follow a guided path into Sim Search.
  • Search questions now include practical ways to compare source-backed answers.
  • Members can prepare a cited meeting brief from Calendar and project docs.
  • Members can draft source-based text in the Search conversation.
  • Members can see sample Search results and a Confluence account connection.

One non-blocking correction remains: make the mode-menu step conditional for members without builder access.

Verification: git diff --check passed. No build or browser checks were run. Screenshot contents could not be inspected because image input is unavailable.

Reviews (1) · Last reviewed commit: "docs(search): consolidate example prompt..." · Reviewed by Greptile


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. Choose **Search** in the conversation-mode menu before sending your first message.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Instructions require a hidden menu

Members without builder access cannot follow this step. Home hides the mode menu when canBuild is false and already defaults those members to Search. They can ask questions immediately, but this instruction makes the missing menu look like a setup problem.

Restore the conditional wording and explain that users without the menu can ask immediately. Apply the same wording to the quickstart and troubleshooting instructions.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

@mzxchandra
mzxchandra merged commit 05e49a8 into staging Oct 27, 2026
67 checks passed
@mzxchandra
mzxchandra deleted the codex/sim-search-docs branch October 27, 2026 22:59

This branch was successfully deployed

1 active deployment
Preview — 050ae438 Deployed Oct 27, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant