Fix docs links; add changelog; small nits with bottom panel when no ee key is present

Author: brendan-kellam

CHANGELOG.md

@@ -7,8 +7,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+Sourcebot V4 introduces authentication, performance improvements and code navigation. Checkout the [migration guide](https://docs.sourcebot.dev/self-hosting/upgrade/v3-to-v4-guide) for information on upgrading your instance to v4.
+
+### Changed
+- [**Breaking Change**] Authentication is now required by default. Notes:
+  - When setting up your instance, email / password login will be the default authentication provider.
+  - The first user that logs into the instance is given the `owner` role. ([docs](https://docs.sourcebot.dev/docs/more/roles-and-permissions)).
+  - Subsequent users can request to join the instance. The `owner` can approve / deny requests to join the instance via `Settings` > `Members` > `Pending Requests`.
+  - If a user is approved to join the instance, they are given the `member` role.
+  - Additional login providers, including email links and SSO, can be configured with additional environment variables. ([docs](https://docs.sourcebot.dev/self-hosting/configuration/authentication)).
+- Clicking on a search result now takes you to the `/browse` view. Files can still be previewed by clicking the "Preview" button or holding `Cmd` / `Ctrl` when clicking on a search result. [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
+
 ### Added
-- [Sourcebot EE] Added code navigation (find all references / go to definition). [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
+- [Sourcebot EE] Added search-based code navigation, allowing you to jump between symbol definition and references when viewing source files. [Read the documentation](https://docs.sourcebot.dev/docs/search/code-navigation). [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
+- Added collapsible filter panel. [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
 
 ### Fixed
 - Improved scroll performance for large numbers of search results. [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
@@ -99,8 +111,8 @@ Sourcebot v3 is here and brings a number of structural changes to the tool's fou
 ### Added
 - Added parallelized repo indexing and connection syncing via Redis & BullMQ. See the [architecture overview](https://docs.sourcebot.dev/self-hosting/overview#architecture).
 - Added repo indexing progress indicators in the navbar.
-- Added authentication support via OAuth or email/password. For instructions on enabling, see [this doc](https://docs.sourcebot.dev/self-hosting/more/authentication).
-- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/self-hosting/more/authentication)**:
+- Added authentication support via OAuth or email/password. For instructions on enabling, see [this doc](https://docs.sourcebot.dev/self-hosting/configuration/authentication).
+- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/self-hosting/configuration/authentication)**:
   - connection management: create and manage your JSON configs via a integrated web-editor.
   - secrets: import personal access tokens (PAT) into Sourcebot (AES-256 encrypted). Reference secrets in your connection config by name.
   - team & invite management: invite users to your instance to give them access. Configure team [roles & permissions](https://docs.sourcebot.dev/docs/more/roles-and-permissions).

docs/docs.json

@@ -50,8 +50,8 @@
                         "pages": [
                             "docs/search/syntax-reference",
                             "docs/search/multi-branch-indexing",
-                            "docs/search/search-contexts",
-                            "docs/search/code-navigation"
+                            "docs/search/code-navigation",
+                            "docs/search/search-contexts"
                         ]
                     },
                     {

docs/docs/connections/gitea.mdx

@@ -82,7 +82,7 @@ Next, provide the access token via the `token` property, either as an environmen
 
 <Tabs>
     <Tab title="Environment Variable">
-        <Note>Environment variables are only supported in a [declarative config](/self-hosting/more/declarative-config) and cannot be used in the web UI.</Note>
+        <Note>Environment variables are only supported in a [declarative config](/self-hosting/configuration/declarative-config) and cannot be used in the web UI.</Note>
 
         1. Add the `token` property to your connection config:
         ```json
@@ -107,7 +107,7 @@ Next, provide the access token via the `token` property, either as an environmen
     </Tab>
 
     <Tab title="Secret">
-        <Note>Secrets are only supported when [authentication](/self-hosting/more/authentication) is enabled.</Note>
+        <Note>Secrets are only supported when [authentication](/self-hosting/configuration/authentication) is enabled.</Note>
 
         1. Navigate to **Secrets** in settings and create a new secret with your PAT:
 

docs/docs/connections/github.mdx

@@ -111,7 +111,7 @@ Next, provide the PAT via the `token` property, either as an environment variabl
 
 <Tabs>
     <Tab title="Environment Variable">
-        <Note>Environment variables are only supported in a [declarative config](/self-hosting/more/declarative-config) and cannot be used in the web UI.</Note>
+        <Note>Environment variables are only supported in a [declarative config](/self-hosting/configuration/declarative-config) and cannot be used in the web UI.</Note>
 
         1. Add the `token` property to your connection config:
         ```json
@@ -136,7 +136,7 @@ Next, provide the PAT via the `token` property, either as an environment variabl
     </Tab>
 
     <Tab title="Secret">
-        <Note>Secrets are only supported when [authentication](/self-hosting/more/authentication) is enabled.</Note>
+        <Note>Secrets are only supported when [authentication](/self-hosting/configuration/authentication) is enabled.</Note>
 
         1. Navigate to **Secrets** in settings and create a new secret with your PAT:
 

docs/docs/connections/gitlab.mdx

@@ -116,7 +116,7 @@ Next, provide the PAT via the `token` property, either as an environment variabl
 
 <Tabs>
     <Tab title="Environment Variable">
-        <Note>Environment variables are only supported in a [declarative config](/self-hosting/more/declarative-config) and cannot be used in the web UI.</Note>
+        <Note>Environment variables are only supported in a [declarative config](/self-hosting/configuration/declarative-config) and cannot be used in the web UI.</Note>
 
         1. Add the `token` property to your connection config:
         ```json
@@ -141,7 +141,7 @@ Next, provide the PAT via the `token` property, either as an environment variabl
     </Tab>
 
     <Tab title="Secret">
-        <Note>Secrets are only supported when [authentication](/self-hosting/more/authentication) is enabled.</Note>
+        <Note>Secrets are only supported when [authentication](/self-hosting/configuration/authentication) is enabled.</Note>
 
         1. Navigate to **Secrets** in settings and create a new secret with your PAT:
 

docs/docs/connections/overview.mdx

@@ -11,11 +11,11 @@ There are two ways to define connections:
 
 <AccordionGroup>
     <Accordion title="Declarative configuration file">
-        This is only supported when self-hosting, and is the default mechanism to define connections. Connections are defined in a [JSON file](/self-hosting/more/declarative-config)
+        This is only supported when self-hosting, and is the default mechanism to define connections. Connections are defined in a [JSON file](/self-hosting/configuration/declarative-config)
         and the path to the file is provided through the `CONFIG_PATH` environment variable
     </Accordion>
     <Accordion title="UI connection management">
-        This is the only way to define connections when using Sourcebot Cloud, and can be configured when self-hosting by enabling [authentication](/self-hosting/more/authentications).
+        This is the only way to define connections when using Sourcebot Cloud, and can be configured when self-hosting by enabling [authentication](/self-hosting/configuration/authentications).
 
         In this method, connections are defined and managed within the webapp:
 

docs/docs/search/code-navigation.mdx

@@ -1,12 +1,12 @@
 ---
 title: Code navigation
-sidebarTitle: Code navigation (EE)
+sidebarTitle: Code navigation
 ---
 
 import SearchContextSchema from '/snippets/schemas/v3/searchContext.schema.mdx'
 
 <Note>
-This feature is only available with an active Enterprise license. Please add your [license key](/self-hosting/license-key) to activate it.
+This feature is only available in [Sourcebot cloud](app.sourcebot.dev) or with an active Enterprise license when [self-hosting](/self-hosting). Please add your [license key](/self-hosting/license-key) to activate it.
 </Note>
 
 **Code navigation** allows you to jump between symbol definition and references when viewing source files in Sourcebot. This feature is enabled **automatically** when a valid license key is present and works with all popular programming languages.

docs/docs/search/search-contexts.mdx

@@ -1,6 +1,6 @@
 ---
 title: Search contexts
-sidebarTitle: Search contexts (EE)
+sidebarTitle: Search contexts
 ---
 
 import SearchContextSchema from '/snippets/schemas/v3/searchContext.schema.mdx'
@@ -16,7 +16,7 @@ A **search context** is a user-defined grouping of repositories that helps focus
 - `( context:project1 or context:project2 ) logger\.debug` - search for debug log calls in project1 and project2 
 
 
-Search contexts are defined in the `context` object inside of a [declarative config](/self-hosting/more/declarative-config). Repositories can be included / excluded from a search context by specifying the repo's URL in either the `include` array or `exclude` array. Glob patterns are supported.
+Search contexts are defined in the `context` object inside of a [declarative config](/self-hosting/configuration/declarative-config). Repositories can be included / excluded from a search context by specifying the repo's URL in either the `include` array or `exclude` array. Glob patterns are supported.
 
 ## Example
 
@@ -41,7 +41,7 @@ shared/
 ├─ ...
 ```
 
-To make searching easier, we can create three search contexts in our [config.json](/self-hosting/more/declarative-config):
+To make searching easier, we can create three search contexts in our [config.json](/self-hosting/configuration/declarative-config):
 - `web`: For all frontend-related code
 - `backend`: For backend services and shared APIs
 - `pipelines`: For all CI/CD configurations

docs/self-hosting/configuration/tenancy.mdx

@@ -4,7 +4,7 @@ sidebarTitle: Multi tenancy
 ---
 
 <Warning>If you're switching from single-tenant mode, delete the Sourcebot cache (the `.sourcebot` folder) before starting.</Warning>
-<Warning>[Authentication](/self-hosting/more/authentication) must be enabled to enable multi tenancy mode</Warning>
+<Warning>[Authentication](/self-hosting/configuration/authentication) must be enabled to enable multi tenancy mode</Warning>
 Multi tenancy allows your Sourcebot deployment to have **multiple organizations**, each with their own set of members and repos. To enable multi tenancy mode, define an environment variable
 named `SOURCEBOT_TENANCY_MODE` and set its value to `multi`. When multi tenancy mode is enabled:
 

docs/self-hosting/upgrade/v3-to-v4-guide.mdx

@@ -8,7 +8,7 @@ This guide will walk you through upgrading your Sourcebot deployment from v3 to
 <Warning>
 Please note that the following features are no longer supported in v4:
 - Multi-tenancy mode
-- Unauthorized access to a Sourcebot deployment. Authentication is now required, and unauthorized access requires an unlimited seat [enterprise license](/self-hosting/license-key) 
+- Unauthenticated access to a Sourcebot deployment - authentication is now built in by default. Unauthenticated access to a organization can be enabled with an unlimited seat [enterprise license](/self-hosting/license-key) 
 </Warning>
 
 ### If your deployment doesn't have authentication enabled

docs/snippets/bitbucket-app-password.mdx

@@ -1,6 +1,6 @@
 <Tabs>
     <Tab title="Environment Variable">
-        <Note>Environment variables are only supported in a [declarative config](/self-hosting/more/declarative-config) and cannot be used in the web UI.</Note>
+        <Note>Environment variables are only supported in a [declarative config](/self-hosting/configuration/declarative-config) and cannot be used in the web UI.</Note>
 
         1. Add the `token` and `user` (username associated with the app password you created) properties to your connection config:
         ```json
@@ -27,7 +27,7 @@
     </Tab>
 
     <Tab title="Secret">
-        <Note>Secrets are only supported when [authentication](/self-hosting/more/authentication) is enabled.</Note>
+        <Note>Secrets are only supported when [authentication](/self-hosting/configuration/authentication) is enabled.</Note>
 
         1. Navigate to **Secrets** in settings and create a new secret with your access token:
 

docs/snippets/bitbucket-token.mdx

@@ -1,6 +1,6 @@
 <Tabs>
     <Tab title="Environment Variable">
-        <Note>Environment variables are only supported in a [declarative config](/self-hosting/more/declarative-config) and cannot be used in the web UI.</Note>
+        <Note>Environment variables are only supported in a [declarative config](/self-hosting/configuration/declarative-config) and cannot be used in the web UI.</Note>
 
         1. Add the `token` property to your connection config:
         ```json
@@ -25,7 +25,7 @@
     </Tab>
 
     <Tab title="Secret">
-        <Note>Secrets are only supported when [authentication](/self-hosting/more/authentication) is enabled.</Note>
+        <Note>Secrets are only supported when [authentication](/self-hosting/configuration/authentication) is enabled.</Note>
 
         1. Navigate to **Secrets** in settings and create a new secret with your PAT:
 

packages/mcp/CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Changed
+- Added API key support. [#311](https://github.com/sourcebot-dev/sourcebot/pull/311)
+
 # [1.0.1] - 2025-05-15
 
 ### Changed

packages/web/src/app/[domain]/browse/components/bottomPanel.tsx

@@ -12,13 +12,19 @@ import { VscReferences, VscSymbolMisc } from "react-icons/vsc";
 import { ImperativePanelHandle } from "react-resizable-panels";
 import { useBrowseState } from "../hooks/useBrowseState";
 import { ExploreMenu } from "@/ee/features/codeNav/components/exploreMenu";
+import Link from "next/link";
+import { useDomain } from "@/hooks/useDomain";
+import { useRouter } from "next/navigation";
 
 export const BOTTOM_PANEL_MIN_SIZE = 35;
 export const BOTTOM_PANEL_MAX_SIZE = 65;
+const CODE_NAV_DOCS_URL = "https://docs.sourcebot.dev/docs/search/code-navigation";
 
 export const BottomPanel = () => {
     const panelRef = useRef<ImperativePanelHandle>(null);
     const hasCodeNavEntitlement = useHasEntitlement("code-nav");
+    const domain = useDomain();
+    const router = useRouter();
 
     const {
         state: { selectedSymbolInfo, isBottomPanelCollapsed, bottomPanelSize },
@@ -92,16 +98,31 @@ export const BottomPanel = () => {
                 id={"bottom-panel"}
             >
                 {!hasCodeNavEntitlement ? (
-                    <div className="flex flex-col items-center justify-center h-full text-muted-foreground">
-                        <VscSymbolMisc className="w-6 h-6 mb-2" />
+                    <div className="flex flex-col items-center justify-center h-full text-muted-foreground gap-2">
+                        <VscSymbolMisc className="w-6 h-6" />
                         <p className="text-sm">
-                            Code navigation is not enabled for your plan.
+                            Code navigation is not enabled for <span className="text-blue-500 hover:underline cursor-pointer" onClick={() => router.push(`/${domain}/settings/license`)}>your plan</span>.
                         </p>
+                       
+                        <Link
+                            href={CODE_NAV_DOCS_URL}
+                            target="_blank"
+                            className="text-sm text-blue-500 hover:underline"
+                        >
+                            Learn more
+                        </Link>
                     </div>
                 ) : !selectedSymbolInfo ? (
-                    <div className="flex flex-col items-center justify-center h-full text-muted-foreground">
-                        <VscSymbolMisc className="w-6 h-6 mb-2" />
+                    <div className="flex flex-col items-center justify-center h-full text-muted-foreground gap-2">
+                        <VscSymbolMisc className="w-6 h-6" />
                         <p className="text-sm">No symbol selected</p>
+                        <Link
+                            href={CODE_NAV_DOCS_URL}
+                            target="_blank"
+                            className="text-sm text-blue-500 hover:underline"
+                        >
+                            Learn more
+                        </Link>
                     </div>
                 ) : (
                     <ExploreMenu

packages/web/src/features/codeNav/actions.ts

@@ -7,6 +7,7 @@ import { isServiceError } from "@/lib/utils";
 import { FindRelatedSymbolsResponse } from "./types";
 import { ServiceError } from "@/lib/serviceError";
 import { SearchResponse } from "../search/types";
+import { OrgRole } from "@sourcebot/db";
 
 // The maximum number of matches to return from the search API.
 const MAX_REFERENCE_COUNT = 1000;
@@ -40,7 +41,7 @@ export const findSearchBasedSymbolReferences = async (
             }
 
             return parseRelatedSymbolsSearchResponse(searchResult);
-        }), /* allowSingleTenantUnauthedAccess = */ true)
+        }, /* minRequiredRole = */ OrgRole.GUEST), /* allowSingleTenantUnauthedAccess = */ true)
 );
 
 
@@ -73,7 +74,7 @@ export const findSearchBasedSymbolDefinitions = async (
             }
 
             return parseRelatedSymbolsSearchResponse(searchResult);
-        }), /* allowSingleTenantUnauthedAccess = */ true)
+        }, /* minRequiredRole = */ OrgRole.GUEST), /* allowSingleTenantUnauthedAccess = */ true)
 );
 
 const parseRelatedSymbolsSearchResponse = (searchResult: SearchResponse) => {

packages/web/src/features/entitlements/constants.ts

@@ -27,7 +27,7 @@ export const isValidEntitlement = (entitlement: string): entitlement is Entitlem
 
 export const entitlementsByPlan: Record<Plan, Entitlement[]> = {
     oss: [],
-    "cloud:team": ["billing", "multi-tenancy", "sso"],
+    "cloud:team": ["billing", "multi-tenancy", "sso", "code-nav"],
     "self-hosted:enterprise": ["search-contexts", "sso", "code-nav"],
     "self-hosted:enterprise-unlimited": ["search-contexts", "public-access", "sso", "code-nav"],
     "self-hosted:enterprise-custom": [],