Merge branch 'main' into sg-arch-docs

Author: MaedahBatool

README.md

@@ -18,7 +18,7 @@ Navigate to the project directory by typing the following command in your termin
 cd sourcegraph-docs
 ```
 
-Before the dependencies are install make sure your local machine has the following versions of `node` and `pnpm`:
+Before the dependencies are install make sure your local machine has the following versions of `node` and `pnpm` installed:
 
 * node: `v20.8.1`
 * pnpm: `8.13.1`
@@ -148,11 +148,10 @@ As you make changes to the documentation, the development server will automatica
 
 ### Previewing Vercel Deployments
 
-When you open a PR Vercel deploys and provides you with a preview deployment link. To view your deployment, click the "Visit Preview" and then append `/docs` at the end of the URL. The original link gives you a `404`.
+When you open a PR Vercel deploys and provides you with a preview deployment link. To view your deployment, click the **Visit Preview** link from Vercel's deployment panel in your PRs and you get a preview of your docs
 
 ![CleanShot 2024-11-05 at 10 11 29@2x](https://github.com/user-attachments/assets/b0911e2e-95a7-4f56-b2ff-b659d13077d8)
 
-
 ## Submitting your Contribution
 
 Once you're satisfied with your changes, follow these steps:

baseai/memory/docs/index.ts renamed to baseai/memory/memory-sg-docs-live/index.ts

@@ -1,14 +1,14 @@
 import { MemoryI } from '@baseai/core';
 
 const memoryDocs = (): MemoryI => ({
-	name: 'docs',
-	description: 'Docs folder of sourcegraph docs repository as an auto-synced memory',
+	name: 'memory-sg-docs-live',
+	description: 'An AI memory storing all Sourcegraph docs.',
 	git: {
 		enabled: true,
 		include: ['**/*.mdx'],
 		gitignore: true,
-		deployedAt: '5f3fec8530280d01a783aadcdeb0ccc3f9cd8b70',
-		embeddedAt: ''
+		embeddedAt: '',
+		deployedAt: 'ab6065ecc6c667a5b8c0ded35498a17659d34333'
 	},
 	documents: {
 		meta: doc => {
@@ -22,3 +22,6 @@ const memoryDocs = (): MemoryI => ({
 });
 
 export default memoryDocs;
+
+// Old
+// deployedAt: '5f3fec8530280d01a783aadcdeb0ccc3f9cd8b70',

docs/admin/deploy/index.mdx

@@ -14,7 +14,7 @@ Sourcegraph is a powerful code intelligence platform that can be deployed in var
 Carefully consider your organization's needs and technical expertise when selecting a Sourcegraph deployment method. Each option has different capabilities, resource requirements, and levels of technical expertise needed. Changing deployment methods in the future requires a complete redeployment and database migration.
 
 Sourcegraph's recommended deployment methods are, in order:
-1. [Sourcegraph Cloud](#sourcegraph-cloud) - This provides a fully managed solution where Sourcegraph handles all of the maintence, monitoring, and upgrading tasks to give you an optimal Sourcegraph experience while immediately getting the latest features into your users' hands. This solution does require your code hosts to be connected to the Sourcegraph managed environment.
+1. [Sourcegraph Cloud](#sourcegraph-cloud) - This provides a fully managed solution where Sourcegraph handles all of the maintenance, monitoring, and upgrading tasks to give you an optimal Sourcegraph experience while immediately getting the latest features into your users' hands. This solution does require your code hosts to be connected to the Sourcegraph managed environment.
 2. [Kubernetes Helm](#kubernetes) - Sourcegraph's Kubernetes deployment provides the most robust, scalable, and vetted self-hosted solution. This solution is ideal across many self-hosted customers capable of deploying a multi-node instance, and can be supported by all mainstream managed Kubernetes platforms.
 3. [Docker Compose](#docker-compose) - Docker Compose provides the preferred single-node deployment solution for Sourcegraph. It can be a good option when the complexities and flexibility provided by Kubernetes Helm are not needed.
 4. [Kubernetes Kustomize](#kubernetes) - Helm is Sourcegraph's more standardized and vetted approach to deploying with Kubernetes, but if Kustomize is your preferred deployment method it is a viable and supported approach.
@@ -56,7 +56,7 @@ Single-node, self hosted solution for enterprises looking for a simpler, non-Kub
 
 Best for enterprises looking for a self-hosted solution on the Cloud provider of their choice.
 
-Machine images provide a preconfigured Sourcegraph instance that can be deployed in minutes with minimal effort. While they offer simplicity, they are designed as a standardized solution and do not support customization. Currently available on the following hosts:
+Machine images provide a pre-configured Sourcegraph instance that can be deployed in minutes with minimal effort. While they offer simplicity, they are designed as a standardized solution and do not support customization. Currently available on the following hosts:
 
 <QuickLinks>
   <QuickLink title="Amazon Machine Image (AMI)" icon='lightbulb' href="/admin/deploy/machine-images/aws-ami" />

docs/admin/permissions/api.mdx

@@ -99,6 +99,8 @@ You can call `setRepositoryPermissionsForUsers` repeatedly to set permissions fo
 
 ## Setting sub-repository permissions for users
 
+> NOTE: If a user has no sub-repo permissions set for a specific repository (assuming that they have general access to the repository), they will have access to the entire repository contents.
+
 Sourcegraph supports permissions on a per-file/directory basis. 
 
 To enable the sub-repo permissions API, add the following to the [site configuration](/admin/config/site_config):

docs/admin/subscriptions/index.mdx

@@ -31,3 +31,4 @@ Sourcegraph administrators can view the lines of code count for each repository
 ## Updating your license key
 
 - Navigate to **Site admin > Configuration > Site configuration**, update the `licenseKey` field with the new value, and then click **Save changes**.
+- Note: once you apply the license it may take 10-15 minutes for the change to take effect. You can always restart the front-end service to apply the change faster, if needed.

docs/analytics/self-hosted.mdx renamed to docs/analytics/air-gapped.mdx

@@ -1,8 +1,8 @@
-# Sourcegraph Self-Hosted Analytics
+# Sourcegraph Air-gapped Analytics
 
 <Callout type="note">This feature is not yet available. Coming soon.</Callout>
 
-Sourcegraph Self-Hosted Analytics is coming soon! Self-hosted customers can view usage metrics in a locally deployed analytics service built on Grafana.
+Sourcegraph Air-gapped Analytics is coming soon! Air-gapped customers can view usage metrics in a locally deployed analytics service built on Grafana.
 
 This product is in development now. If you would like to learn more, please contact your Sourcegraph representative.
 

docs/analytics/cloud.mdx

@@ -1,6 +1,6 @@
 # Sourcegraph Cloud Analytics
 
-The following instructions are for all Sourcegraph Cloud and self-hosted customers who have upgraded to a sufficient version of Sourcegraph (5.9+) and fully enabled usage telemetry. Customers that self-host can also view our [self-hosted analytics enablement](/self-hosted).
+The following instructions are for all Sourcegraph Cloud and self-hosted customers who have upgraded to a sufficient version of Sourcegraph (5.9+) and fully enabled usage telemetry. 
 
 ![Sourcegraph-cloud-analytics](https://storage.googleapis.com/sourcegraph-assets/cloud-analytics.png)
 

docs/cody/capabilities/auto-edit.mdx

@@ -2,7 +2,7 @@
 
 <p className="subtitle">Auto-edit suggests code changes by analyzing cursor movements and typing. After you've made at least one character edit in your codebase, it begins proposing contextual modifications based on your cursor position and recent changes.</p>
 
-<Callout type="info">Auto-edit is currently supported in the VS Code extension with Sourcegraph v6.0+. It's available in Beta for Pro, Enterprise Starter and Enterprise users on Cody Gateway. Auto-edit requires Fireworks to be enabled as a provider. Enterprise customers without Fireworks enabled can [disable the feature flag](#auto-edit-access-for-enterprise-customers)</Callout>
+<Callout type="info">Auto-edit is currently supported with Sourcegraph v6.0+ for Pro, Enterprise Starter, and Enterprise accounts on Cody Gateway. Auto-edit requires Fireworks to be enabled as a provider. Enterprise customers without Fireworks enabled can disable the feature flag.</Callout>
 
 ## Capabilities of auto-edit
 
@@ -12,9 +12,45 @@
 - Can propose similar changes across multiple locations based on recent edits
 - Can handle complex refactoring operations like adding parameters and unpacking functions
 
-## Enabling auto-edit
+## How does auto-edit work?
+
+The system detects potential changes based on the following:
+
+- Cursor placement in the code
+- Recent changes made in similar contexts
+- Function usage patterns
+- Common refactoring patterns
+
+## Auto-edit vs. Autocomplete
+
+In terms of feature set and functionality, auto-edit and autocomplete have some key differences:
+
+|      **Feature**       |            **Autocomplete**            |                   **Auto-edit**                    |
+| ---------------------- | -------------------------------------- | -------------------------------------------------- |
+| **Text modification**  | Can only insert text, not delete       | Can both insert and delete text                    |
+| **Cursor position**    | Only proposes content after the cursor | Can modify code before and after the cursor        |
+| **Suggestion trigger** | Suggests on every character typed      | Proposes changes based on context and recent edits |
+
+## Use cases
+
+The auto-edit feature can help you with various repetitive tasks in your code:
 
-Auto-edit is enabled by default for Cody Pro Enterprise Starter, and Enterprise users. You can opt out and switch back to **autocomplete** by selecting it from the suggestion mode in the Cody VS Code extension settings.
+- **Function signature refactoring**: Automatically suggests adding error returns, new parameters, or changing return types across function definitions. For example, when you modify a function to return both a value and an error, auto-edit helps update the function signature.
+- **Call site updates**: When you change a function's signature, auto-edit detects all locations where the function is called and suggests necessary modifications to match the new signature. This includes updating parameter orders, adding error handling, and adjusting return value usage.
+- **Test file maintenance**: Helps with repetitive updates in test files, such as modifying test assertions, updating mock objects, or changing test data structures. Auto-edit recognizes patterns from your recent changes and suggests similar modifications across related tests.
+- **Parameter refactoring**: Assists in adding, removing, or reorganizing function parameters. When you unpack a function to handle more cases, auto-edit helps restructure the parameter list and suggests corresponding changes at call sites.
+- **Type system modifications**: Auto-edit identifies and suggests consistent changes across your codebase when updating type definitions or interfaces. This includes updating variable declarations, function parameters, and return types to maintain type consistency.
+
+Auto-edit is supported by both Cody VS Code and JetBrains plugins.
+
+<Tabs>
+<Tab title="VS Code">
+
+<Callout type="info">Auto-edit for VS Code is currently in Beta. It's available for Pro, Enterprise Starter, and Enterprise users on Cody Gateway. Auto-edit requires Fireworks to be enabled as a provider. Enterprise customers without Fireworks enabled can disable the feature flag.</Callout>
+
+## Enabling auto-edit in VS Code
+
+Auto-edit is enabled by default for Cody Pro Enterprise Starter and Enterprise users. You can opt out and switch back to autocomplete by selecting it from the suggestion mode in the Cody VS Code extension settings.
 
 Site admins can opt their organization out of the auto-edit feature by disabling it from their config settings.
 
@@ -53,31 +89,56 @@ The following example demonstrates how to add Fireworks as an allowed LLM provid
 }
 ```
 
