Skip to content

Commit 5faf29a

Browse files
authored
chore(readme): Update README with new videos (#410)
* demo thumbnail * features image * features * fix videos * fix videos * fix video references * readme * add videos for code nav and file explorer * video tag test * video embed test * autoplay test
1 parent f888085 commit 5faf29a

File tree

4 files changed

+32
-19
lines changed

4 files changed

+32
-19
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2424
- Bumped next version. [#406](https://github.com/sourcebot-dev/sourcebot/pull/406)
2525
- [ask sb] Improved search code tool with filter options. [#400](https://github.com/sourcebot-dev/sourcebot/pull/400)
2626
- [ask sb] Removed search scope constraint. [#400](https://github.com/sourcebot-dev/sourcebot/pull/400)
27+
- Update README with new features and videos. [#410](https://github.com/sourcebot-dev/sourcebot/pull/410)
2728
- [ask sb] Add back search scope requirement and other UI changes. [#411](https://github.com/sourcebot-dev/sourcebot/pull/411)
2829

2930
## [4.6.0] - 2025-07-25

README.md

Lines changed: 30 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<strong>Self Host</strong>
1313
</a> ·
1414
<a href="https://demo.sourcebot.dev">
15-
<strong>Demo</strong>
15+
<strong>Public Demo</strong>
1616
</a>
1717
</h3>
1818
</div>
@@ -37,34 +37,46 @@
3737
<a href="https://github.com/sourcebot-dev/sourcebot/stargazers"><img src="https://img.shields.io/github/stars/sourcebot-dev/sourcebot" /></a>
3838
</p>
3939
<p align="center">
40-
<p align="center">
41-
<a href="https://discord.gg/6Fhp27x7Pb"><img src="https://dcbadge.limes.pink/api/server/https://discord.gg/6Fhp27x7Pb?style=flat"/></a>
42-
</p>
4340
</p>
4441

45-
# About
46-
4742
Sourcebot is a self-hosted tool that helps you understand your codebase.
4843

4944
- **Ask Sourcebot:** Ask questions about your codebase and have Sourcebot provide detailed answers grounded with inline citations.
5045
- **Code search:** Search and navigate across all your repos and branches, no matter where they’re hosted.
5146

52-
https://github.com/user-attachments/assets/286ad97a-a543-4eef-a2f1-4fa31bea1b32
47+
Try it out in our [public demo](https://demo.sourcebot.dev)!
48+
49+
[![Sourcebot Demo](https://github.com/user-attachments/assets/147f53ad-5912-4c76-a5d8-371d480fff24)](https://github.com/user-attachments/assets/286ad97a-a543-4eef-a2f1-4fa31bea1b32)
50+
51+
52+
# Features
53+
![Sourcebot Features](https://github.com/user-attachments/assets/3aed7348-7aeb-4af3-89da-b617c3db2e02)
54+
55+
## Ask Sourcebot
56+
Ask Sourcebot gives you the ability to ask complex questions about your codebase in natural language.
57+
58+
It uses Sourcebot's existing code search and navigation tools to allow reasoning models to search your code, follow code nav references, and provide an answer that's rich with inline citations and navigable code snippets.
59+
60+
<video src="https://github.com/user-attachments/assets/feb82cde-51fc-42f9-830d-8f149d328a0b" width="100%" controls autoplay loop muted></video>
61+
62+
## Code Search
63+
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.
64+
65+
<video src="https://github.com/user-attachments/assets/022f0bd0-db45-45ba-a31f-7bd43b6e2e25" width="100%" controls autoplay loop muted></video>
66+
67+
## Code Navigation
68+
IDE-level code navigation (goto definition and find references) across all your repos.
5369

70+
<video src="https://github.com/user-attachments/assets/86c1cd58-c4d1-4481-a2d3-fcbb79d98203" width="100%" controls autoplay loop muted></video>
5471

55-
## Features
56-
- 💻 **One-command deployment**: Get started instantly using Docker on your own machine.
57-
- 🤖 **Bring your own model**: Connect Sourcebot to any of the reasoning models you're already using.
58-
- 🔍 **Multi-repo support**: Index and search through multiple public and private repositories and branches on GitHub, GitLab, Bitbucket, Gitea, or Gerrit.
59-
-**Lightning fast performance**: Built on top of the powerful [Zoekt](https://github.com/sourcegraph/zoekt) search engine.
60-
- 🎨 **Modern web app**: Enjoy a sleek interface with features like syntax highlighting, light/dark mode, and vim-style navigation.
61-
- 📂 **Full file visualization**: Instantly view the entire file when selecting any search result.
72+
## Built-in File Explorer
73+
Explore every file across all of your repos. Modern UI with syntax highlighting, file tree, code navigation, etc.
6274

63-
You can try out our public hosted demo [here](https://demo.sourcebot.dev)!
75+
<video src="https://github.com/user-attachments/assets/42d5782b-9e8d-4de2-a3b9-6db972901638" width="100%" controls autoplay loop muted></video>
6476

6577
# Deploy Sourcebot
6678

67-
Sourcebot can be deployed in seconds using our official docker image. Visit our [docs](https://docs.sourcebot.dev/self-hosting/overview) for more information.
79+
Sourcebot can be deployed in seconds using our official docker image. Visit our [docs](https://docs.sourcebot.dev/docs/deployment-guide) for more information.
6880

6981
1. Create a config
7082
```sh
@@ -106,10 +118,10 @@ docker run \
106118
</details>
107119
</br>
108120

109-
3. Start searching at `http://localhost:3000`
121+
3. Visit `http://localhost:3000` to start using Sourcebot
110122
</br>
111123

112-
To learn how to configure Sourcebot to index your own repos, please refer to our [docs](https://docs.sourcebot.dev/self-hosting/overview).
124+
To configure Sourcebot (index your own repos, connect your LLMs, etc), check out our [docs](https://docs.sourcebot.dev/docs/configuration/config-file).
113125

114126
> [!NOTE]
115127
> Sourcebot collects <a href="https://demo.sourcebot.dev/~/search?query=captureEvent%5C(%20repo%3Asourcebot">anonymous usage data</a> by default to help us improve the product. No sensitive data is collected, but if you'd like to disable this you can do so by setting the `SOURCEBOT_TELEMETRY_DISABLED` environment

docs/docs/overview.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Search across all your repos/branches across any code host platform. Blazingly f
9393
loop
9494
playsInline
9595
className="w-full aspect-video"
96-
src="https://framerusercontent.com/assets/B9ZxrlsUeO9NJyzkKyvVV2KSU4.mp4"
96+
src="/images/code_nav.mp4"
9797
></video>
9898

9999

docs/images/code_nav.mp4

3.84 MB
Binary file not shown.

0 commit comments

Comments
 (0)