diff --git a/README.md b/README.md index ac5ae9761..d3ae06bfb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Sourcegraph Docs - + Welcome to the Sourcegraph documentation! We're excited to have you contribute to our docs. We've recently rearchitectured our docs tech stack — powered by Next.js, TailwindCSS and deployed on Vercel. This guide will walk you through the process of contributing to our documentation using the new tech stack. diff --git a/docs.config.js b/docs.config.js index 25a75d312..4b6be7634 100644 --- a/docs.config.js +++ b/docs.config.js @@ -1,5 +1,5 @@ const config = { - DOCS_LATEST_VERSION: '5.6' + DOCS_LATEST_VERSION: '5.7' }; module.exports = config; diff --git a/docs/admin/config/webhooks/index.mdx b/docs/admin/config/webhooks/index.mdx index c95cab178..2cbc3aff4 100644 --- a/docs/admin/config/webhooks/index.mdx +++ b/docs/admin/config/webhooks/index.mdx @@ -1,4 +1,4 @@ # Webhooks - [Incoming webhooks](/admin/config/webhooks/incoming) -- [Outgoing webhooks](/admin/config/webhooks/outgoing) (Beta) +- [Outgoing webhooks](/admin/config/webhooks/outgoing) diff --git a/docs/admin/config/webhooks/outgoing.mdx b/docs/admin/config/webhooks/outgoing.mdx index 7fc77b2a4..71bb15842 100644 --- a/docs/admin/config/webhooks/outgoing.mdx +++ b/docs/admin/config/webhooks/outgoing.mdx @@ -1,6 +1,6 @@ # Outgoing webhooks - This feature is currently in beta and supported on Sourcegraph versions 5.0 or more. + This feature is supported on Sourcegraph versions 5.0 or more. Outgoing webhooks can be configured on a Sourcegraph instance in order to send Sourcegraph events to external tools and services. This allows for deeper integrations between Sourcegraph and other applications. diff --git a/docs/code-search/types/search-jobs.mdx b/docs/code-search/types/search-jobs.mdx index 5bcc05c06..f8323cd2a 100644 --- a/docs/code-search/types/search-jobs.mdx +++ b/docs/code-search/types/search-jobs.mdx @@ -1,13 +1,25 @@ # Search Jobs -

Use Search Jobs to search code at scale for large-scale organizations.

