further wip on docs

brendan-kellam · brendan-kellam · commit aa834a013a4f · 2025-06-01T15:17:59.000-07:00
diff --git a/docs/docs/connections/overview.mdx b/docs/docs/connections/overview.mdx
@@ -4,11 +4,71 @@ sidebarTitle: Overview
 ---
 
 import SupportedPlatforms from '/snippets/platform-support.mdx'
+import ConfigSchema from '/snippets/schemas/v3/index.schema.mdx'
 
-{/* TODO: document the concept of connections, the JSON schema, etc. */}
+A **connection** in Sourcebot represents a link to a code host (such as GitHub, GitLab, Bitbucket, etc.). Each connection defines how Sourcebot should authenticate and interact with a particular host, and which repositories to sync and index from that host. Connections are uniquely identified by their name.
 
-### Supported code hosts
+A JSON configuration file is used to specify connections. For example:
+
+```json
+// Specifies two connections:
+{
+    "$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json",
+    "connections": {
+        // 1. A connection to github.com
+        "github-connection": {
+            "type": "github",
+            "repos": [
+                "sourcebot-dev/sourcebot"
+            ],
+            "token": {
+                "env": "GITHUB_TOKEN"
+            }
+        },
+        // 2. A self-hosted GitLab instance
+        "gitlab-connection": {
+            "type": "gitlab",
+            "url": "https://gitlab.example.com",
+            "groups": [
+                "my-group",
+                "my-other-group/sub-group"
+            ],
+            "token": {
+                "env": "GITLAB_TOKEN"
+            }
+        }
+    }
+}
+```
+
+Configuration files must conform to the [JSON schema](https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json).
+
+When running Sourcebot, this file must be mounted in a volume that is accessible to the container, with it's path specified in the `CONFIG_FILE` environment variable. For example:
+
+```bash
+docker run \
+    -v $(pwd)/config.json:/data/config.json \
+    -e CONFIG_FILE=/data/config.json \
+    ... \ # other config
+    ghcr.io/sourcebot-dev/sourcebot:latest
+```
+
+## Getting started
+---
+
+To get started, pick a platform below and follow the instructions to connect your code.
 
 <SupportedPlatforms />
 
-<Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).</Note>
+<Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).</Note>
+
+
+## Schema reference
+---
+
+<Accordion title="Reference">
+[schemas/v3/index.json](https://github.com/sourcebot-dev/sourcebot/blob/main/schemas/v3/index.json)
+
+<ConfigSchema />
+
+</Accordion>
diff --git a/docs/docs/deployment-guide.mdx b/docs/docs/deployment-guide.mdx
@@ -86,15 +86,6 @@ Watch this 1:51 minute video to get a quick overview of how to deploy Sourcebot
             The first account which is registered on a fresh Sourcebot deployment is given the [owner role](/docs/configuration/auth/roles-and-permissions).
         </Note>
     </Step>
-
-    <Step title="Link your code">
-        Sourcebot supports indexing public & private code on the following code hosts:
-
-        <SupportedPlatforms />
-
-        <Note>Missing your code host? [Submit a feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas).</Note>
-    </Step>
-
 </Steps>
 
 ## Next steps
diff --git a/docs/docs/license-key.mdx b/docs/docs/license-key.mdx
@@ -7,10 +7,11 @@ sidebarTitle: License key
 If you'd like a trial license, [reach out](https://www.sourcebot.dev/contact) and we'll send one over within 24 hours
 </Note>
 
-All core Sourcebot features are available in Sourcebot OSS (MIT Licensed). Some additional features require a license key. See the [pricing page](https://www.sourcebot.dev/pricing) for more details.
+All core Sourcebot features are available in Sourcebot OSS (MIT Licensed) without any limits. Some additional features require a license key. See the [pricing page](https://www.sourcebot.dev/pricing) for more details.
 
 
 ## Activating a license key
+---
 
 After purchasing a license key, you can activate it by setting the `SOURCEBOT_EE_LICENSE_KEY` environment variable.
 
@@ -21,6 +22,22 @@ docker run \
     ghcr.io/sourcebot-dev/sourcebot:latest
 ```
 
+## Feature availability
+---
+
+| Feature | OSS | Licensed |
+|:---------|:-----|:----------|
+| [Search](/docs/features/search/overview) | ✅ | ✅ |
+| [Full code host support](/docs/connections/overview) | ✅ | ✅ |
+| [MCP Server](/docs/features/mcp-server) | ✅ | ✅ | 
+| [Agents](/docs/features/agents/overview) | ✅ | ✅ |
+| [Login with credentials](/docs/configuration/auth/overview) | ✅ | ✅ |
+| [Login with email codes](/docs/configuration/auth/overview) | ✅ | ✅ |
+| [Login with SSO](/docs/configuration/auth/overview#enterprise-authentication-providers) | 🛑 | ✅ |
+| [Code navigation](/docs/features/code-navigation) | 🛑 | ✅ |
+| [Search contexts](/docs/features/search/search-contexts) | 🛑 | ✅ |
+
+
 ## Questions?
 
 If you have any questions regarding licensing, please [contact us](https://www.sourcebot.dev/contact).
diff --git a/docs/docs/overview.mdx b/docs/docs/overview.mdx
@@ -6,16 +6,21 @@ title: "Overview"
 
 <AccordionGroup>
   <Accordion title="Why Sourcebot?">
-    - **Open-source:**
-    - **Fast:** Search across millions of lines of code in seconds using Sourcebot's blazingly fast indexed search.
-    - **Scalable:** Sourcebot uses [trigram indexing](https://en.wikipedia.org/wiki/Trigram_search), allowing it to scale to massive codebases.
-    - **Self-hosted:** Sourcebot is designed to be easily self-hosted, allowing you to deploy it onto your own infrastructure, keeping your code private and secure.
+    - **Full-featured search:** Fast indexed-based search with regex support, filters, branch search, boolean logic, and more.
+    - **Self-hosted:** Ships as a single [docker container](https://github.com/sourcebot-dev/sourcebot/pkgs/container/sourcebot) that can be deployed anywhere.
+    - **Modern design:** Light/Dark mode, vim keybindings, keyboard shortcuts, syntax highlighting, etc.
+    - **Scalable:** Scales to millions of lines of code.
+    - **Open-source:** Core features are MIT licensed, no vendor lock-in.
   </Accordion>
 </AccordionGroup>
 
 ## Features
 ---
 
+<Info>
+  Find an overview of all Sourcebot features below. For details, see the individual documentation pages.
+</Info>
+
 ### Fast-indexed based search
 
 Search across millions of lines of code in seconds using Sourcebot's blazingly fast indexed search. Find exactly what you are looking for with regular expressions, search filters, boolean logic, and more.
@@ -157,6 +162,15 @@ One of our design philosophies for Sourcebot is to keep our infrastructure [radi
 
 Sourcebot does not support horizontal scaling at this time, but it is on our roadmap. If this is something your team would be interested in, please contact us at [team@sourcebot.dev](mailto:team@sourcebot.dev).
 
+## License key
+---
+
+Sourcebot's core features are available under an [MIT license](https://github.com/sourcebot-dev/sourcebot/blob/HEAD/LICENSE) without any limits. Some [additional features](/docs/license-key#feature-availability) such as SSO and code navigation require a [license key](/docs/license-key).
+
+<CardGroup cols={2}>
+    <Card title="Pricing page" href="https://www.sourcebot.dev/pricing" />
+    <Card title="Request trial key" href="https://www.sourcebot.dev/contact" />
+</CardGroup>
 
 ## Telemetry
 ---
