Skip to content
Closed
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
68ebc97
Docs for Omnibox
MaedahBatool Jan 20, 2025
57c3d55
Add documentation for error lookups workflow in omnibox
jdorfman Jan 20, 2025
e40d96a
Add documentation for file search workflow in omnibox/chat
jdorfman Jan 21, 2025
badbeb0
Add documentation for symbol search workflow in chat
jdorfman Jan 21, 2025
c4c1bb5
Add documentation for string literal search workflow in Chat
jdorfman Jan 22, 2025
b0290fa
Merge branch 'main' into omnibox-docs
MaedahBatool Jan 23, 2025
2bb8654
new nav structure
MaedahBatool Jan 23, 2025
7b85aa4
Update formatting and structure of chat query types documentation
jdorfman Jan 23, 2025
2cad1e1
Update Chat (main overview page) documentation with new features and …
jdorfman Jan 23, 2025
72bab86
Add documentation for intent detection, smart search integration, and…
jdorfman Jan 24, 2025
d5f901d
Update intent detection feature documentation with new screenshots
jdorfman Jan 24, 2025
fbead65
Add smart search integration and context-aware responses
jdorfman Jan 24, 2025
1df444a
Update query types documentation with new demos and content
jdorfman Jan 24, 2025
d8ea0bc
Merge branch 'main' into omnibox-docs
MaedahBatool Jan 27, 2025
9d04201
Add tabs layout
MaedahBatool Jan 27, 2025
3c716fa
Add edits to index.mdx
MaedahBatool Jan 27, 2025
93656dd
Redo key features as bullets
MaedahBatool Jan 27, 2025
3a984ee
more structure
MaedahBatool Jan 27, 2025
2d9a9e4
revert to old nav
MaedahBatool Jan 27, 2025
66cb14d
Restructure query types docs
MaedahBatool Jan 27, 2025
09617ba
Update image URLs in install-vscode.mdx (Lunch break commit)
jdorfman Jan 27, 2025
4b543b3
Stashing pnpm-lock
jdorfman Jan 27, 2025
a2605d6
Update image URLs in install-vscode.mdx
jdorfman Jan 27, 2025
b28d269
Update image URLs in install-jetbrains.mdx (commit 1/2)
jdorfman Jan 27, 2025
1e9a552
Update image URLs in install-jetbrains.mdx (commit 2/2)
jdorfman Jan 28, 2025
d3efe38
Update screenshots in cody-with-sourcegraph.mdx
jdorfman Jan 28, 2025
c7edfa3
Update image URL in cody-enterprise-features.mdx
jdorfman Jan 28, 2025
6c5ac06
Update image URLs in docs/cody/capabilities/chat.mdx
jdorfman Jan 28, 2025
f1d49c0
Update images and URLs in prompts.mdx
jdorfman Jan 28, 2025
6c8e25b
Update images & URLs in docs/code-search/working/saved_searches.mdx
jdorfman Jan 28, 2025
5cd18c1
Merge branch 'main' into omnibox-docs
MaedahBatool Jan 28, 2025
26a48c8
Update docs/cody/capabilities/chat.mdx
jdorfman Jan 28, 2025
0a6b219
Update pricing and extension links [alex suggestion]
jdorfman Jan 28, 2025
8f9e318
Add note about experimental terminal command execution [Alex suggestion]
jdorfman Jan 28, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/omnibox/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Omnibox
32 changes: 32 additions & 0 deletions docs/omnibox/query-types/error-lookups.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Error Lookups
Copy link
Contributor

Choose a reason for hiding this comment

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

do we need any of the files in this directory?

Copy link
Member

Choose a reason for hiding this comment

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

Hey Alex, which files are you referring to?


<p className="subtitle">Error Lookups is a conversational workflow for the Sourcegraph omnibox that helps developers understand error messages by providing plain-English explanations of when and why specific errors occur in their codebase and external service calls.</p>

Developers can use Error Lookups to understand error messages occurring in their codebase. When encountering an error, especially from external services or dependencies, developers can use the omnibox to:

1. Search for specific error messages across their codebase
2. Select relevant files where the error is thrown or handled
3. Request a natural language explanation of the error's context, triggers, and implications