- - Search Jobs feature is in Beta stage and only available for Enterprise accounts. It is enabled by default since 5.3.0. +Use Search Jobs to search code at scale for large-scale organizations. Search Jobs allows you to run search queries across your organization's codebase (all repositories, branches, and revisions) at scale. It enhances the existing Sourcegraph's search capabilities, enabling you to run searches without query timeouts or incomplete results. With Search Jobs, you can start a search, let it run in the background, and then download the results from the Search Jobs UI when it's done. Site administrators can **enable** or **disable** the Search Jobs feature, making it accessible to all users on the Sourcegraph instance. +## Using Search Jobs + +To use Search Jobs, you need to: + +- Run a search query from your Sourcegraph instance +- Click the result menu below the search bar to see if your query is supported by Search Jobs + +![run-query-for-search-jobs](https://storage.googleapis.com/sourcegraph-assets/Docs/search-jobs/search-jobs-create.png) + +- If your query is valid, click **Create a search job** to initiate the search job +- You will be redirected to the "Search Jobs UI" page at `/search-jobs`, where you can view all your created search jobs. If you're a site admin, you can also view search jobs from other users on the instance + +![view-search-jobs](https://storage.googleapis.com/sourcegraph-assets/Docs/search-jobs/search-jobs-manage.png) + ## Search results format The downloaded results are formatted as [JSON lines](https://jsonlines.org). @@ -67,21 +79,6 @@ If you would like to allow your Sourcegraph instance to control the creation and - `SEARCH_JOBS_UPLOAD_MANAGE_BUCKET=true` -## Using Search Jobs - -To use Search Jobs, you need to: - -- Run a search query from your Sourcegraph instance -- Click the result menu below the search bar to see if your query is valid for the long search - -![run-query-for-search-jobs](https://storage.googleapis.com/sourcegraph-assets/Docs/query-serach-jobs.png) - -- If your query is valid, click **Run search job** to initiate the search job -- You will be redirected to the "Search Jobs UI" page at `/search-jobs`, where you can view all your created search jobs. If you're a site admin, you can also view search jobs from other users on the instance - -![view-search-jobs](https://storage.googleapis.com/sourcegraph-assets/Docs/view-search-jobs.png) - - ## Supported result types Search jobs supports the following result types: @@ -99,20 +96,20 @@ The following result types are not supported: The following elements of our query language are not supported: - file predicates, such as `file:has.content`, `file:has.owner`, `file:has.contributor`, `file:contains.content` -- `.*` regexp search +- catch-all `.*` regexp search - Multiple `rev` filters - Queries with `index: filter` -The search bar already supports exhaustive searches with the `count:all` operator. However, these searches are subject to lower timeouts, making them harder to use in large codebases. -## Disable Search Jobs + + Alternatively, the search bar supports the `count:all` operator which increases result limits and timeouts. + This works well if the search completes within a few minutes and the number of results is less than the configured display limit. + For longer running searches and searches with huge result sets, Search Jobs is the better choice. + -Follow these steps to disable Search Jobs and to hide the feature in the Sourcegraph UI: +## Disable Search Jobs -- Login to your Sourcegraph instance and go to the site admin -- Next, click the site configuration -- From here, you'll see `experimentalFeatures` -- Set `searchJobs` to `false` and then refresh the page +To disable Search Jobs, set `DISABLE_SEARCH_JOBS=true` in your frontend and worker services. ## FAQ diff --git a/docs/code_monitoring/how-tos/index.mdx b/docs/code_monitoring/how-tos/index.mdx index 5b480f0f7..dafa49f2a 100644 --- a/docs/code_monitoring/how-tos/index.mdx +++ b/docs/code_monitoring/how-tos/index.mdx @@ -2,4 +2,4 @@ * [Starting points](/code_monitoring/how-tos/starting_points) * [Setting up Slack notifications](/code_monitoring/how-tos/slack) -* [Setting up Webhook notifications](/code_monitoring/how-tos/webhook) (Beta) +* [Setting up Webhook notifications](/code_monitoring/how-tos/webhook) diff --git a/docs/code_monitoring/how-tos/webhook.mdx b/docs/code_monitoring/how-tos/webhook.mdx index 6f297905e..71a0c057d 100644 --- a/docs/code_monitoring/how-tos/webhook.mdx +++ b/docs/code_monitoring/how-tos/webhook.mdx @@ -1,7 +1,5 @@ # Setting up Webhook notifications -This feature is in beta. - Webhook notifications provide a way to execute custom responses to a code monitor notification. They are implemented as a POST request to a URL of your choice. The body of the request is defined by Sourcegraph, and contains all the information available about the cause of the notification. diff --git a/docs/cody/capabilities/autocomplete.mdx b/docs/cody/capabilities/autocomplete.mdx index 831a61c51..9d73350ba 100644 --- a/docs/cody/capabilities/autocomplete.mdx +++ b/docs/cody/capabilities/autocomplete.mdx @@ -18,7 +18,7 @@ Cody's autocompletion model has been designed to enhance speed, accuracy, and th - **Improved accuracy for multi-line completions**: Completions across multiple lines are more relevant and accurately aligned with the surrounding code context - **Higher completion acceptance rates**: The average completion acceptance rate (CAR) is improved by more than 4%, providing a more intuitive user interaction -On the technical side, Cody's autocomplete is optimized for both server-side and client-side performance, ensuring seamless integration into your coding workflow. The **default** autocomplete model for Cody Free and Pro users is **[DeepSeek V2](https://huggingface.co/deepseek-ai/DeepSeek-V2)**, which significantly helps boost both the responsiveness and accuracy of autocomplete. Cody Enterprise users get **StarCoder** as the default autocomplete model. +On the technical side, Cody's autocomplete is optimized for both server-side and client-side performance, ensuring seamless integration into your coding workflow. The **default** autocomplete model for Cody Free, Pro and Enterprise users is **[DeepSeek V2](https://huggingface.co/deepseek-ai/DeepSeek-V2)**, which significantly helps boost both the responsiveness and accuracy of autocomplete. Cody Enterprise users get **StarCoder** as the default autocomplete model. ## Prerequisites diff --git a/docs/cody/capabilities/supported-models.mdx b/docs/cody/capabilities/supported-models.mdx index 9108bb344..db748c0f7 100644 --- a/docs/cody/capabilities/supported-models.mdx +++ b/docs/cody/capabilities/supported-models.mdx @@ -31,7 +31,7 @@ Cody uses a set of models for autocomplete which are suited for the low latency | **Provider** | **Model** | **Free** | **Pro** | **Enterprise** | | | | | | :-------------------- | :---------------------------------------------------------------------------------------- | :------- | :------ | :------------- | --- | --- | --- | --- | -| Fireworks.ai | [DeepSeek-V2](https://huggingface.co/deepseek-ai/DeepSeek-V2) | ✅ | ✅ | - | | | | | +| Fireworks.ai | [DeepSeek-V2](https://huggingface.co/deepseek-ai/DeepSeek-V2) | ✅ | ✅ | ✅ | | | | | | Fireworks.ai | [StarCoder](https://arxiv.org/abs/2305.06161) | - | - | ✅ | | | | | | Anthropic | [claude Instant](https://docs.anthropic.com/claude/docs/models-overview#model-comparison) | - | - | ✅ | | | | | | Google Gemini (Beta) | [1.5 Flash](https://deepmind.google/technologies/gemini/flash/) | - | - | ✅ | | | | | diff --git a/docs/cody/clients/cody-with-sourcegraph.mdx b/docs/cody/clients/cody-with-sourcegraph.mdx index 11bc54870..17b46f521 100644 --- a/docs/cody/clients/cody-with-sourcegraph.mdx +++ b/docs/cody/clients/cody-with-sourcegraph.mdx @@ -2,12 +2,10 @@

Learn how to use Cody in the web interface with your Sourcegraph.com instance.

- The new chat UI for Cody for web is currently in Beta and is available to users on Sourcegraph versions >=5.5. - In addition to the Cody extensions for [VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains) IDEs, and [Neovim](/cody/clients/install-neovim), Cody is also available in the Sourcegraph web app. Community users can use Cody for free by logging into their accounts on Sourcegraph.com, and enterprise users can use Cody within their Sourcegraph instance. - + ## Initial setup @@ -27,13 +25,15 @@ The chat interface for Cody on the web is similar to the one you get with the [V The chat interface with your Code Search queries is operated per chat. You cannot run multiple chats and store them in parallel. A new chat window opens whenever you click the Cody button from the query editor or the top header. + The new and improved chat UI for Cody for web is currently available to users on Sourcegraph versions >=5.5. It's recommeded to update your Sourcegraph instance to the latest version to use this new chat interface. + ## LLM Selection -Sourcegraph.com users with Cody **Free** and **Pro** can choose from a list of supported LLM models for a chat. Claude Sonnet 3 is the default LLM model, but users can select the LLM of their choice from the drop-down menu. +Sourcegraph.com users with Cody **Free** and **Pro** can choose from a list of supported LLM models for a chat. Claude Sonnet 3.5 is the default LLM model, but users can select the LLM of their choice from the drop-down menu. ![llm-select-web](https://storage.googleapis.com/sourcegraph-assets/Docs/llm-select-web-0724.jpg) -Users on an Enterprise Sourcegraph instance do not have the option to choose an LLM model. Their site admin will configure the default LLM model for chat. +Users on an Enterprise Sourcegraph instance do not have the option to choose an LLM model. Their site admin will configure the default LLM model for chat. However, Enterprise users with the new [model configuration](/cody/clients/model-configuration) can use the LLM selection dropdown to choose a chat model. ## Selecting Context with @-mentions diff --git a/docs/cody/clients/enable-cody-enterprise.mdx b/docs/cody/clients/enable-cody-enterprise.mdx index 625bcb24f..66da9e1d3 100644 --- a/docs/cody/clients/enable-cody-enterprise.mdx +++ b/docs/cody/clients/enable-cody-enterprise.mdx @@ -67,6 +67,22 @@ Cody Enterprise supports searching up to 10 repositories to find relevant contex * In VS Code, open a new Cody chat, type `@`, and select `Remote Repositories` to search other repositories for context * In JetBrains, use the enhanced context selector +### @-mention directory + +@-mentioning directory is available for Enterprise users on VS Code, JetBrains, and Cody Web. + +To better support teams working with large monorepos, Enterprise users can `@-mention` directories when chatting with Cody. This helps you define more specific directories and sub-directories within that monorepo to give more precise context. + +To do this, type `@` in the chat, and then select **Directories** to search other repositories for context in your codebase. + + + +Please note that you can only `@-mention` remote directories (i.e., directories in your Sourcegraph instance) but not local directories. This means any recent changes to your directories can't be utilized as context until your Sourcegraph instance re-indexes any changes. + +If you want to include recent changes that haven't been indexed in your Sourcegraph instance, you can `@-mention` specific files, lines of code, or symbols. + ## Supported LLM models Sourcegraph Enterprise supports many different LLM providers and models. You can use state of the art code completion models such as Anthropic's Claude or OpenAI's ChatGPT by adjusting your Sourcegraph instance's configuration. diff --git a/docs/cody/clients/feature-reference.mdx b/docs/cody/clients/feature-reference.mdx index 4b2855ea4..4872ec782 100644 --- a/docs/cody/clients/feature-reference.mdx +++ b/docs/cody/clients/feature-reference.mdx @@ -21,7 +21,7 @@ | Local context | ✅ | ✅ | ❌ | | OpenCtx context providers (experimental) | ✅ | ❌ | ❌ | | **Prompts and Commands** | | | | -| Access to prompts and Prompt library | ✅ | ❌ | ✅ | +| Access to prompts and Prompt library | ✅ | ✅ | ✅ | | Custom commands | ✅ | ❌ | ❌ | | Edit code | ✅ | ✅ | ❌ | | Generate unit test | ✅ | ✅ | ❌ | @@ -49,5 +49,6 @@ Few exceptions that apply to Cody Pro and Cody Enterprise users: - Multi-repo context is supported on VS Code, JetBrains, and Web - [Guardrails](/cody/clients/enable-cody-enterprise#guardrails) are supported on VS Code, JetBrains, and Web - [Repo-based Cody Context Filters](/cody/capabilities/ignore-context#cody-context-filters) are supported on VS Code, JetBrains, and Web +- `@-mention` directories are supported on VS Code, JetBrains, and Web diff --git a/docs/cody/clients/install-jetbrains.mdx b/docs/cody/clients/install-jetbrains.mdx index 72c3452f5..5dc584737 100644 --- a/docs/cody/clients/install-jetbrains.mdx +++ b/docs/cody/clients/install-jetbrains.mdx @@ -66,122 +66,105 @@ Once Cody is successfully connected, you'll see that the sign-in panel has been Cody provides intelligent code suggestions and context-aware autocompletions for numerous programming languages like JavaScript, Python, TypeScript, Go, etc. - Create a new file in IntelliJ, for example, `code.js` -- Next, type the following algorithm function to sort an array of numbers - -```js -function bubbleSort(array) -``` - - As you start typing, Cody will automatically provide suggestions and context-aware completions based on your coding patterns and the code context - These autocomplete suggestions appear as grayed text. To accept the suggestion, press the `Tab` key -## Autocomplete +## Chat -Cody provides multi-line autocomplete as you type. Autocomplete suggestions appear as inlay suggestions and are enabled by default in your JetBrains IntelliJ editor. With this setting, there is a list of programming languages supported and enabled by default. +Cody chat in JetBrains is available in a unified interface opened right next to your code. Once connected to Sourcegraph, a new chat input field is opened with a default `@-mention` [context chips](#context-retrieval). -To manually configure the Autocomplete feature, +All your previous and existing chats are stored for later use and can be accessed via the **History** icon from the top menu. You can download them to share or use later in a `.json` file or delete them altogether. -- Go to the **Cody Settings...** from the Cody icon in the sidebar -- Next, click the **Sourcegraph & Cody** dropdown and select **Cody** -- The **Autocomplete** settings will appear with the list of **Enabled Languages** +### Chat interface -Autocomplete suggestions use the same color as inline parameter hints according to your configured editor theme. However, you can optionally enable the **Custom color for completions** checkbox to customize the color of your choice. - -In addition, you can use the following keyboard shortcuts to interact with Cody's autocomplete suggestions: +The chat interface is designed intuitively. Your very first chat input lives at the top of the panel, and the first message in any chat log will stay pinned to the top of the chat. After your first message, the chat input window moves to the bottom of the sidebar. -- `Tab` to accept a suggestion -- `Alt + [` (Windows) or `Opt + [` (macOS) to cycle suggestions -- `Alt + \` (Windows) or `Opt + \` (macOS) to manually trigger autocomplete if no suggestions have been returned +Since your first message to Cody anchors the conversation, you can return to the top chat box anytime, edit your prompt, or re-run it using a different LLM model. -