Skip to content

Commit 57c3d55

Browse files
committed
Add documentation for error lookups workflow in omnibox
1 parent 68ebc97 commit 57c3d55

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,32 @@
11
# Error Lookups
2+
3+
<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>
4+
5+
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:
6+
7+
1. Search for specific error messages across their codebase
8+
2. Select relevant files where the error is thrown or handled
9+
3. Request a natural language explanation of the error's context, triggers, and implications
10+
11+
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:
12+
13+
* The specific conditions that trigger the error
14+
* The underlying reasons for the error occurrence
15+
* Common scenarios where this error might appear
16+
* Potential approaches to handling or preventing the error
17+
18+
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.
19+
20+
## Try it
21+
22+
* Query for `"unsupported value for type filter"`
23+
* Select the file(s) where the error is thrown
24+
* Follow up with "Explain when and why this error is thrown"
25+
26+
## Demo
27+
28+
🔴 Upload video to GCP 🔴
29+
30+
<video width="100%" controls>
31+
<source src="https://p21.p4.n0.cdn.zight.com/items/QwuyA4q7/dda31e22-d3ba-4844-b1d5-95978f2a7b1f.mp4?v=75789259e408c85fa268aa105c974894" type="video/mp4" />
32+
</video>

0 commit comments

Comments
 (0)