The workflow combines Sourcegraph's code search capabilities with AI-powered analysis to provide developers with clear, contextual understanding of error scenarios. Instead of having to dig through documentation or source code manually, developers can quickly grasp:

* The specific conditions that trigger the error
* The underlying reasons for the error occurrence
* Common scenarios where this error might appear
* Potential approaches to handling or preventing the error

This approach helps developers make more informed decisions about error handling and debugging, reducing the time spent deciphering cryptic error messages or searching through external documentation.

## Try it

* Query for `"unsupported value for type filter"`
* Select the file(s) where the error is thrown
* Follow up with "Explain when and why this error is thrown"

## Demo

🔴 Upload video to GCP 🔴

<video width="100%" controls>
<source src="https://p21.p4.n0.cdn.zight.com/items/QwuyA4q7/dda31e22-d3ba-4844-b1d5-95978f2a7b1f.mp4?v=75789259e408c85fa268aa105c974894" type="video/mp4" />
</video>
21 changes: 21 additions & 0 deletions docs/omnibox/query-types/file-search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# File Search

<p className="subtitle">File Search is a query type or workflow that enables users to locate specific files across repositories and perform targeted analysis on the selected files through natural language follow-up queries.</p>

File Search simplifies the process of finding and analyzing specific file types across your codebase. Unlike traditional code search, this workflow allows you to first identify relevant files (for example, all `package.json` files), select the specific files you want to analyze, and then ask follow-up questions about the selected files.

This two-step approach is particularly powerful when you need to analyze patterns or extract information from similar files spread across multiple repositories. For instance, you could identify all configuration files, select the ones from relevant services, and then analyze their contents for inconsistencies or gather specific information through natural language queries.

### Try it

1. Type `package.json`
2. Above the results, you will find the message "Query review selected a code search response."
3. Follow up with `List all the dependencies used across these package.json files`

### Demo

🔴 Draft, replace with final version and upload to GCP 🔴

<video width="100%" controls>
<source src="https://p21.p4.n0.cdn.zight.com/items/BlumxXBE/55c5afa3-dee3-4b6c-bfd9-d3802360db2f.mp4?v=ec57e9a8c8e4a3d3af88635fcaf796d7" type="video/mp4" />
</video>
15 changes: 15 additions & 0 deletions docs/omnibox/query-types/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Omnibox Query Types

<p className="subtitle">This page lists the all the query types that will return search results with the Sourcegraph omnibox.</p>

<QuickLinks>

<QuickLink title="Symbol Search" icon='lightbulb' href="/omnibox/query-types/symbol-search" description="Find where a particular symbol is defined, with or without its precise name." />

<QuickLink title="File Search" icon='installation' href="/omnibox/query-types/file-search" description="Find where a particular file lives." />

<QuickLink title="Error Lookups" icon='theming' href="/omnibox/query-types/error-lookups" description="Get more information about errors with identification." />

<QuickLink title="String Literal Search" icon='languagemodels' href="/omnibox/query-types/string-literal-search" description="Instead of matching keyword chunks, search for an exact match using quotes." />

</QuickLinks>
1 change: 1 addition & 0 deletions docs/omnibox/query-types/string-literal-search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# String Literal Search
1 change: 1 addition & 0 deletions docs/omnibox/query-types/symbol-search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Symbol Search
17 changes: 17 additions & 0 deletions src/data/navigation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,23 @@ export const navigation: NavigationItem[] = [
{
separator: "Code Intelligence",
topics: [
{
title: "Omnibox",
href: "/omnibox",
sections: [
{ title: "Quickstart", href: "/omnibox/quickstart" },
{
title: "Query Types", href: "/omnibox/query-types",
subsections: [
{ title: "Symbol Search", href: "/omnibox/query-types/symbol-search", },
{ title: "File Search", href: "/omnibox/query-types/file-search", },
{ title: "Error Lookups", href: "/omnibox/query-types/error-lookups", },
{ title: "String Literal Search", href: "/omnibox/query-types/string-literal-search", },
]
},
{ title: "FAQs", href: "/omnibox/faq" },
],
},
{
title: "Cody",
href: "/cody",
Expand Down
Loading