-## How does auto-edit work?
+</Tab>
 
-The system detects potential changes based on the following:
+<Tab title="JetBrains">
 
-- Cursor placement in the code
-- Recent changes made in similar contexts
-- Function usage patterns
-- Common refactoring patterns
+<Callout type="info">Auto-edit for JetBrains IDEs is Experimental and supports JetBrains versions 7.84.0+. It's available for Pro, Enterprise Starter, and Enterprise users on Cody Gateway. Auto-edit requires Fireworks to be enabled as a provider. Enterprise customers without Fireworks enabled can disable the feature flag.</Callout>
 
-## Auto-edit vs. Autocomplete
+## Enabling auto-edit in JetBrains
 
-In terms of feature-set and functionality, auto-edit and autocomplete have some key differences:
+You can opt-in the auto-edit feature from the JetBrains Cody plugin settings.
 
-|      **Feature**       |            **Autocomplete**            |                   **Auto-edit**                    |
-| ---------------------- | -------------------------------------- | -------------------------------------------------- |
-| **Text modification**  | Can only insert text, not delete       | Can both insert and delete text                    |
-| **Cursor position**    | Only proposes content after the cursor | Can modify code before and after the cursor        |
-| **Suggestion trigger** | Suggests on every character typed      | Proposes changes based on context and recent edits |
+- Click the three-dot menu on the top right of the Cody plugin window and select **Open Cody Settings Editor**
+- This will open the `cody_settings.json` file in your editor
+- Here, add `"cody.suggestions.mode": "auto-edit"` setting to enable the auto-edit feature
 
