Skip to content

deepsearch: add evaluator docs#1826

Open
kalanchan wants to merge 3 commits into
mainfrom
kalan/evaluator-docs
Open

deepsearch: add evaluator docs#1826
kalanchan wants to merge 3 commits into
mainfrom
kalan/evaluator-docs

Conversation

@kalanchan

Copy link
Copy Markdown
Contributor

closes https://linear.app/sourcegraph/issue/CU-3011/add-evaluator-section-in-deep-search-docs

adds evaluator section in the deep search docs to explain how it works, guardrails, examples etc.

@kalanchan
kalanchan requested a review from a team July 24, 2026 21:06
@vercel

vercel Bot commented Jul 24, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
sourcegraph-docs Ready Ready Preview, Comment Jul 24, 2026 9:44pm

Request Review

Comment on lines +57 to +59
## Using Evaluator

Evaluator lets Deep Search write and run Lua scripts over Sourcegraph search results. Deep Search decides when to use Evaluator and writes the script automatically; you do not need to write or run code yourself.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should this just be "using Deep Search"? Plus I don't think we need capital-E evaluator

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.

Yep, I think we're separating evaluator here too much.

Also in general, these docs seem a bit too heavy to me - let's focus on the end user's perspective and not expose internal details IMO.

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.

3 participants