mirror of
https://github.com/sourcebot-dev/sourcebot.git
synced 2025-12-11 20:05:25 +00:00
Update references to github discussions over to issues
This commit is contained in:
parent
24116989ed
commit
6fc771a0d3
15 changed files with 21 additions and 34 deletions
|
|
@ -286,7 +286,7 @@ Sourcebot v3 is here and brings a number of structural changes to the tool's fou
|
||||||
|
|
||||||
### Removed
|
### Removed
|
||||||
- [**Breaking Change**] Removed `db.json` in favour of a Postgres database for transactional workloads. See the [architecture overview](https://docs.sourcebot.dev/self-hosting/overview#architecture).
|
- [**Breaking Change**] Removed `db.json` in favour of a Postgres database for transactional workloads. See the [architecture overview](https://docs.sourcebot.dev/self-hosting/overview#architecture).
|
||||||
- [**Breaking Change**] Removed local folder & arbitrary .git repo support. If your deployment depended on these features, please [open a discussion](https://github.com/sourcebot-dev/sourcebot/discussions/categories/support) and let us know.
|
- [**Breaking Change**] Removed local folder & arbitrary .git repo support. If your deployment depended on these features, please [open a issue](https://github.com/sourcebot-dev/sourcebot/issues/new?template=get_help.md) and let us know.
|
||||||
- [**Breaking Chnage**] Removed ability to specify a `token` as a string literal from the schema.
|
- [**Breaking Chnage**] Removed ability to specify a `token` as a string literal from the schema.
|
||||||
- [**Breaking Change**] Removed support for `DOMAIN_SUB_PATH` configuration.
|
- [**Breaking Change**] Removed support for `DOMAIN_SUB_PATH` configuration.
|
||||||
|
|
||||||
|
|
|
||||||
11
README.md
11
README.md
|
|
@ -19,15 +19,12 @@
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<a href="https://docs.sourcebot.dev/"><strong>Docs</strong></a> ·
|
<a href="https://docs.sourcebot.dev/"><strong>Docs</strong></a> ·
|
||||||
<a href="https://github.com/sourcebot-dev/sourcebot/issues"><strong>Report Bug</strong></a> ·
|
<a href="https://github.com/sourcebot-dev/sourcebot/issues/459"><strong>Roadmap</strong></a> ·
|
||||||
<a href="https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas"><strong>Feature Request</strong></a> ·
|
<a href="https://github.com/sourcebot-dev/sourcebot/issues/new?template=bug_report.yml"><strong>Report Bug</strong></a> ·
|
||||||
<a href="https://www.sourcebot.dev/changelog"><strong>Changelog</strong></a> ·
|
<a href="https://github.com/sourcebot-dev/sourcebot/issues/new?template=feature_request.md"><strong>Feature Request</strong></a> ·
|
||||||
<a href="https://www.sourcebot.dev/contact"><strong>Contact</strong></a> ·
|
<a href="https://www.sourcebot.dev/changelog"><strong>Changelog</strong></a>
|
||||||
</div>
|
</div>
|
||||||
<br/>
|
<br/>
|
||||||
<span>Sourcebot uses <a href="https://github.com/sourcebot-dev/sourcebot/discussions"><strong>Github Discussions</strong></a> for Support and Feature Requests.</span>
|
|
||||||
<br/>
|
|
||||||
<br/>
|
|
||||||
<div>
|
<div>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|
|
||||||
|
|
@ -109,7 +109,7 @@
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"anchor": "Support",
|
"anchor": "Support",
|
||||||
"href": "https://github.com/sourcebot-dev/sourcebot/discussions/categories/support",
|
"href": "https://github.com/sourcebot-dev/sourcebot/issues/new?template=get_help.md",
|
||||||
"icon": "life-ring"
|
"icon": "life-ring"
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
|
|
||||||
|
|
@ -41,6 +41,4 @@ This page covers a range of frequently asked questions about Sourcebot's built-i
|
||||||
</Accordion>
|
</Accordion>
|
||||||
</AccordionGroup>
|
</AccordionGroup>
|
||||||
|
|
||||||
|
Have a question that's not answered here? Submit an issue on [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) and we'll get back to you as soon as we can.
|
||||||
Have a question that's not answered here? Submit it on our [GitHub discussions](https://github.com/sourcebot-dev/sourcebot/discussions)
|
|
||||||
page and we'll get back to you as soon as we can!
|
|
||||||
|
|
@ -25,4 +25,4 @@ Sourcebot's built-in authentication system gates your deployment, and allows adm
|
||||||
# Troubleshooting
|
# Troubleshooting
|
||||||
|
|
||||||
- If you experience issues logging in, logging out, or accessing an organization you should have access to, try clearing your cookies & performing a full page refresh (`Cmd/Ctrl + Shift + R` on most browsers).
|
- If you experience issues logging in, logging out, or accessing an organization you should have access to, try clearing your cookies & performing a full page refresh (`Cmd/Ctrl + Shift + R` on most browsers).
|
||||||
- Still not working? Reach out to us on our [discord](https://discord.com/invite/6Fhp27x7Pb) or [github discussions](https://github.com/sourcebot-dev/sourcebot/discussions)
|
- Still not working? Reach out to us on our [discord](https://discord.com/invite/6Fhp27x7Pb) or [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose)
|
||||||
|
|
@ -43,7 +43,7 @@ provide Sourcebot.
|
||||||
# Supported Providers
|
# Supported Providers
|
||||||
|
|
||||||
Sourcebot uses the [Vercel AI SDK](https://ai-sdk.dev/docs/introduction), so it can integrate with any provider the SDK supports. If you don't see your provider below please submit
|
Sourcebot uses the [Vercel AI SDK](https://ai-sdk.dev/docs/introduction), so it can integrate with any provider the SDK supports. If you don't see your provider below please submit
|
||||||
a [feature request](https://github.com/sourcebot-dev/sourcebot/discussions/categories/feature-requests).
|
a [feature request](https://github.com/sourcebot-dev/sourcebot/issues/new?template=feature_request.md).
|
||||||
|
|
||||||
For a detailed description of all the providers, please refer to the [schema](https://github.com/sourcebot-dev/sourcebot/blob/main/schemas/v3/languageModel.json).
|
For a detailed description of all the providers, please refer to the [schema](https://github.com/sourcebot-dev/sourcebot/blob/main/schemas/v3/languageModel.json).
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -6,7 +6,7 @@ icon: crow
|
||||||
|
|
||||||
import GerritSchema from '/snippets/schemas/v3/gerrit.schema.mdx'
|
import GerritSchema from '/snippets/schemas/v3/gerrit.schema.mdx'
|
||||||
|
|
||||||
<Note>Authenticating with Gerrit is currently not supported. If you need this capability, please raise a [feature request](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).</Note>
|
<Note>Authenticating with Gerrit is currently not supported. If you need this capability, please raise a [feature request](https://github.com/sourcebot-dev/sourcebot/issues/new?template=feature_request.md).</Note>
|
||||||
|
|
||||||
Sourcebot can sync code from self-hosted gerrit instances.
|
Sourcebot can sync code from self-hosted gerrit instances.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -67,7 +67,7 @@ To learn more about how to create a connection for a specific code host, check o
|
||||||
|
|
||||||
<SupportedPlatforms />
|
<SupportedPlatforms />
|
||||||
|
|
||||||
<Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).</Note>
|
<Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new?template=feature_request.md).</Note>
|
||||||
|
|
||||||
|
|
||||||
## Schema reference
|
## Schema reference
|
||||||
|
|
|
||||||
|
|
@ -1,8 +1,8 @@
|
||||||
---
|
---
|
||||||
sidebarTitle: Request another host
|
sidebarTitle: Request another host
|
||||||
url: https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas
|
url: https://github.com/sourcebot-dev/sourcebot/issues/new?template=feature_request.md
|
||||||
title: Request another code host
|
title: Request another code host
|
||||||
icon: plus
|
icon: plus
|
||||||
---
|
---
|
||||||
|
|
||||||
Is your code host not supported? Please open a [feature request](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).
|
Is your code host not supported? Please open a [feature request](https://github.com/sourcebot-dev/sourcebot/issues/new?template=feature_request.md).
|
||||||
|
|
@ -7,7 +7,7 @@ import SupportedPlatforms from '/snippets/platform-support.mdx'
|
||||||
The following guide will walk you through the steps to deploy Sourcebot on your own infrastructure. Sourcebot is distributed as a [single docker container](/docs/overview#architecture) that can be deployed to a k8s cluster, a VM, or any platform that supports docker.
|
The following guide will walk you through the steps to deploy Sourcebot on your own infrastructure. Sourcebot is distributed as a [single docker container](/docs/overview#architecture) that can be deployed to a k8s cluster, a VM, or any platform that supports docker.
|
||||||
|
|
||||||
|
|
||||||
<Note>Hit an issue? Please let us know on [GitHub discussions](https://github.com/sourcebot-dev/sourcebot/discussions/categories/support) or by [emailing us](mailto:team@sourcebot.dev).</Note>
|
<Note>Hit an issue? Please let us know on [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) or by [emailing us](mailto:team@sourcebot.dev).</Note>
|
||||||
|
|
||||||
<Steps>
|
<Steps>
|
||||||
<Step title="Requirements">
|
<Step title="Requirements">
|
||||||
|
|
|
||||||
|
|
@ -4,7 +4,7 @@ sidebarTitle: "Overview"
|
||||||
---
|
---
|
||||||
|
|
||||||
<Warning>
|
<Warning>
|
||||||
Agents are currently a experimental feature. Have an idea for an agent that we haven't built? Submit a [feature request](https://github.com/sourcebot-dev/sourcebot/discussions/categories/feature-requests) on our GitHub.
|
Agents are currently a experimental feature. Have an idea for an agent that we haven't built? Submit a [feature request](https://github.com/sourcebot-dev/sourcebot/issues/new?template=feature_request.md) on our GitHub.
|
||||||
</Warning>
|
</Warning>
|
||||||
|
|
||||||
Agents are automations that leverage the code indexed on Sourcebot to perform a specific task. Once you've setup Sourcebot, check out the
|
Agents are automations that leverage the code indexed on Sourcebot to perform a specific task. Once you've setup Sourcebot, check out the
|
||||||
|
|
|
||||||
|
|
@ -12,7 +12,7 @@ By default, only the default branch of a repository is indexed and can be search
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
<Warning>
|
<Warning>
|
||||||
Multi-branch indexing is currently limited to 64 branches and tags. If this limitation impacts your use-case, please [open a discussion](https://github.com/sourcebot-dev/sourcebot/discussions/categories/support).
|
Multi-branch indexing is currently limited to 64 branches and tags. Please see [this issue](https://github.com/sourcebot-dev/sourcebot/issues/461) for more details.
|
||||||
</Warning>
|
</Warning>
|
||||||
|
|
||||||
Multi-branch indexing is configured in the [connection](/docs/connections/overview) using the `revisions.branches` and `revisions.tags` arrays. Glob patterns are supported. For example:
|
Multi-branch indexing is configured in the [connection](/docs/connections/overview) using the `revisions.branches` and `revisions.tags` arrays. Glob patterns are supported. For example:
|
||||||
|
|
|
||||||
|
|
@ -78,7 +78,7 @@ If your deployment is dependent on these features, please [reach out](https://gi
|
||||||
After updating your configuration file, restart your Sourcebot deployment to pick up the new changes.
|
After updating your configuration file, restart your Sourcebot deployment to pick up the new changes.
|
||||||
</Step>
|
</Step>
|
||||||
<Step title="You're done!">
|
<Step title="You're done!">
|
||||||
Congrats, you've successfully migrated to v3! Please let us know what you think of the new features by reaching out on our [discord](https://discord.gg/6Fhp27x7Pb) or [GitHub discussion](https://github.com/sourcebot-dev/sourcebot/discussions/categories/support)
|
Congrats, you've successfully migrated to v3! Please let us know what you think of the new features by reaching out on our [discord](https://discord.gg/6Fhp27x7Pb) or on [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose).
|
||||||
</Step>
|
</Step>
|
||||||
</Steps>
|
</Steps>
|
||||||
|
|
||||||
|
|
@ -90,4 +90,4 @@ Some things to check:
|
||||||
- Make sure you have a name for each `connection`, and that the name only contains letters, digits, hyphens, or underscores
|
- Make sure you have a name for each `connection`, and that the name only contains letters, digits, hyphens, or underscores
|
||||||
- Make sure each `connection` has a `type` field with a valid value (`gitlab`, `github`, `gitea`, `gerrit`)
|
- Make sure each `connection` has a `type` field with a valid value (`gitlab`, `github`, `gitea`, `gerrit`)
|
||||||
|
|
||||||
Having troubles migrating from v2 to v3? Reach out to us on [discord](https://discord.gg/6Fhp27x7Pb) or [GitHub discussion](https://github.com/sourcebot-dev/sourcebot/discussions/categories/support) and we'll try our best to help
|
Having troubles migrating from v2 to v3? Reach out to us on [discord](https://discord.gg/6Fhp27x7Pb) or [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) and we'll try our best to help
|
||||||
|
|
@ -40,7 +40,7 @@ Please note that the following features are no longer supported in v4:
|
||||||
|
|
||||||
</Step>
|
</Step>
|
||||||
<Step title="You're done!">
|
<Step title="You're done!">
|
||||||
Congrats, you've successfully migrated to v4! Please let us know what you think of the new features by reaching out on our [discord](https://discord.gg/6Fhp27x7Pb) or [GitHub discussion](https://github.com/sourcebot-dev/sourcebot/discussions/categories/support)
|
Congrats, you've successfully migrated to v4! Please let us know what you think of the new features by reaching out on our [discord](https://discord.gg/6Fhp27x7Pb) or [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose)
|
||||||
</Step>
|
</Step>
|
||||||
</Steps>
|
</Steps>
|
||||||
|
|
||||||
|
|
@ -58,4 +58,4 @@ to finish upgrading to v4 in single-tenant mode.
|
||||||
- If you're hitting issues with signing into your Sourcebot instance, make sure you're setting `AUTH_URL` correctly to your deployment domain (ex. `https://sourcebot.yourcompany.com`)
|
- If you're hitting issues with signing into your Sourcebot instance, make sure you're setting `AUTH_URL` correctly to your deployment domain (ex. `https://sourcebot.yourcompany.com`)
|
||||||
|
|
||||||
|
|
||||||
Having troubles migrating from v3 to v4? Reach out to us on [discord](https://discord.gg/6Fhp27x7Pb) or [GitHub discussion](https://github.com/sourcebot-dev/sourcebot/discussions/categories/support) and we'll try our best to help
|
Having troubles migrating from v3 to v4? Reach out to us on [discord](https://discord.gg/6Fhp27x7Pb) or [GitHub](https://github.com/sourcebot-dev/sourcebot/issues/new/choose) and we'll try our best to help
|
||||||
|
|
@ -207,18 +207,10 @@ Sourcebot supports the following code hosts:
|
||||||
- [Gitea](https://docs.sourcebot.dev/docs/connections/gitea)
|
- [Gitea](https://docs.sourcebot.dev/docs/connections/gitea)
|
||||||
- [Gerrit](https://docs.sourcebot.dev/docs/connections/gerrit)
|
- [Gerrit](https://docs.sourcebot.dev/docs/connections/gerrit)
|
||||||
|
|
||||||
| Don't see your code host? Open a [GitHub discussion](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).
|
| Don't see your code host? Open a [feature request](https://github.com/sourcebot-dev/sourcebot/issues/new?template=feature_request.md).
|
||||||
|
|
||||||
## Future Work
|
## Future Work
|
||||||
|
|
||||||
### Semantic Search
|
### Semantic Search
|
||||||
|
|
||||||
Currently, Sourcebot only supports regex-based code search (powered by [zoekt](https://github.com/sourcegraph/zoekt) under the hood). It is great for scenarios when the agent is searching for is something that is super precise and well-represented in the source code (e.g., a specific function name, a error string, etc.). It is not-so-great for _fuzzy_ searches where the objective is to find some loosely defined _category_ or _concept_ in the code (e.g., find code that verifies JWT tokens). The LLM can approximate this by crafting regex searches that attempt to capture a concept (e.g., it might try a query like `"jwt|token|(verify|validate).*(jwt|token)"`), but often yields sub-optimal search results that aren't related. Tools like Cursor solve this with [embedding models](https://docs.cursor.com/context/codebase-indexing) to capture the semantic meaning of code, allowing for LLMs to search using natural language. We would like to extend Sourcebot to support semantic search and expose this capability over MCP as a tool (e.g., `semantic_search_code` tool). [GitHub Discussion](https://github.com/sourcebot-dev/sourcebot/discussions/297)
|
Currently, Sourcebot only supports regex-based code search (powered by [zoekt](https://github.com/sourcegraph/zoekt) under the hood). It is great for scenarios when the agent is searching for is something that is super precise and well-represented in the source code (e.g., a specific function name, a error string, etc.). It is not-so-great for _fuzzy_ searches where the objective is to find some loosely defined _category_ or _concept_ in the code (e.g., find code that verifies JWT tokens). The LLM can approximate this by crafting regex searches that attempt to capture a concept (e.g., it might try a query like `"jwt|token|(verify|validate).*(jwt|token)"`), but often yields sub-optimal search results that aren't related. Tools like Cursor solve this with [embedding models](https://docs.cursor.com/context/codebase-indexing) to capture the semantic meaning of code, allowing for LLMs to search using natural language. We would like to extend Sourcebot to support semantic search and expose this capability over MCP as a tool (e.g., `semantic_search_code` tool). [GitHub Discussion](https://github.com/sourcebot-dev/sourcebot/discussions/297)
|
||||||
|
|
||||||
### Code Navigation
|
|
||||||
|
|
||||||
Another idea is to allow LLMs to traverse abstract syntax trees (ASTs) of a codebase to enable reliable code navigation. This could be packaged as tools like `goto_definition`, `find_all_references`, etc., which could be useful for LLMs to get additional code context. [GitHub Discussion](https://github.com/sourcebot-dev/sourcebot/discussions/296)
|
|
||||||
|
|
||||||
### Got an idea?
|
|
||||||
|
|
||||||
Open up a [GitHub discussion](https://github.com/sourcebot-dev/sourcebot/discussions/categories/feature-requests)!
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue