Skip to content

add runbook for deep search#1683

Open
jasonhawkharris wants to merge 2 commits intomainfrom
jhh/deepsearch-guide-troubleshooting
Open

add runbook for deep search#1683
jasonhawkharris wants to merge 2 commits intomainfrom
jhh/deepsearch-guide-troubleshooting

Conversation

@jasonhawkharris
Copy link
Contributor

@jasonhawkharris jasonhawkharris commented Mar 12, 2026

Fixes CU-2322

Add Deep Search Guide page

Adds a new "Guide" page under Deep Search in the docs sidebar (/deep-search/guide) that consolidates overview, configuration, and troubleshooting information for Deep Search.

Changes:

docs/deep-search/guide.mdx — New page covering:

  • Overview and model details (sourced from sourcegraph/sourcegraph)
  • Client entry points (web main page, sidebar, Slack, external API, src-cli)
  • Grafana dashboard panels reference
  • Site config and user settings options
  • FAQ (enabling, sharing security, API comparison, costs, sources vs. citations)
  • Common troubleshooting scenarios

src/data/navigation.ts — Added "Guide" entry under Deep Search, after Slack Integration

@vercel
Copy link

vercel bot commented Mar 12, 2026

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

Project Deployment Actions Updated (UTC)
sourcegraph-docs Ready Ready Preview, Comment Mar 12, 2026 3:07pm

Request Review

@jasonhawkharris jasonhawkharris requested a review from a team March 12, 2026 14:27
Copy link
Contributor

@janhartman janhartman left a comment

Choose a reason for hiding this comment

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

How does this work with the existing page? I see some duplication which we should minimize IMO.

Copy link
Contributor

@janhartman janhartman left a comment

Choose a reason for hiding this comment

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

I think at a basic level this is OK. @stefanhengl , is this what you had in mind with the ticket?

@janhartman janhartman requested a review from stefanhengl March 12, 2026 15:17
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.

2 participants