-## Use cases
+![JetBrains-Cody-Settings-Editor](https://storage.googleapis.com/sourcegraph-assets/Docs/jb-cody-settings.png)
 
-The auto-edit feature can help you with various repetitive tasks in your code:
+### Auto-edit access for Enterprise customers
 
-- **Function signature refactoring**: Automatically suggests adding error returns, new parameters, or changing return types across function definitions. For example, when you modify a function to return both a value and an error, auto-edit helps update the function signature.
-- **Call site updates**: When you change a function's signature, auto-edit detects all locations where the function is called and suggests necessary modifications to match the new signature. This includes updating parameter orders, adding error handling, and adjusting return value usage.
-- **Test file maintenance**: Helps with repetitive updates in test files, such as modifying test assertions, updating mock objects, or changing test data structures. Auto-edit recognizes patterns from your recent changes and suggests similar modifications across related tests.
-- **Parameter refactoring**: Assists in adding, removing, or reorganizing function parameters. When you unpack a function to handle more cases, auto-edit helps restructure the parameter list and suggests corresponding changes at call sites.
-- **Type system modifications**: Auto-edit identifies and suggests consistent changes across your codebase when updating type definitions or interfaces. This includes updating variable declarations, function parameters, and return types to maintain type consistency.
+Auto-edit is available for Enterprise customers with [Sourcegraph Cody Gateway](/cody/core-concepts/cody-gateway#sourcegraph-cody-gateway) access. Enabling the feature requires two steps:
+
+1. Site administrators must:
+   - Ensure the feature flag `cody-autoedit-experiment-enabled-flag` is enabled from the settings editor
+   - Add `fireworks::*` as an [allowed provider](https://sourcegraph.com/docs/cody/enterprise/model-configuration#model-filters) (see below)
+2. Once enabled, auto-edit will become the default suggestion mode for all users
+3. Users can optionally switch back to autocomplete from the Cody extension settings
+4. Site admins can opt out of auto-edits using the `cody-autoedit-experiment-enabled-flag` feature flag
+
+The following example demonstrates how to add Fireworks as an allowed LLM provider:
+
+```json
+
+"cody.enabled": true,
+"modelConfiguration": {
+  "sourcegraph": {
+    "modelFilters": {
+      // Only allow "beta" and "stable" models.
+      // Not "experimental" or "deprecated".
+      "statusFilter": ["beta", "stable"],
+
+      // Allow any models provided by Anthropic, OpenAI, Google and Fireworks.
+      "allow": [
+        "anthropic::*", // Anthropic models
+        "openai::*", // OpenAI models
+        "google::*", // Google Gemini models
+        "fireworks::*", // Open source models hosted by Sourcegraph
+      ],
+    }
+  }
+}
+```
+
+</Tab>
+</Tabs>

docs/cody/capabilities/supported-models.mdx

@@ -23,15 +23,15 @@ Cody supports a variety of cutting-edge large language models for use in chat an
 
 <Callout type="note">To use Claude 3 Sonnet models with Cody Enterprise, make sure you've upgraded your Sourcegraph instance to the latest version. </Callout>
 
-### CLaude 3.7 Sonnet
+### Claude 3.7 Sonnet
 
 Claude 3.7 has two variants — Claude 3.7 Sonnet and Claude 3.7 Extended Thinking — to support deep reasoning and fast, responsive edit workflows. This means you can use Claude 3.7 in different contexts depending on whether long-form reasoning is required or for tasks where speed and performance are a priority.
 
-Claude 3.7 Extended Thinking version will be the recommended default chat model for Cloud customers. Self-hosted customers are encouraged to follow this recommendation, as Claude 3.7 outperforms 3.5 in most scenarios.
+Claude 3.7 Extended Thinking is the recommended default chat model for Cloud customers. Self-hosted customers are encouraged to follow this recommendation, as Claude 3.7 outperforms 3.5 in most scenarios.
 
 #### Claude 3.7 for GCP
 
-In addition, Sourcegraph Enterprise customers using GCP vertex (Google Cloud Platform) for Claude models can use both these variants of Claude 3.7 to optimize extended reasoning and deeper understanding. Customers using AWS Bedrock doesn't have Claude 3.7 Extended Thinking variant.
+In addition, Sourcegraph Enterprise customers using GCP Vertex (Google Cloud Platform) for Claude models can use both these variants of Claude 3.7 to optimize extended reasoning and deeper understanding. Customers using AWS Bedrock do not have the Claude 3.7 Extended Thinking variant.
 
 <Callout type="info">Claude 3.7 Sonnet with thinking is not supported for BYOK deployments.</Callout>