diff --git a/README.md b/README.md index d11cfd90c..6f3a72b7f 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ # 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 f2d46d486..9b9b6ccb7 100644 --- a/docs.config.js +++ b/docs.config.js @@ -1,5 +1,5 @@ const config = { - DOCS_LATEST_VERSION: '6.4' + DOCS_LATEST_VERSION: '6.5' }; module.exports = config; diff --git a/docs/admin/access_control/service_accounts.mdx b/docs/admin/access_control/service_accounts.mdx index 70e309023..bc7f32fc7 100644 --- a/docs/admin/access_control/service_accounts.mdx +++ b/docs/admin/access_control/service_accounts.mdx @@ -12,12 +12,16 @@ Service accounts are created like regular user accounts, but with a few key diff - Check the **Service account** checkbox - Click **Create service account** +![create-service-account](https://storage.googleapis.com/sourcegraph-assets/Docs/create-service-accounts-0625.png) + You'll be presented with some next steps you might want to take, like creating an access token, managing and assigning roles, and managing repository permissions. - Service accounts are automatically assigned the "Service Account" system role - They appear in the user list with "Service account" type designation - By default, service accounts can only access public and unrestricted repositories +![next-steps-service-account](https://storage.googleapis.com/sourcegraph-assets/Docs/service-accounts-next-steps-0625.png) + ## Managing Access Tokens Service accounts authenticate using access tokens rather than passwords. For detailed information about creating, managing, and using access tokens, see: @@ -44,8 +48,12 @@ Administrators can assign additional roles to service accounts through the user - [Managing user roles](/admin/access_control#managing-user-roles) - [Creating custom roles](/admin/access_control#creating-a-new-role-and-assigning-it-permissions) +![service-account-roles](https://storage.googleapis.com/sourcegraph-assets/Docs/service-accounts-manage-roles-0625.png) + ## Repository Permissions Service accounts respect repository permissions and access controls. For comprehensive information about repository permissions, see the [Repository permissions](/admin/permissions) documentation. -Service accounts by default can only access public and unrestricted repositories in Sourcegraph. You may explicitly grant fine-grained access to private repositories from the service account's user settings page, under the **Repo permissions** tab, or via [the GraphQL API](/admin/permissions/api#explicit-permissions-api). In the **Repo permissions** tab, you can also grant service accounts access to all current and future repositories on Sourcegraph, regardless of their visibility, which is useful for service accounts that need to do things like perform search jobs, but admins should take care to ensure that the access tokens for these accounts are not shared with unauthorized users. \ No newline at end of file +Service accounts by default can only access public and unrestricted repositories in Sourcegraph. You may explicitly grant fine-grained access to private repositories from the service account's user settings page, under the **Repo permissions** tab, or via [the GraphQL API](/admin/permissions/api#explicit-permissions-api). In the **Repo permissions** tab, you can also grant service accounts access to all current and future repositories on Sourcegraph, regardless of their visibility, which is useful for service accounts that need to do things like perform search jobs, but admins should take care to ensure that the access tokens for these accounts are not shared with unauthorized users. + +![service-account-repo-permissions](https://storage.googleapis.com/sourcegraph-assets/Docs/service-accounts-repo-permissions-0625.png) diff --git a/docs/batch-changes/bulk-operations-on-changesets.mdx b/docs/batch-changes/bulk-operations-on-changesets.mdx index 36f623072..736cb27f6 100644 --- a/docs/batch-changes/bulk-operations-on-changesets.mdx +++ b/docs/batch-changes/bulk-operations-on-changesets.mdx @@ -36,6 +36,7 @@ Below is a list of supported bulk operations for changesets and the conditions w | **Merge** | Merge the selected changesets on code hosts. Some changesets may be unmergeable due to their states, which does not impact the overall bulk operation. Failed merges are listed under the bulk operations tab. In the confirmation modal, you can opt for a squash merge strategy, available on GitHub, GitLab, and Bitbucket Cloud. For Bitbucket Server/Data Center, only regular merges are performed | | **Close** | Close the selected changesets on the code hosts | | **Publish** | Publishes the selected changesets, provided they don't have a [`published` field](/batch-changes/batch-spec-yaml-reference#changesettemplatepublished) in the batch spec. You can choose between draft and normal changesets in the confirmation modal | +| **Push-only** | Pushes code changes to a new branch on a code host without making a merge request. Available on GitHub and GitLab only. | | **Export** | Export selected changesets that you can use for later use | | **Re-execute** | Users can re-execute individual changeset creation logic for selected workspaces. This allows for creating new changesets for users who are using non-deterministic run steps (for example,LLMs) | | **Enable auto-merge for GitHub (experimental)** | Enable auto-merge on selected GitHub changesets. When enabled, changesets will be automatically merged once all required status checks pass and any blocking reviews are resolved. This feature is GitHub-specific and requires [appropriate setup](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository) on the target repositories. Failed actions are listed under the bulk operations tab. | diff --git a/docs/batch-changes/push-only-changesets.mdx b/docs/batch-changes/push-only-changesets.mdx new file mode 100644 index 000000000..3a1953c19 --- /dev/null +++ b/docs/batch-changes/push-only-changesets.mdx @@ -0,0 +1,30 @@ +# Pushing code to a code host + +

