Skip to content

Commit d54ffd7

Browse files
committed
docs
1 parent 096b245 commit d54ffd7

File tree

6 files changed

+113
-4
lines changed

6 files changed

+113
-4
lines changed

docs/docs.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,15 @@
2828
"group": "Features",
2929
"pages": [
3030
{
31-
"group": "Search",
31+
"group": "Code Search",
3232
"pages": [
33+
"docs/features/search/overview",
3334
"docs/features/search/syntax-reference",
3435
"docs/features/search/multi-branch-indexing",
3536
"docs/features/search/search-contexts"
3637
]
3738
},
39+
"docs/features/ask",
3840
"docs/features/code-navigation",
3941
"docs/features/analytics",
4042
"docs/features/mcp-server",
@@ -66,6 +68,7 @@
6668
"docs/connections/request-new"
6769
]
6870
},
71+
"docs/configuration/language-model-providers",
6972
"docs/license-key",
7073
"docs/configuration/environment-variables",
7174
{
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: Language Model Providers
3+
sidebarTitle: Language model providers
4+
---

docs/docs/features/ask.mdx

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
title: Ask Sourcebot
3+
---
4+
5+
Ask Sourcebot gives you the ability to ask complex questions about your codebase in natural language.
6+
7+
It uses Sourcebot’s existing [code search](/docs/features/search/overview) and [navigation](/docs/features/code-navigation) tools to allow reasoning models to search your code,
8+
follow code nav references, and provide an answer that’s rich with inline citations and navigable code snippets.
9+
10+
<CardGroup>
11+
<Card title="Configure language models" icon="robot" href="/docs/configuration/language-model-providers" horizontal="true">
12+
Learn how to connect your language model to Sourcebot
13+
</Card>
14+
<Card title="Index repos" icon="book" href="/docs/connections/overview" horizontal="true">
15+
Learn how to index your repos so you can ask questions about them
16+
</Card>
17+
</CardGroup>
18+
19+
<video
20+
autoPlay
21+
muted
22+
loop
23+
playsInline
24+
className="w-full aspect-video"
25+
src="/images/ask_sourcebot_low_res.mp4"
26+
></video>
27+
28+
# Why do we need another AI dev tool?
29+
30+
Existing AI dev tools (Cursor, Claude Code, Copilot) are great at generating code. However, we believe one of the hardest parts of being
31+
a software engineer is **understanding code**.
32+
33+
In this domain, these tools fall short:
34+
- You can only ask questions about the code you have checked out locally
35+
- You get a wall of text that's difficult to parse, requiring you to go back and forth through different code snippets in the response
36+
- The richness of the explanation is limited by the fact that you're in your IDE
37+
38+
We built Ask Sourcebot to address these problems. With Ask Sourcebot, you can:
39+
- Ask questions about your teams entire codebase (even on repos you don't have locally)
40+
- Easily parse the response with side-by-side citations and code navigation
41+
- Share answers with your team to spread the knowledge
42+
43+
Being a web app is less convenient than being in your IDE, but it allows Sourcebot to provide responses in a richer UI that isn't constrained by the IDE.
44+
45+
We believe this experience of understanding your codebase is superior, and we hope you find it useful. We'd love to know what you think! Feel free to join the discussion on our
46+
[GitHub](https://github.com/sourcebot-dev/sourcebot/discussions).
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Overview
3+
---
4+
5+
Search across all your repos/branches across any code host platform. Blazingly fast, and supports regular expressions, repo/language search filters, boolean logic, and more.
6+
7+
<Accordion title="Key benefits">
8+
- **Regex support:** Use regular expressions to find code with precision.
9+
- **Query language:** Scope searches to specific files, repos, languages, symbol definitions and more using a rich [query language](/docs/features/search/syntax-reference).
10+
- **Branch search:** Specify a list of branches to search across ([docs](/docs/features/search/multi-branch-indexing)).
11+
- **Fast & scalable:** Sourcebot uses [trigram indexing](https://en.wikipedia.org/wiki/Trigram_search), allowing it to scale to massive codebases.
12+
- **Syntax highlighting:** Syntax highlighting support for over [100+ languages](https://github.com/sourcebot-dev/sourcebot/blob/57724689303f351c279d37f45b6406f1d5d5d5ab/packages/web/src/lib/codemirrorLanguage.ts#L125).
13+
- **Multi-repository:** Search across all of your repositories in a single search.
14+
- **Search suggestions:** Get search suggestions as you craft your query.
15+
- **Filter panel:** Filter results by repository or by language.
16+
</Accordion>
17+
18+
<CardGroup>
19+
<Card title="Index repos" icon="book" href="/docs/connections/overview" horizontal="true">
20+
Learn how to index your repos so you can ask questions about them
21+
</Card>
22+
<Card title="Branches" icon="split" href="/docs/features/search/multi-branch-indexing" horizontal="true">
23+
Learn how to index and search through your branches
24+
</Card>
25+
</CardGroup>
26+
27+
<video
28+
autoPlay
29+
muted
30+
loop
31+
playsInline
32+
className="w-full aspect-video"
33+
src="https://framerusercontent.com/assets/cEqHNSLiMbNeG3bk5xheQWXmKqc.mp4"
34+
></video>

docs/docs/overview.mdx

Lines changed: 25 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,10 @@
22
title: "Overview"
33
---
44

5-
[Sourcebot]((https://github.com/sourcebot-dev/sourcebot)) is an open-source, self-hosted code search tool. It allows you to search and navigate across millions of lines of code across several code host platforms.
5+
[Sourcebot](https://github.com/sourcebot-dev/sourcebot) is a self-hosted tool that helps you understand your codebase.
6+
7+
- [Code search](/docs/features/search/overview): Search and navigate across all your repos and branches, no matter where they’re hosted
8+
- [Ask Sourcebot](/docs/features/ask): Ask questions about your codebase and have Sourcebot provide detailed answers grounded with inline citations
69

710
<CardGroup>
811
<Card title="Deployment guide" icon="server" href="/docs/deployment-guide" horizontal="true">
@@ -30,9 +33,28 @@ title: "Overview"
3033
Find an overview of all Sourcebot features below. For details, see the individual documentation pages.
3134
</Info>
3235

33-
### Fast indexed based search
36+
### Ask Sourcebot
37+
38+
[Ask Sourcebot](/docs/features/ask) gives you the ability to ask complex questions about your codebase, and have Sourcebot provide detailed answers with inline citations.
39+
40+
<Accordion title="Key benefits">
41+
- **Bring your own model:** [Configure](/docs/configuration/language-model-providers) to any language model you'd like
42+
- **Inline citations:** Every answer Sourcebot provides is grounded with inline citations directly into your codebase
43+
- **Mutli-repo:** Ask questions about any repository you have indexed on Sourcebot
44+
</Accordion>
45+
46+
<video
47+
autoPlay
48+
muted
49+
loop
50+
playsInline
51+
className="w-full aspect-video"
52+
src="/images/ask_sourcebot_low_res.mp4"
53+
></video>
54+
55+
### Code Search
3456

35-
Search across millions of lines of code instantly using Sourcebot's blazingly fast indexed search. Find exactly what you are looking for with regular expressions, search filters, boolean logic, and more.
57+
Search across all your repos/branches across any code host platform. Blazingly fast, and supports regular expressions, repo/language search filters, boolean logic, and more.
3658

3759
<Accordion title="Key benefits">
3860
- **Regex support:** Use regular expressions to find code with precision.
2.41 MB
Binary file not shown.

0 commit comments

Comments
 (0)