Skip to content

Commit dcb9ce8

Browse files
msukkariclaude
andcommitted
docs: v5 docs updates
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent c552c90 commit dcb9ce8

56 files changed

Lines changed: 429 additions & 368 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/api-reference/sourcebot-public.openapi.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2289,7 +2289,7 @@
22892289
"summary": "Get a user",
22902290
"description": "Fetches profile details for a single organization member by `userId`. Only organization owners can access this endpoint.",
22912291
"x-mint": {
2292-
"content": "<Note>\nThis API is only available with an active Enterprise license. Please add your [license key](/docs/license-key) to activate it.\n</Note>"
2292+
"content": "<Note>\nThis API is only available with an active Enterprise license. Please add your [license key](/docs/activating-a-subscription) to activate it.\n</Note>"
22932293
},
22942294
"parameters": [
22952295
{
@@ -2364,7 +2364,7 @@
23642364
"summary": "Delete a user",
23652365
"description": "Permanently deletes a user and all associated records. Only organization owners can delete other users.",
23662366
"x-mint": {
2367-
"content": "<Note>\nThis API is only available with an active Enterprise license. Please add your [license key](/docs/license-key) to activate it.\n</Note>"
2367+
"content": "<Note>\nThis API is only available with an active Enterprise license. Please add your [license key](/docs/activating-a-subscription) to activate it.\n</Note>"
23682368
},
23692369
"parameters": [
23702370
{
@@ -2441,7 +2441,7 @@
24412441
"summary": "List users",
24422442
"description": "Returns all members of the organization. Only organization owners can access this endpoint.",
24432443
"x-mint": {
2444-
"content": "<Note>\nThis API is only available with an active Enterprise license. Please add your [license key](/docs/license-key) to activate it.\n</Note>"
2444+
"content": "<Note>\nThis API is only available with an active Enterprise license. Please add your [license key](/docs/activating-a-subscription) to activate it.\n</Note>"
24452445
},
24462446
"responses": {
24472447
"200": {
@@ -2486,7 +2486,7 @@
24862486
"summary": "List audit records",
24872487
"description": "Returns a paginated list of audit log entries. Only organization owners can access this endpoint.",
24882488
"x-mint": {
2489-
"content": "<Note>\nThis API is only available with an active Enterprise license. Please add your [license key](/docs/license-key) to activate it.\n</Note>"
2489+
"content": "<Note>\nThis API is only available with an active Enterprise license. Please add your [license key](/docs/activating-a-subscription) to activate it.\n</Note>"
24902490
},
24912491
"parameters": [
24922492
{

docs/docs.json

Lines changed: 60 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -40,18 +40,10 @@
4040
"pages": [
4141
"docs/overview",
4242
{
43-
"group": "Deployment",
43+
"group": "Deploy Sourcebot",
4444
"pages": [
4545
"docs/deployment/docker-compose",
46-
"docs/deployment/k8s",
47-
"docs/deployment/sizing-guide",
48-
{
49-
"group": "Infrastructure",
50-
"pages": [
51-
"docs/deployment/infrastructure/architecture",
52-
"docs/deployment/infrastructure/redis"
53-
]
54-
}
46+
"docs/deployment/k8s"
5547
]
5648
}
5749
]
@@ -61,8 +53,8 @@
6153
"pages": [
6254
{
6355
"group": "Code Search",
56+
"root": "docs/features/search/code-search",
6457
"pages": [
65-
"docs/features/search/overview",
6658
"docs/features/search/syntax-reference",
6759
"docs/features/search/ai-search-assist",
6860
"docs/features/search/multi-branch-indexing",
@@ -71,8 +63,8 @@
7163
},
7264
{
7365
"group": "Ask Sourcebot",
66+
"root": "docs/features/ask/ask-sourcebot",
7467
"pages": [
75-
"docs/features/ask/overview",
7668
"docs/features/ask/chat-sharing",
7769
"docs/features/ask/add-model-providers"
7870
]
@@ -84,8 +76,8 @@
8476
{
8577
"group": "Agents",
8678
"tag": "experimental",
79+
"root": "docs/features/agents/agents",
8780
"pages": [
88-
"docs/features/agents/overview",
8981
"docs/features/agents/review-agent"
9082
]
9183
}
@@ -98,8 +90,8 @@
9890
"docs/configuration/environment-variables",
9991
{
10092
"group": "Indexing your code",
93+
"root": "docs/connections/indexing-your-code",
10194
"pages": [
102-
"docs/connections/overview",
10395
"docs/connections/github",
10496
"docs/connections/gitlab",
10597
"docs/connections/bitbucket-cloud",
@@ -117,24 +109,48 @@
117109
"docs/configuration/idp",
118110
{
119111
"group": "Authentication",
112+
"root": "docs/configuration/auth/authentication",
120113
"pages": [
121-
"docs/configuration/auth/overview",
122114
"docs/configuration/auth/providers",
123115
"docs/configuration/auth/access-settings",
124116
"docs/configuration/auth/roles-and-permissions",
125117
"docs/configuration/auth/faq"
126118
]
127119
},
128-
"docs/license-key",
129-
"docs/billing",
130120
"docs/configuration/transactional-emails",
131121
"docs/configuration/structured-logging",
132122
"docs/configuration/audit-logs"
133123
]
134124
},
125+
{
126+
"group": "Subscribe",
127+
"pages": [
128+
"docs/activating-a-subscription",
129+
"docs/billing",
130+
"docs/free-trial"
131+
]
132+
},
133+
{
134+
"group": "Misc",
135+
"pages": [
136+
"docs/misc/architecture",
137+
"docs/misc/scalability",
138+
"docs/misc/telemetry",
139+
"docs/misc/service-ping",
140+
"docs/deployment/sizing-guide",
141+
{
142+
"group": "Infrastructure",
143+
"pages": [
144+
"docs/deployment/infrastructure/architecture",
145+
"docs/deployment/infrastructure/redis"
146+
]
147+
}
148+
]
149+
},
135150
{
136151
"group": "Upgrade",
137152
"pages": [
153+
"docs/upgrade/v4-to-v5-guide",
138154
"docs/upgrade/v3-to-v4-guide",
139155
"docs/upgrade/v2-to-v3-guide"
140156
]
@@ -231,5 +247,31 @@
231247
"appearance": {
232248
"default": "dark",
233249
"strict": false
234-
}
250+
},
251+
"redirects": [
252+
{
253+
"source": "/docs/features/search/overview",
254+
"destination": "/docs/features/search/code-search"
255+
},
256+
{
257+
"source": "/docs/features/ask/overview",
258+
"destination": "/docs/features/ask/ask-sourcebot"
259+
},
260+
{
261+
"source": "/docs/features/agents/overview",
262+
"destination": "/docs/features/agents/agents"
263+
},
264+
{
265+
"source": "/docs/connections/overview",
266+
"destination": "/docs/connections/indexing-your-code"
267+
},
268+
{
269+
"source": "/docs/configuration/auth/overview",
270+
"destination": "/docs/configuration/auth/authentication"
271+
},
272+
{
273+
"source": "/docs/license-key",
274+
"destination": "/docs/activating-a-subscription"
275+
}
276+
]
235277
}
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
title: Activating a Subscription
3+
sidebarTitle: Activating a subscription
4+
---
5+
6+
You can activate a paid plan subscription by using either an Activation Code or a License Key.
7+
8+
# Activation Code (Online Licensing)
9+
10+
<Warning>Your Sourcebot deployment must be able to send a [Service Ping](/docs/misc/service-ping) to validate your Activation Code. If your deployment is unable to send a service ping for 7 days it will downgrade to the free plan until a successul ping is sent. </Warning>
11+
12+
The default mechanism for activating a subscription is through an Activation Code. This activation mechanism allows your Sourcebot deployment to automatically manage its subscription by regularly
13+
sychronizing with our license server.
14+
15+
### What data does Sourcebot collect?
16+
17+
To enable online licensing, your Sourcebot deployment must be able to communicate with our license server through our [Service Ping](/docs/misc/service-ping). The data that is transmitted is limited to information that is
18+
required to administer your Sourcebot license and support dynamic seat increases. No sensitive data (source code, AI inputs/outputs, credentials, or user information) will ever be transmitted. For more information, please check out our [privacy policy](https://www.sourcebot.dev/privacy)
19+
20+
# License Key (Offline Licensing)
21+
22+
<Note>The default mechanism for activating a subscription is now through an [Activation Code](#activation-code-online-licensing). Offline licensing using a License Key may be requested by reaching out using our enterprise contact form on our [pricing page](https://www.sourcebot.dev/pricing)</Note>
23+
24+
After purchasing a license key, you can activate it by setting the `SOURCEBOT_EE_LICENSE_KEY` environment variable.
25+
26+
If you'd like to increase the number of seats on your Sourcebot deployment you must request a new license key, manually update this environment variable, and then restart your deployment.
27+
28+
```bash
29+
docker run \
30+
-e SOURCEBOT_EE_LICENSE_KEY=<your-license-key> \
31+
/* additional args */ \
32+
ghcr.io/sourcebot-dev/sourcebot:latest
33+
```
34+
35+
## FAQ
36+
37+
#### What happens when my subscription expires?
38+
39+
When a paid plan subscription expires, your deployment will automatically be downgraded to the free plan. You must upgrade your subscription in order to continue using the paid features.

docs/docs/billing.mdx

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,27 @@
11
---
2-
title: Billing
3-
sidebarTitle: Billing
2+
title: Seat Reconciliation
3+
sidebarTitle: Seat Reconciliation
44
---
55

6-
Sourcebot Enterprise is available on monthly and yearly plans. Both are seat-based. This page explains how seats are billed, how changes mid-term are handled, and what happens at renewal.
6+
When using an [Activation Code](/docs/activating-a-subscription#activation-code-online-licensing), your Sourcebot deployment is permitted to exceed the number of seats you've purchsed. Seat reconciliation refers
7+
to how these excess seats are billed, and it depends on your billing period.
78

8-
## Seat count
9-
Your seat count is the number of active users in your Sourcebot instance. Seat usage is reported to Sourcebot on a daily interval, and your subscription quantity is kept in sync with that number.
9+
<Note>Seat reconciliation doesn't apply if you're using a [License Key](/docs/activating-a-subscription#license-key-offline-licensing) since the key sets a hard cap on seats. If you're using a license key and would like more seats, please reach out to us to purchase a new license key.</Note>
1010

11-
## Monthly plans
12-
Monthly subscriptions are billed at the start of each billing cycle. Users added mid-cycle are prorated across the remaining days and appear on your next invoice. Users removed mid-cycle take effect at the next cycle. There is no refund for the remainder of the current one.
11+
For a more detailed breakdown, please refer to our [Software License Agreeement](https://www.sourcebot.dev/terms) which is the source of truth on how seats are handled and billed.
1312

14-
In short: you can scale up at any time and pay the prorated difference. Scaling down is effectively free until the cycle rolls over.
13+
# Monthly Billing
1514

16-
## Yearly plans
15+
Sourcebot supports monthly with standard proration behavior. Users added during the month are prorated across the remaining days and appear on your next invoice. Users removed during the month take effect at the next cycle, and are not refunded for the current cycle.
16+
17+
# Yearly Billing
18+
19+
## Quarterly Reconciliation
20+
The standard mechanism for seat reconciliation in yearly plans is through quarterly reconciliation. You are billed per quarter on a prorated basis for the remaining portion of your subscription term for any additional seats you activate.
21+
22+
To prevent overages, you can restrict you may register on your Sourcebot deployment through our [access controls](/docs/configuration/auth/access-settings).
1723

18-
Yearly subscriptions are billed upfront for a committed seat count. As users are added during the term, the seat count rises but you aren't charged immediately. Every three months we reconcile. Any seats added that quarter are billed, prorated across the quarters remaining in the term.
1924

20-
Seats only move upward during the term. Shrinking the user count does not refund, and does not reduce the seat count until renewal. At renewal, you're invoiced at your current seat count, and that number becomes the committed baseline for the next year.
2125

2226
### Example
2327

docs/docs/configuration/audit-logs.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebarTitle: Audit logs
55

66
import LicenseKeyRequired from '/snippets/license-key-required.mdx'
77

8-
<LicenseKeyRequired feature="Audit Logs" />
8+
<LicenseKeyRequired feature="Audit Logs" verb="are" />
99

1010
Audit logs are a collection of notable events performed by users within a Sourcebot deployment. Each audit log records information on the action taken, the user who performed the
1111
action, and when the action took place.
@@ -19,7 +19,7 @@ Audit logs are enabled by default and can be controlled with the `SOURCEBOT_EE_A
1919
By default, audit logs older than 180 days are automatically pruned daily. You can configure the retention period using the `SOURCEBOT_EE_AUDIT_RETENTION_DAYS` [environment variable](/docs/configuration/environment-variables). Set it to `0` to disable automatic pruning and retain logs indefinitely.
2020

2121
## Fetching Audit Logs
22-
Audit logs are stored in the [postgres database](/docs/overview#architecture) connected to Sourcebot. To fetch all of the audit logs, you can use the following API:
22+
Audit logs are stored in the [postgres database](/docs/misc/architecture) connected to Sourcebot. To fetch all of the audit logs, you can use the following API:
2323

2424
```bash icon="terminal" Fetch audit logs
2525
curl --request GET '$SOURCEBOT_URL/api/ee/audit' \

docs/docs/configuration/auth/overview.mdx renamed to docs/docs/configuration/auth/authentication.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Overview
2+
title: Authentication
33
---
44

55
<Warning>If you're deploying Sourcebot behind a domain, you must set the [AUTH_URL](/docs/configuration/environment-variables) environment variable.</Warning>

docs/docs/configuration/auth/providers.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,4 +27,4 @@ See [transactional emails](/docs/configuration/transactional-emails) for more de
2727
# Enterprise Authentication Providers
2828

2929
Sourcebot supports authentication using several different [external identity providers](/docs/configuration/idp) as well. These identity providers require an
30-
[enterprise license](/docs/license-key)
30+
[enterprise license](/docs/activating-a-subscription)

docs/docs/configuration/config-file.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ The config file tells Sourcebot which repos to index, what language models to us
2323

2424
The config file you provide Sourcebot must follow the [schema](https://github.com/sourcebot-dev/sourcebot/blob/main/schemas/v3/index.json). This schema consists of the following properties:
2525

26-
- [Connections](/docs/connections/overview) (`connections`): Defines a set of connections that tell Sourcebot which repos to index and from where
26+
- [Connections](/docs/connections/indexing-your-code) (`connections`): Defines a set of connections that tell Sourcebot which repos to index and from where
2727
- [Language Models](/docs/configuration/language-model-providers) (`models`): Defines a set of language model providers for use with [Ask Sourcebot](/docs/features/ask)
2828
- [Settings](#settings) (`settings`): Additional settings to tweak your Sourcebot deployment
2929
- [Search Contexts](/docs/features/search/search-contexts) (`contexts`): Groupings of repos that you can search against

docs/docs/configuration/declarative-config.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebarTitle: Declarative config
55

66
import ConfigSchema from '/snippets/schemas/v3/index.schema.mdx'
77

8-
Some teams require Sourcebot to be configured via a file (where it can be stored in version control, run through CI/CD pipelines, etc.) instead of a web UI. For more information on configuring connections, see this [overview](/docs/connections/overview).
8+
Some teams require Sourcebot to be configured via a file (where it can be stored in version control, run through CI/CD pipelines, etc.) instead of a web UI. For more information on configuring connections, see this [overview](/docs/connections/indexing-your-code).
99

1010

1111
| Variable | Description |

0 commit comments

Comments
 (0)