-
Notifications
You must be signed in to change notification settings - Fork 259
chore(readme): Update README with new videos #410
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 8 commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
3812e70
demo thumbnail
msukkari 4cf2825
features image
msukkari 56910ce
features
msukkari 1361de0
fix videos
msukkari 8de7121
fix videos
msukkari 0f0811b
fix video references
msukkari a6de912
readme
msukkari 090c277
add videos for code nav and file explorer
msukkari 2e82ab9
Merge branch 'main' into msukkarieh/README
msukkari f043e56
video tag test
msukkari 498abda
video embed test
msukkari eff4e53
autoplay test
msukkari File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -12,7 +12,7 @@ | |
| <strong>Self Host</strong> | ||
| </a> · | ||
| <a href="https://demo.sourcebot.dev"> | ||
| <strong>Demo</strong> | ||
| <strong>Public Demo</strong> | ||
| </a> | ||
| </h3> | ||
| </div> | ||
|
|
@@ -37,34 +37,46 @@ | |
| <a href="https://github.com/sourcebot-dev/sourcebot/stargazers"><img src="https://img.shields.io/github/stars/sourcebot-dev/sourcebot" /></a> | ||
| </p> | ||
| <p align="center"> | ||
| <p align="center"> | ||
| <a href="https://discord.gg/6Fhp27x7Pb"><img src="https://dcbadge.limes.pink/api/server/https://discord.gg/6Fhp27x7Pb?style=flat"/></a> | ||
| </p> | ||
| </p> | ||
|
|
||
| # About | ||
|
|
||
| Sourcebot is a self-hosted tool that helps you understand your codebase. | ||
|
|
||
| - **Ask Sourcebot:** Ask questions about your codebase and have Sourcebot provide detailed answers grounded with inline citations. | ||
| - **Code search:** Search and navigate across all your repos and branches, no matter where they’re hosted. | ||
|
|
||
| https://github.com/user-attachments/assets/286ad97a-a543-4eef-a2f1-4fa31bea1b32 | ||
| Try it out in our [public demo](https://demo.sourcebot.dev)! | ||
|
|
||
| [](https://github.com/user-attachments/assets/286ad97a-a543-4eef-a2f1-4fa31bea1b32) | ||
|
|
||
|
|
||
| # Features | ||
|  | ||
|
|
||
| ## Ask Sourcebot | ||
| Ask Sourcebot gives you the ability to ask complex questions about your codebase in natural language. | ||
|
|
||
| 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. | ||
|
|
||
| https://github.com/user-attachments/assets/feb82cde-51fc-42f9-830d-8f149d328a0b | ||
|
|
||
| ## Code Search | ||
| 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. | ||
|
|
||
| https://github.com/user-attachments/assets/022f0bd0-db45-45ba-a31f-7bd43b6e2e25 | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Maybe we can have two more sections here for code navigation and file browsing? |
||
|
|
||
| ## Code Navigation | ||
| IDE-level code navigation (goto definition and find references) across all your repos. | ||
|
|
||
| https://github.com/user-attachments/assets/86c1cd58-c4d1-4481-a2d3-fcbb79d98203 | ||
|
|
||
| ## Features | ||
| - 💻 **One-command deployment**: Get started instantly using Docker on your own machine. | ||
| - 🤖 **Bring your own model**: Connect Sourcebot to any of the reasoning models you're already using. | ||
| - 🔍 **Multi-repo support**: Index and search through multiple public and private repositories and branches on GitHub, GitLab, Bitbucket, Gitea, or Gerrit. | ||
| - ⚡ **Lightning fast performance**: Built on top of the powerful [Zoekt](https://github.com/sourcegraph/zoekt) search engine. | ||
| - 🎨 **Modern web app**: Enjoy a sleek interface with features like syntax highlighting, light/dark mode, and vim-style navigation. | ||
| - 📂 **Full file visualization**: Instantly view the entire file when selecting any search result. | ||
| ## Built-in File Explorer | ||
| Explore every file across all of your repos. Modern UI with syntax highlighting, file tree, code navigation, etc. | ||
|
|
||
| You can try out our public hosted demo [here](https://demo.sourcebot.dev)! | ||
| https://github.com/user-attachments/assets/42d5782b-9e8d-4de2-a3b9-6db972901638 | ||
|
coderabbitai[bot] marked this conversation as resolved.
Outdated
|
||
|
|
||
| # Deploy Sourcebot | ||
|
|
||
| Sourcebot can be deployed in seconds using our official docker image. Visit our [docs](https://docs.sourcebot.dev/self-hosting/overview) for more information. | ||
| Sourcebot can be deployed in seconds using our official docker image. Visit our [docs](https://docs.sourcebot.dev/docs/deployment-guide) for more information. | ||
|
|
||
| 1. Create a config | ||
| ```sh | ||
|
|
@@ -106,10 +118,10 @@ docker run \ | |
| </details> | ||
| </br> | ||
|
|
||
| 3. Start searching at `http://localhost:3000` | ||
| 3. Visit `http://localhost:3000` to start using Sourcebot | ||
| </br> | ||
|
|
||
| To learn how to configure Sourcebot to index your own repos, please refer to our [docs](https://docs.sourcebot.dev/self-hosting/overview). | ||
| To configure Sourcebot (index your own repos, connect your LLMs, etc), check out our [docs](https://docs.sourcebot.dev/docs/configuration/config-file). | ||
|
|
||
| > [!NOTE] | ||
| > 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 | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.