Skip to content

Commit c4106e4

Browse files
brendan-kellambrendan-kellam
committed
wip on refactoring docs
1 parent a2e0626 commit c4106e4

38 files changed

+288
-304
lines changed

‎CHANGELOG.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1717

1818
## [4.0.0] - 2025-05-28
1919

20-
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.
20+
Sourcebot V4 introduces authentication, performance improvements and code navigation. Checkout the [migration guide](https://docs.sourcebot.dev/docs/upgrade/v3-to-v4-guide) for information on upgrading your instance to v4.
2121

2222
### Changed
2323
- [**Breaking Change**] Authentication is now required by default. Notes:
2424
- When setting up your instance, email / password login will be the default authentication provider.
2525
- The first user that logs into the instance is given the `owner` role. ([docs](https://docs.sourcebot.dev/docs/more/roles-and-permissions)).
2626
- Subsequent users can request to join the instance. The `owner` can approve / deny requests to join the instance via `Settings` > `Members` > `Pending Requests`.
2727
- If a user is approved to join the instance, they are given the `member` role.
28-
- Additional login providers, including email links and SSO, can be configured with additional environment variables. ([docs](https://docs.sourcebot.dev/self-hosting/configuration/authentication)).
28+
- Additional login providers, including email links and SSO, can be configured with additional environment variables. ([docs](https://docs.sourcebot.dev/docs/configuration/authentication)).
2929
- 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)
3030

3131
### Added
@@ -113,17 +113,17 @@ Sourcebot V4 introduces authentication, performance improvements and code naviga
113113

114114
## [3.0.0] - 2025-04-01
115115

116-
Sourcebot v3 is here and brings a number of structural changes to the tool's foundation, including a SQL database, parallelized indexing, authentication support, multitenancy, and more. Checkout the [migration guide](https://docs.sourcebot.dev/self-hosting/upgrade/v2-to-v3-guide) for information on upgrading your instance to v3.
116+
Sourcebot v3 is here and brings a number of structural changes to the tool's foundation, including a SQL database, parallelized indexing, authentication support, multitenancy, and more. Checkout the [migration guide](https://docs.sourcebot.dev/docs/upgrade/v2-to-v3-guide) for information on upgrading your instance to v3.
117117

118118
### Changed
119-
- [**Breaking Change**] Changed the config schema such that connection objects are specified in the `connection` map, instead of the `repos` array. [See migration guide](https://docs.sourcebot.dev/self-hosting/upgrade/v2-to-v3-guide).
119+
- [**Breaking Change**] Changed the config schema such that connection objects are specified in the `connection` map, instead of the `repos` array. [See migration guide](https://docs.sourcebot.dev/docs/upgrade/v2-to-v3-guide).
120120
- Updated the tool's color-palette in dark mode.
121121

122122
### Added
123-
- Added parallelized repo indexing and connection syncing via Redis & BullMQ. See the [architecture overview](https://docs.sourcebot.dev/self-hosting/overview#architecture).
123+
- Added parallelized repo indexing and connection syncing via Redis & BullMQ. See the [architecture overview](https://docs.sourcebot.dev/docs/overview#architecture).
124124
- Added repo indexing progress indicators in the navbar.
125-
- Added authentication support via OAuth or email/password. For instructions on enabling, see [this doc](https://docs.sourcebot.dev/self-hosting/configuration/authentication).
126-
- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/self-hosting/configuration/authentication)**:
125+
- Added authentication support via OAuth or email/password. For instructions on enabling, see [this doc](https://docs.sourcebot.dev/docs/configuration/authentication).
126+
- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/docs/configuration/authentication)**:
127127
- connection management: create and manage your JSON configs via a integrated web-editor.
128128
- secrets: import personal access tokens (PAT) into Sourcebot (AES-256 encrypted). Reference secrets in your connection config by name.
129129
- 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

Lines changed: 21 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://mintlify.com/docs.json",
3-
"theme": "mint",
3+
"theme": "willow",
44
"name": "Sourcebot",
55
"colors": {
66
"primary": "#851EE7",
@@ -15,23 +15,23 @@
1515
"anchors": [
1616
{
1717
"anchor": "Docs",
18-
"icon": "book-open",
18+
"icon": "books",
1919
"groups": [
2020
{
21-
"group": "General",
21+
"group": "Getting Started",
2222
"pages": [
2323
"docs/overview",
24-
"docs/getting-started",
25-
"docs/getting-started-selfhost"
24+
"docs/quick-start-guide",
25+
"docs/license-key"
2626
]
2727
},
2828
{
29-
"group": "Connecting your code",
29+
"group": "Configuration",
3030
"pages": [
31-
"docs/connections/overview",
3231
{
33-
"group": "Supported platforms",
32+
"group": "Connecting your code",
3433
"pages": [
34+
"docs/connections/overview",
3535
"docs/connections/github",
3636
"docs/connections/gitlab",
3737
"docs/connections/bitbucket-cloud",
@@ -42,7 +42,10 @@
4242
"docs/connections/local-repos",
4343
"docs/connections/request-new"
4444
]
45-
}
45+
},
46+
"docs/configuration/environment-variables",
47+
"docs/configuration/authentication",
48+
"docs/configuration/transactional-emails"
4649
]
4750
},
4851
{
@@ -68,39 +71,12 @@
6871
"docs/more/roles-and-permissions",
6972
"docs/more/mcp-server"
7073
]
71-
}
72-
]
73-
},
74-
{
75-
"anchor": "Self Hosting",
76-
"icon": "server",
77-
"groups": [
78-
{
79-
"group": "Getting Started",
80-
"pages": [
81-
"self-hosting/overview",
82-
"self-hosting/license-key"
83-
]
84-
},
85-
{
86-
"group": "Configuration",
87-
"pages": [
88-
"self-hosting/configuration/environment-variables",
89-
"self-hosting/configuration/authentication",
90-
"self-hosting/configuration/transactional-emails",
91-
"self-hosting/configuration/declarative-config"
92-
]
93-
},
94-
{
95-
"group": "Security",
96-
"pages": [
97-
]
9874
},
9975
{
10076
"group": "Upgrade",
10177
"pages": [
102-
"self-hosting/upgrade/v3-to-v4-guide",
103-
"self-hosting/upgrade/v2-to-v3-guide"
78+
"docs/upgrade/v3-to-v4-guide",
79+
"docs/upgrade/v2-to-v3-guide"
10480
]
10581
}
10682
]
@@ -122,21 +98,18 @@
12298
"dark": "/logo/dark.png"
12399
},
124100
"navbar": {
125-
"links": [
126-
{
127-
"label": "GitHub",
128-
"href": "https://github.com/sourcebot-dev/sourcebot"
129-
}
130-
],
131101
"primary": {
132102
"type": "button",
133-
"label": "Sourcebot Cloud",
134-
"href": "https://app.sourcebot.dev"
103+
"label": "GitHub",
104+
"href": "https://github.com/sourcebot-dev/sourcebot"
135105
}
136106
},
137107
"footer": {
138108
"socials": {
139-
"github": "https://github.com/sourcebot-dev/sourcebot"
109+
"github": "https://github.com/sourcebot-dev/sourcebot",
110+
"twitter": "https://x.com/sourcebot_dev",
111+
"discord": "https://discord.gg/Y6b78RqM",
112+
"linkedin": "https://www.linkedin.com/company/sourcebot"
140113
}
141114
},
142115
"integrations": {
@@ -146,6 +119,6 @@
146119
},
147120
"appearance": {
148121
"default": "dark",
149-
"strict": true
122+
"strict": false
150123
}
151124
}

‎docs/self-hosting/configuration/authentication.mdx renamed to ‎docs/docs/configuration/authentication.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ sidebarTitle: Authentication
77

88
Sourcebot has built-in authentication that gates access to your organization. OAuth, email codes, and email / password are supported.
99

10-
The first account that's registered on a Sourcebot deployment is made the owner. All other users who register must be [approved](/self-hosting/configuration/authentication#approving-new-members) by the owner.
10+
The first account that's registered on a Sourcebot deployment is made the owner. All other users who register must be [approved](/docs/configuration/authentication#approving-new-members) by the owner.
1111

1212
![Login Page](/images/login.png)
1313

@@ -16,10 +16,10 @@ The first account that's registered on a Sourcebot deployment is made the owner.
1616

1717
All account registrations after the first account must be approved by the owner. The owner can see all join requests by going into **Settings -> Members**.
1818

19-
If you have an [enterprise license](/self-hosting/license-key), you can enable [AUTH_EE_ENABLE_JIT_PROVISIONING](/self-hosting/configuration/authentication#enterprise-authentication-providers) to
19+
If you have an [enterprise license](/docs/license-key), you can enable [AUTH_EE_ENABLE_JIT_PROVISIONING](/docs/configuration/authentication#enterprise-authentication-providers) to
2020
have Sourcebot accounts automatically created and approved on registration.
2121

22-
You can setup emails to be sent when new join requests are created/approved by configurating [transactional emails](/self-hosting/configuration/transactional-emails)
22+
You can setup emails to be sent when new join requests are created/approved by configurating [transactional emails](/docs/configuration/transactional-emails)
2323
# Authentication Providers
2424

2525
To enable an authentication provider in Sourcebot, configure the required environment variables for the provider. Under the hood, Sourcebot uses Auth.js which supports [many providers](https://authjs.dev/getting-started/authentication/oauth). Submit a [feature request on GitHub](https://github.com/sourcebot-dev/sourcebot/discussions/categories/ideas) if you want us to add support for a specific provider.
@@ -39,11 +39,11 @@ Email codes are 6 digit codes sent to a provided email. Email codes are enabled
3939
- `EMAIL_FROM_ADDRESS`
4040

4141

42-
See [transactional emails](/self-hosting/configuration/transactional-emails) for more details.
42+
See [transactional emails](/docs/configuration/transactional-emails) for more details.
4343

4444
## Enterprise Authentication Providers
4545

46-
The following authentication providers require an [enterprise license](/self-hosting/license-key) to be enabled.
46+
The following authentication providers require an [enterprise license](/docs/license-key) to be enabled.
4747

4848
By default, a new user registering using these providers must have their join request accepted by the owner of the organization to join. To allow a user to join automatically when
4949
they register for the first time, set the `AUTH_EE_ENABLE_JIT_PROVISIONING` environment variable to `true`.

‎docs/self-hosting/configuration/declarative-config.mdx renamed to ‎docs/docs/configuration/declarative-config.mdx

File renamed without changes.

‎docs/self-hosting/configuration/environment-variables.mdx renamed to ‎docs/docs/configuration/environment-variables.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,20 @@ The following environment variables allow you to configure your Sourcebot deploy
1010

1111
| Variable | Default | Description |
1212
| :------- | :------ | :---------- |
13-
| `AUTH_CREDENTIALS_LOGIN_ENABLED` | `true` | <p>Enables/disables authentication with basic credentials. Username and passwords are stored encrypted at rest within the postgres database. Checkout the [auth docs](/self-hosting/configuration/authentication) for more info</p> |
14-
| `AUTH_EMAIL_CODE_LOGIN_ENABLED` | `false` | <p>Enables/disables authentication with a login code that's sent to a users email. `SMTP_CONNECTION_URL` and `EMAIL_FROM_ADDRESS` must also be set. Checkout the [auth docs](/self-hosting/configuration/authentication) for more info </p> |
13+
| `AUTH_CREDENTIALS_LOGIN_ENABLED` | `true` | <p>Enables/disables authentication with basic credentials. Username and passwords are stored encrypted at rest within the postgres database. Checkout the [auth docs](/docs/configuration/authentication) for more info</p> |
14+
| `AUTH_EMAIL_CODE_LOGIN_ENABLED` | `false` | <p>Enables/disables authentication with a login code that's sent to a users email. `SMTP_CONNECTION_URL` and `EMAIL_FROM_ADDRESS` must also be set. Checkout the [auth docs](/docs/configuration/authentication) for more info </p> |
1515
| `AUTH_SECRET` | Automatically generated at startup if no value is provided. Generated using `openssl rand -base64 33` | <p>Used to validate login session cookies</p> |
1616
| `AUTH_URL` | - | <p>URL of your Sourcebot deployment, e.g., `https://example.com` or `http://localhost:3000`.</p> |
17-
| `CONFIG_PATH` | `-` | <p>The container relative path to the declerative configuration file. See [this doc](/self-hosting/configuration/declarative-config) for more info.</p> |
17+
| `CONFIG_PATH` | `-` | <p>The container relative path to the declerative configuration file. See [this doc](/docs/configuration/declarative-config) for more info.</p> |
1818
| `DATA_CACHE_DIR` | `$DATA_DIR/.sourcebot` | <p>The root data directory in which all data written to disk by Sourcebot will be located.</p> |
1919
| `DATA_DIR` | `/data` | <p>The directory within the container to store all persistent data. Typically, this directory will be volume mapped such that data is persisted across container restarts (e.g., `docker run -v $(pwd):/data`)</p> |
2020
| `DATABASE_DATA_DIR` | `$DATA_CACHE_DIR/db` | <p>The data directory for the default Postgres database.</p> |
2121
| `DATABASE_URL` | `postgresql://postgres@ localhost:5432/sourcebot` | <p>Connection string of your Postgres database. By default, a Postgres database is automatically provisioned at startup within the container.</p><p>If you'd like to use a non-default schema, you can provide it as a parameter in the database url </p> |
22-
| `EMAIL_FROM_ADDRESS` | `-` | <p>The email address that transactional emails will be sent from. See [this doc](/self-hosting/configuration/transactional-emails) for more info.</p> |
22+
| `EMAIL_FROM_ADDRESS` | `-` | <p>The email address that transactional emails will be sent from. See [this doc](/docs/configuration/transactional-emails) for more info.</p> |
2323
| `REDIS_DATA_DIR` | `$DATA_CACHE_DIR/redis` | <p>The data directory for the default Redis instance.</p> |
2424
| `REDIS_URL` | `redis://localhost:6379` | <p>Connection string of your Redis instance. By default, a Redis database is automatically provisioned at startup within the container.</p> |
2525
| `SHARD_MAX_MATCH_COUNT` | `10000` | <p>The maximum shard count per query</p> |
26-
| `SMTP_CONNECTION_URL` | `-` | <p>The url to the SMTP service used for sending transactional emails. See [this doc](/self-hosting/configuration/transactional-emails) for more info.</p> |
26+
| `SMTP_CONNECTION_URL` | `-` | <p>The url to the SMTP service used for sending transactional emails. See [this doc](/docs/configuration/transactional-emails) for more info.</p> |
2727
| `SOURCEBOT_ENCRYPTION_KEY` | Automatically generated at startup if no value is provided. Generated using `openssl rand -base64 24` | <p>Used to encrypt connection secrets and generate API keys.</p> |
2828
| `SOURCEBOT_LOG_LEVEL` | `info` | <p>The Sourcebot logging level. Valid values are `debug`, `info`, `warn`, `error`, in order of severity.</p> |
2929
| `SOURCEBOT_TELEMETRY_DISABLED` | `false` | <p>Enables/disables telemetry collection in Sourcebot. See [this doc](/self-hosting/security/telemetry) for more info.</p> |

‎docs/self-hosting/configuration/tenancy.mdx renamed to ‎docs/docs/configuration/tenancy.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebarTitle: Multi tenancy
44
---
55

66
<Warning>If you're switching from single-tenant mode, delete the Sourcebot cache (the `.sourcebot` folder) before starting.</Warning>
7-
<Warning>[Authentication](/self-hosting/configuration/authentication) must be enabled to enable multi tenancy mode</Warning>
7+
<Warning>[Authentication](/docs/configuration/authentication) must be enabled to enable multi tenancy mode</Warning>
88
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
99
named `SOURCEBOT_TENANCY_MODE` and set its value to `multi`. When multi tenancy mode is enabled:
1010

‎docs/self-hosting/configuration/transactional-emails.mdx renamed to ‎docs/docs/configuration/transactional-emails.mdx

File renamed without changes.

‎docs/docs/connections/bitbucket-cloud.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Linking code from Bitbucket Cloud
33
sidebarTitle: Bitbucket Cloud
4+
icon: Bitbucket
45
---
56

67
import BitbucketToken from '/snippets/bitbucket-token.mdx';

‎docs/docs/connections/bitbucket-data-center.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
title: Linking code from Bitbucket Data Center
33
sidebarTitle: Bitbucket Data Center
4+
icon: Bitbucket
45
---
56

67
import BitbucketToken from '/snippets/bitbucket-token.mdx';

‎docs/docs/connections/generic-git-host.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
22
title: Other Git hosts
3+
icon: git-alt
34
---
45

56
import GenericGitHost from '/snippets/schemas/v3/genericGitHost.schema.mdx'

0 commit comments

Comments
 (0)