Learn how to push code changes to a code host without making a merge request.

+ +Pushed-only changesets work on GitHub and GitLab only. They do not yet work with forked repositories. + +After you've [created a batch change](/batch-changes/create-a-batch-change), you will be redirected to a page displaying a list of the changesets the Batch Change created. From this page, you can apply any bulk operation to more than one changesets. + + To push code to a new branch on a code host without also creating a merge request, simply select **Push to code host only** from the dropdown menu: + +![push-only-dropdown](https://storage.googleapis.com/sourcegraph-assets/Docs/push-only-dropdown-0625.png) + +## Few important considerations + +- With pushed-only changesets, you are still able see CI feedback, as long as it triggers on code pushes +- The `review` status of a pushed-only changeset is always "N/A" +- The `status` of a pushed-only changeset is always "Open" +- To publish a pushed-only changeset, simply select the changeset in the Batch Changes UI and select **Publish** + +![push-only-changesets-executed](https://storage.googleapis.com/sourcegraph-assets/Docs/push-only-executed-0625.png) + +## Requirements + +To push code to a new branch on a code host, you will need: + +- [Admin permissions for the batch change](/batch-changes/permissions-in-batch-changes#permission-levels-for-batch-changes) +- Write access to the changeset's repository on the code host +- [Credentials](/batch-changes/configuring-credentials) configured for the code host + +For more information, see [Code host interactions in Batch Changes](/batch-changes/permissions-in-batch-changes#code-host-interactions-in-batch-changes). diff --git a/docs/batch-changes/quickstart.mdx b/docs/batch-changes/quickstart.mdx index 27c2b5cba..0f273555f 100644 --- a/docs/batch-changes/quickstart.mdx +++ b/docs/batch-changes/quickstart.mdx @@ -100,9 +100,10 @@ The batch change's **changesets** still need to be published, which means they e ## Publish a changeset -So far, nothing has been created on your code hosts. To do so, you must tell Sourcegraph to **publish a changeset**. +So far, nothing has been created on your code hosts. To do so, you can tell Sourcegraph to either **publish** or **push** a changeset. -Publishing causes commits, branches, and pull/merge requests to be written to your code host. +- **[Publishing](/batch-changes/publishing-changesets)** a changeset results in the creation of a merge request on your code host (e.g. a Pull Request on GitHub). +- **[Pushing](/batch-changes/push-only-changesets)** a changeset (available on GitHub and GitLab only) results in pushing your code changes to a new branch on your code host without also creating a merge request. You are able to see any CI feedback set to trigger upon code-pushes in the Batch Changs UI. ### Configure code host credentials diff --git a/docs/code-search/types/deep-search.mdx b/docs/code-search/types/deep-search.mdx index 30cf569c7..27284461a 100644 --- a/docs/code-search/types/deep-search.mdx +++ b/docs/code-search/types/deep-search.mdx @@ -1,44 +1,75 @@ # Deep Search -

Learn more about Sourcegraph's agentic Code Search tool Deep Search.

+

Learn more about Sourcegraph's agentic Code Search tool Deep Search.

- New in version 6.4. Deep Search is currently in research preview for Enterprise customers with access to Cody and Code Search. Because Deep Search is in research preview, it might change significantly in the future as we make improvements and adjust to user feedback. Please reach out to your Sourcegraph account team to request access. + New in version 6.5. Deep Search is currently in research preview for Enterprise and Enterprise Starter customers. Because Deep Search is in research preview, it might change significantly as we improve and adjust to user feedback. Please reach out to your Sourcegraph account team to request access. -Deep Search is an agentic code search tool. It receives a natural language question about a codebase, performs an in-depth search, and returns a detailed answer. The user can also ask follow-up questions to improve the answer further. +Deep Search is an agentic code search tool that understands natural language questions about your codebase. When a question is submitted, Deep Search performs an in-depth search and returns a detailed answer. The conversation can be continued with follow-up questions to dive deeper into relevant code. -Under the hood, Deep Search is an AI agent that uses various tools to generate its answer. These tools include multiple modes of Sourcegraph's Code Search and Code Navigation tools. Using tools in an agentic loop enables Deep Search to iteratively refine its understanding of the question and codebase, searching until it is confident in its answer. +Under the hood, Deep Search is an AI agent that uses various tools to generate its answer. The tools are functionalities available in Sourcegraph. They include multiple modes of Sourcegraph's Code Search and Code Navigation features. All processing happens within your Sourcegraph instance. Only external calls are made to the configured LLM. -Deep Search displays a list of sources used to generate the answer. The sources are the various types of searches it performs and the files it reads. The answer is formatted in markdown. If prompted to do so, Deep Search can also generate diagrams as part of its answer. +The core of Deep Search is an agentic loop. The AI agent can intelligently use tools to explore the codebase. In each loop iteration, the agent gradually refines its understanding of the question and codebase, searching until it is confident in its answer. + +Every Deep Search response includes a detailed list of sources contributing to the answer. These sources show exactly which searches were performed and which files were read. The list of sources is extremely useful for understanding where the answer came from and for further explorations of the codebase. + +The answer is formatted in Markdown and can include links to relevant files, directories, or repositories. If prompted to do so, Deep Search can also generate diagrams as part of its answer. ## Best practices -- Give the agent a starting point for the search: Mention relevant repositories, files, directories, or symbol names. The more specific you are, the faster the search will be. +- Give the agent a starting point for the search: use @-mentions to mention relevant repositories, files, directories, or symbol names. The more specific you are, the faster the search will be. - Provide reasonably scoped questions. The agent will perform much better if it does not have to read the entire codebase at once. -- Check the list of sources. This is extremely useful for debugging and understanding where the answer came from. If something is missing, ask a follow-up question and mention the missing source. +- Check the list of sources. This is extremely useful for debugging and understanding where the answer came from. Ask a follow-up question and mention the missing source if something is missing. + +For use cases where you're looking for exhaustive answers (for example, "Find all files with the `.XYZ` file extension in `foo' repo that contain the word`bar`), Code Search still excels, while Deep Search will only utilize a sample of the results. Deep Search will perform a Code Search query as a source, which you can use to continue an exhaustive search within the Code Search product. ### Examples of prompts - Find examples of logger usage and show examples of the different types of logging we use. -- I want to know when the indexing queue functionality was last changed in `sourcegraph/zoekt`. Show me the last few commit diffs touching this code and explain the changes. -- Look at the GraphQL APIs available in `sourcegraph/sourcegraph`. Are any of them unused? The client code is in `sourcegraph/cody`. +- I want to know when the indexing queue functionality was last changed in `@zoekt`. Show me the last few commit diffs touching this code and explain the changes. +- Look at the GraphQL APIs available in `@sourcegraph/sourcegraph`. Are any of them unused? The client code is in the `@cody` repository. - Which tools do we use in our build processes defined in `BUILD.bazel` files? - Generate a request flow diagram for `src/backend`. Mark the auth and rate limit points. +## Conversation sharing + +Conversation sharing is disabled by default - see below for instructions on enabling it. + +You can share Deep Search conversations with other users in your Sourcegraph instance. To share a conversation, click the "Share" button in the top left, then copy the link. Once you share a conversation, any user on your instance can view it with the link. You can also reset the share link and generate a new one, invalidating the previous link. + +We do not enforce [repository permissions](/admin/permissions) for viewing shared Deep Search conversations. This means that a user can view a conversation shared with them, regardless of which repositories they can access. We plan to revisit this in the future. + ## Enabling Deep Search -Deep Search can only be used on Sourcegraph instances with Code Search and Cody licenses. +If Deep Search is disabled, ask your site administrator to enable the following setting in your site configuration: +```json +"experimentalFeatures": { + "deepSearch.enabled": true, +}, +``` + +For optimal performance, Deep Search is specialized only to use one model. Currently, Deep Search only supports Claude Sonnet 4. + +If you are not using [Cody Gateway](/cody/core-concepts/cody-gateway), you must also configure the model through Amazon Bedrock or GCP Vertex. + +### Enabling conversation sharing -Deep Search is disabled by default. To enable it, ask your site administrator to set `experimentalFeatures.deepSearch.enabled = "true"` in your site configuration. +Conversation sharing is disabled by default. To enable conversation sharing, ask your site administrator to enable the following setting in your site configuration: -For optimal performance, Deep Search is specialized to only use one model. Currently, Deep Search only supports Claude Sonnet 4. +```json +"experimentalFeatures": { + "deepSearch.enabled": true, + "deepSearch.sharing.enabled ": true, +}, +``` ### Configuring Deep Search on Amazon Bedrock or GCP Vertex -Include configuration for Claude Sonnet 4 in [modelOverrides](/cody/enterprise/model-configuration#model-overrides) in your site configuration. For more information on configuring models, refer to [Model Configuration](/cody/enterprise/model-configuration). +In your site configuration, include the configuration for Claude Sonnet 4 in [modelOverrides](/cody/enterprise/model-configuration#model-overrides). For more information on configuring models, refer to [Model Configuration](/cody/enterprise/model-configuration). -Examples for Sonnet 4 configuration inside `modelOverrides`: +Examples of Sonnet 4 configuration inside `modelOverrides`: Amazon Bedrock: + ```json { "modelRef": "aws-bedrock::v1::claude-sonnet-4", @@ -58,6 +89,7 @@ Amazon Bedrock: ``` GCP Vertex: + ```json { "modelRef": "google-anthropic::v2::claude-sonnet-4", @@ -79,6 +111,7 @@ GCP Vertex: Then, configure Deep Search to use this model in `experimentalFeatures`: Amazon Bedrock: + ```json "experimentalFeatures": { "deepSearch.enabled": true, @@ -87,6 +120,7 @@ Amazon Bedrock: ``` GCP Vertex: + ```json "experimentalFeatures": { "deepSearch.enabled": true, diff --git a/docs/code_insights/types/inventory-stats.mdx b/docs/code_insights/types/inventory-stats.mdx new file mode 100644 index 000000000..80224d4e7 --- /dev/null +++ b/docs/code_insights/types/inventory-stats.mdx @@ -0,0 +1,64 @@ +# Inventory Stats + +

Learn about your project's inventory stats type of Code Insights.

+ +An inventory stats code insight lets you track code inventory metrics such as file counts, lines of code, and language usage trends in your repositories. Sourcegraph Code Search Enterprise users can track these metrics across all repositories in their organization. + +To create an inventory stats code insight: + +- Navigate to the Code Insights tab from the Sourcegraph instance +- Click on the **Create insight** button +- Select **Inventory Stats** as the type of insight +- Choose your list of target repositories on which you want to perform an insight +- Next, pick the inventory metrics you want to track, like lines of code, file size, and file count +- Finally, add a **title** and **granularity** of the insight +- And click **Create code insight** once you are done + +While configuring these fields, you can also see a live preview of the insight on the right side of the page. + +After you have created the insight, you can view it on the **Code Insights** tab. + +![inventory-stats](https://storage.googleapis.com/sourcegraph-assets/Docs/inventory-stats-insights-0625.png) + +Now, you can perform all the actions you can on other Code Insights, such as editing, filtering, sharing, and deleting. + +## Inventory environment variables + +Inventory environment variables have been moved into site configuration. This impacts any self-hosted customer using these environment variables. Cloud customers are not impacted by this change. + +If you are a self-hosted Sourcegraph Enterprise user, we have moved the inventory environment variables into the **inventory** section of the **Site configuration** settings in your **Site admin** page. + +Here's a list oI the Inventory environment variables and their new site configuration settings, with default values: + +- `USE_ENHANCED_LANGUAGE_DETECTION` ==> `"disableEnhancedLanguageDetection"` + - defaults to `false` +- `GET_INVENTORY_GIT_SERVER_CONCURRENCY` ==> `"gitServerConcurrency"` + - defaults to `4` +- `GET_INVENTORY_REDIS_CONCURRENCY` ==> `"redisConcurrency"` + - defaults to `20` +- `GET_INVENTORY_MAX_INV_IN_MEMORY` ==> `"maxInventoryInMemory"` + - defaults to `1000` +- `GET_INVENTORY_TIMEOUT` ==> `"timeoutInMinutes"` + - defaults to `5` + +Here's an example of the site configuration section: + +```json +"inventory" : { + "disableEnhancedLanguageDetection": false, + "gitServerConcurrency": 4, + "redisConcurrency": 20, + "maxInventoryInMemory": 1000, + "timeoutInMinutes": 5 +} +``` + +To accommodate default values in your Site configuration vs. environment variables, the positive `USE_ENHANCED_LANGUAGE_DETECTION` env var has been changed to the negative `disableEnhancedLanguageDetection`. + +There is a new environment variable for managing `worker` resources when processing Inventory insights: + +```json +INSIGHTS_INVENTORY_BATCH_SIZE +``` + +This environment variable controls the number of repositories to process in a single batch for inventory insights in the code insights worker. It affects memory usage while processing repos. Lower number is less memory used. It does not affect the speed of the process. diff --git a/docs/cody/capabilities/chat.mdx b/docs/cody/capabilities/chat.mdx index e3be0ca47..8f418d58e 100644 --- a/docs/cody/capabilities/chat.mdx +++ b/docs/cody/capabilities/chat.mdx @@ -2,8 +2,6 @@

Chat with the AI assistant in your code editor or via the Sourcegraph web app to get intelligent suggestions, code autocompletions, and contextually aware answers.

- - You can **chat** with Cody to ask questions about your code, generate code, and edit code. By default, Cody has the context of your open file and entire repository, and you can use `@` to add context for specific files, symbols, remote repositories, or other non-code artifacts. You can do it from the **chat** panel of the supported editor extensions ([VS Code](/cody/clients/install-vscode), [JetBrains](/cody/clients/install-jetbrains), [Visual Studio](/cody/clients/install-visual-studio)) or in the [web](/cody/clients/cody-with-sourcegraph) app. @@ -103,71 +101,3 @@ If Cody's answer isn't helpful, you can try asking again with a different contex - **Public knowledge only**: Cody will not use your own code files as context; it’ll only use knowledge trained into the base model. - **Current file only**: Re-run the prompt again using the current file as context. - **Add context**: Provides @-mention context options to improve the response by explicitly including files, symbols, remote repositories, or even web pages (by URL). - - - -The enhanced chat experience input can be accessed from the chat panel of the supported editor extensions (VS Code and JetBrains) and the web app. It combines light code search, AI-powered chat, and agentic capabilities into a unified developer interface. It's designed to accelerate the entire developer workflow by providing a more intuitive and powerful way to interact with code. - -## Prerequisites - -To use Cody's chat, you'll need the following: - -- [Sourcegraph Enterprise Starter](https://sourcegraph.com/pricing) or [Enterprise account](https://sourcegraph.com/pricing) -- A supported editor extension [VS Code](https://marketplace.visualstudio.com/items?itemName=sourcegraph.cody-ai), [JetBrains](https://plugins.jetbrains.com/plugin/9682-cody-ai-coding-assistant-with-autocomplete--chat) installed or use via Web app - -## Key features - -The enhanced chat experience includes everything in the Free plan, plus the following: - -## Smart search integration - -The smart search integration enhances Sourcegraph's chat experience by providing lightweight code search capabilities directly within the chat interface. This feature simplifies developer workflows by offering quick access to code search without leaving the chat environment. - -The integration delivers personalized search results ranked by your contribution history, with frequently accessed repositories appearing higher in results. Users can view code snippets with relevant context and open files directly in their editor. - -Search results automatically become available as context for follow-up queries, with flexible controls for selecting which results to include. While optimized for keyword-style queries and searching across a few repositories, this integration complements rather than replaces the full [Code Search](/code-search) product, which remains the recommended tool for comprehensive enterprise-wide code search. - -## Context-aware responses - -Search results generated through smart search integration can be automatically used as context for follow-up queries. Here's what happens with each scenario: - -### Search responses - -* Search results can be used directly as context for follow-up queries -* Users can select which search results to include as context using checkboxes -* By default, all search results are added as context -* A context chip shows the number of search results being used (e.g., "10 code search results") -* Users can remove the context chip if they don't want to use it for follow-ups - -### Chat responses - -Executing terminal commands for additional context is an experimental feature. - -* Performs background searches for context -* Retrieves full context from files, symbols, remote repos, and web pages -* Can execute terminal commands (with permission) for additional context -* Creates personal notes usable across chat sessions -* Pulls in [OpenCtx](/cody/capabilities/openctx) providers for additional context - -## How does chat work? - -The following is a general walkthrough of the chat experience: - -1. The user enters a query in the chat interface -2. By default a user gets a chat response for the query -3. To get integrated search results, toggle to **Run as search** from the drop-down selector or alternatively use `Cmd+Opt+Enter` (macOS) -4. For search: - - Displays ranked results with code snippets - - Shows personalized repository ordering - - Provides checkboxes to select context for follow-ups -5. For chat: - - Delivers AI-powered responses - - Can incorporate previous search results as context -6. Users can: - - Switch between search and chat modes - - Click on results to open files in their editor - - Ask follow-up questions using selected context - - Use `@` to add context for specific files, symbols, remote repositories, or other non-code artifacts - - - diff --git a/docs/cody/capabilities/query-types.mdx b/docs/cody/capabilities/query-types.mdx deleted file mode 100644 index c6d1de2e0..000000000 --- a/docs/cody/capabilities/query-types.mdx +++ /dev/null @@ -1,94 +0,0 @@ -# Chat Query Types - -

This page lists all the query types that will return search results with the Sourcegraph chat.

- -Query types are only supported on Enterprise Starter and Enterprise plans. - -## Symbol Search - -Symbol Search is a query type or workflow that helps developers understand how specific symbols (like functions, variables, or hooks) are used across a codebase by combining search results with contextual analysis through chat. - -It enables developers to explore and understand symbol usage patterns through a two-step process. First, developers search for a specific symbol (like `useCallback`) using Sourcegraph Chat, which returns relevant code snippets from across the codebase. - -These search results are automatically preserved as context for follow-up chat interactions. Developers can refine their understanding by selecting specific search results and asking natural language questions about the symbol's usage patterns. The chat will analyze the selected code context and provide a comprehensive summary of how the symbol is implemented and used throughout the codebase. - -### Try it - -1. Query for `= useCallback` -2. Select a subset of the search results which include usage for `useCallback` -3. Follow up and ask Sourcegraph chat `Summarize how useCallback is used` - -### Example - - - -## File Search - -Search is a query type or workflow that enables users to locate specific files across repositories and perform targeted analysis on the selected files through natural language follow-up queries. - -File Search simplifies finding and analyzing specific file types across your codebase. Unlike traditional code search, this workflow allows you to identify relevant files (for example, all `package.json` files), select the specific files you want to analyze, and then ask follow-up questions about the selected files. - -This two-step approach is particularly powerful when analyzing patterns or extracting information from similar files spread across multiple repositories. For instance, you could identify all configuration files, select the ones from relevant services, and then analyze their contents for inconsistencies or gather specific information through natural language queries. - -### Try it - -1. Type `package.json` -2. Check the checkbox next to the results you want to analyze -3. Follow up with `List all the dependencies used across these package.json files` - -### Example - - - -## String Literal Search - -String literal search is a query type or workflow that allows you to find exact text matches by enclosing your search term in quotes. This ensures precise matching instead of keyword-based results. - -When you enclose the text in quotes like `" authInfo: async provider =>"",` Sourcegraph performs an exact match search rather than keyword matching. After finding relevant files, you can select specific ones to analyze and ask follow-up questions about their contents - creating an interactive workflow combining precise search and contextual code analysis. - -### Try it - -1. Start a new chat with `"authInfo: async provider =>"` -2. Select a subset of the search results which include usage for the string -3. Follow up with `Summarize the contents` - -### Example - - - -## Error Lookups - -Error Lookups is a conversational workflow for Sourcegraph chat that helps developers understand error messages by providing plain-English explanations of when and why specific errors occur in their codebase and external service calls. - -Developers can use Error Lookups to understand error messages occurring in their codebase. When encountering an error, especially from external services or dependencies, developers can use chat to: - -1. Search for specific error messages across their codebase -2. Select relevant files where the error is thrown or handled -3. Request a natural language explanation of the error's context, triggers, and implications - -The workflow combines Sourcegraph's code search capabilities with AI-powered analysis to provide developers with a clear, contextual understanding of error scenarios. Instead of having to dig through docs or source code manually, developers can quickly grasp the following: - -* The specific conditions that trigger the error -* The underlying reasons for the error occurrence -* Common scenarios where this error might appear -* Potential approaches to handling or preventing the error - -This approach helps developers make more informed decisions about error handling and debugging, reducing the time spent deciphering cryptic error messages or searching through external docs. - -### Try it - -* Query for `"unsupported platform"` -* Select the file(s) where the error is thrown -* Follow up with "Explain when and why this error is thrown" - -### Demo - - diff --git a/docs/cody/enterprise/features.mdx b/docs/cody/enterprise/features.mdx index 5d4d821f5..3266bdf97 100644 --- a/docs/cody/enterprise/features.mdx +++ b/docs/cody/enterprise/features.mdx @@ -10,7 +10,7 @@ Site administrators can set the duration of access tokens for users connecting C ## Guardrails -Guardrails for public code is currently in Beta and is supported with VS Code, JetBrains IDEs extensions and Sourcegraph Web app. +Guardrails for public code is only supported on VS Code, JetBrains IDEs extension, and Sourcegraph Web app for Cody Enterprise customers using [Cody Gateway](https://sourcegraph.com/docs/cody/core-concepts/cody-gateway#sourcegraph-cody-gateway). It is not supported for any BYOK (Bring Your Own Key) deployments. Open source attribution guardrails for public code, commonly called copyright guardrails, reduce the exposure to copyrighted code. This involves implementing a verification mechanism within Cody to ensure that any code generated by the platform does not replicate open source code. @@ -22,6 +22,12 @@ Guardrails don't differentiate between license types. It matches any code snippe You can `enforce` a Guardrails check to prevent any matching code from being shown to the user. To do so, site admins need to add `"attribution.mode": "enforced"` in the **Site configuration** setting. This will configure the settings for Cody IDE extensions VS Code (v1.82+) or JetBrains (v7.82+) accordingly and will enforce not to display code until attribution checks have finished. +### Known Limitations +1. Guardrails work through an exact string match across ten or more lines, which means extra comments or name changes may not trigger the check +2. The strings are compared against around **290,000** indexed open source repositories, consisting of all license types, including permissive and non-permissive licenses +3. Guardrails requires access to the Cody Gateway, which means it's not supported for any customers using BYOK (Bring Your Own Key) +4. Guardrails is only supported on the Sourcegraph Web app, and the IDE extensions in VS Code, JetBrains IDEs, for chat and autocomplete + ## Admin controls Admin controls are supported with VS Code and JetBrains IDE extension. diff --git a/docs/legacy.mdx b/docs/legacy.mdx index c11f3e12c..45309afbe 100644 --- a/docs/legacy.mdx +++ b/docs/legacy.mdx @@ -4,6 +4,7 @@ + - [6.4](https://6.4.sourcegraph.com) - [6.3](https://6.3.sourcegraph.com) - [6.2](https://6.2.sourcegraph.com) - [6.1](https://6.1.sourcegraph.com) diff --git a/src/data/navigation.ts b/src/data/navigation.ts index f89e1c771..2195632dd 100644 --- a/src/data/navigation.ts +++ b/src/data/navigation.ts @@ -152,8 +152,10 @@ export const navigation: NavigationItem[] = [ title: "Bulk Operations", href: "/batch-changes/bulk-operations-on-changesets", subsections: [ { title: "Publishing Changesets", href: "/batch-changes/publishing-changesets", }, + { title: "Pushing Code", href: "/batch-changes/push-only-changesets", }, { title: "Tracking Changesets", href: "/batch-changes/tracking-existing-changesets", }, { title: "Rebasing Changesets", href: "/batch-changes/rebasing-changesets", }, + ] }, { @@ -164,7 +166,7 @@ export const navigation: NavigationItem[] = [ }, { title: "Access Permissions", href: "/batch-changes/permissions-in-batch-changes" }, { - title: "Changesets in Monorepo", href: "/batch-changes/creating-changesets-per-project-in-monorepos", + title: "Changesets in Monorepos", href: "/batch-changes/creating-changesets-per-project-in-monorepos", subsections: [ { title: "Changesets in Large Repos", href: "/batch-changes/creating-multiple-changesets-in-large-repositories", }, ] @@ -187,7 +189,7 @@ export const navigation: NavigationItem[] = [ ] }, { - title: "Working with CLI", href: "/batch-changes/how-src-executes-a-batch-spec", + title: "Working with the CLI", href: "/batch-changes/how-src-executes-a-batch-spec", subsections: [ { title: "Re-executing Batch Specs", href: "/batch-changes/reexecuting-batch-specs-multiple-times", }, { title: "CLI Subcommands", href: "/cli/references/batch", }, diff --git a/src/data/redirects.ts b/src/data/redirects.ts index da231f77a..bae7dfbd4 100644 --- a/src/data/redirects.ts +++ b/src/data/redirects.ts @@ -6811,6 +6811,13 @@ const redirectsData = [ permanent: true }, + //Rmv Query types permanentaly:https://sourcegraph.com/docs/cody/capabilities/query-types + { + source: "/cody/capabilities/query-types", + destination: "/cody/capabilities/chat", + permanent: true + }, + ]; diff --git a/src/data/versions.ts b/src/data/versions.ts index 494b4db71..b4a3c980c 100644 --- a/src/data/versions.ts +++ b/src/data/versions.ts @@ -15,8 +15,8 @@ export const versions: VersionI[] = [ url: '/docs', }, { - name: 'v6.3', - url: 'https://6.3.sourcegraph.com/' + name: 'v6.4', + url: 'https://6.4.sourcegraph.com/' }, ];