Skip to content

Commit ce8d55f

Browse files
brendan-kellambrendan-kellam
authored
V4 docs refactor (#322)
1 parent a2e0626 commit ce8d55f

Some content is hidden

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

59 files changed

+617
-536
lines changed

‎.github/workflows/docs-broken-links.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Check for broken links in docs
2+
3+
on:
4+
pull_request:
5+
branches: ["main"]
6+
paths:
7+
- "docs/**"
8+
9+
jobs:
10+
check-links:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout repository
14+
uses: actions/checkout@v4
15+
16+
- name: Use Node.Js
17+
uses: actions/setup-node@v4
18+
with:
19+
node-version: '20.x'
20+
21+
- name: Install Mintlify CLI
22+
run: npm i -g mintlify
23+
24+
- name: Check for broken links
25+
working-directory: docs
26+
run: mintlify broken-links

‎CHANGELOG.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,19 @@ 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.
25-
- The first user that logs into the instance is given the `owner` role. ([docs](https://docs.sourcebot.dev/docs/more/roles-and-permissions)).
25+
- The first user that logs into the instance is given the `owner` role. ([docs](https://docs.sourcebot.dev/docs/configuration/auth/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/auth/overview)).
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
32-
- [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)
32+
- [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/features/code-navigation). [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
3333
- Added collapsible filter panel. [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
3434
- Added Sourcebot API key management for external clients. [#311](https://github.com/sourcebot-dev/sourcebot/pull/311)
3535

@@ -44,7 +44,7 @@ Sourcebot V4 introduces authentication, performance improvements and code naviga
4444
## [3.2.0] - 2025-05-12
4545

4646
### Added
47-
- Added AI code review agent [#298](https://github.com/sourcebot-dev/sourcebot/pull/298). Checkout the [docs](https://docs.sourcebot.dev/docs/agents/review-agent) for more information.
47+
- Added AI code review agent [#298](https://github.com/sourcebot-dev/sourcebot/pull/298). Checkout the [docs](https://docs.sourcebot.dev/docs/features/agents/review-agent) for more information.
4848

4949
### Fixed
5050
- Fixed issue with repos appearing in the carousel when they fail indexing for the first time. [#305](https://github.com/sourcebot-dev/sourcebot/pull/305)
@@ -113,20 +113,20 @@ 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/auth/overview).
126+
- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/docs/configuration/auth/overview)**:
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.
129-
- 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).
129+
- team & invite management: invite users to your instance to give them access. Configure team [roles & permissions](https://docs.sourcebot.dev/docs/configuration/auth/roles-and-permissions).
130130
- Added multi-tenancy support. See [this doc](https://docs.sourcebot.dev/self-hosting/more/tenancy).
131131

132132
### Removed

‎docs/development.mdx

Lines changed: 0 additions & 107 deletions
This file was deleted.

‎docs/docs.json

Lines changed: 50 additions & 72 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,45 @@
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/deployment-guide"
2625
]
2726
},
2827
{
29-
"group": "Connecting your code",
28+
"group": "Features",
29+
"pages": [
30+
{
31+
"group": "Search",
32+
"pages": [
33+
"docs/features/search/syntax-reference",
34+
"docs/features/search/multi-branch-indexing",
35+
"docs/features/search/search-contexts"
36+
]
37+
},
38+
"docs/features/code-navigation",
39+
"docs/features/mcp-server",
40+
{
41+
"group": "Agents",
42+
"tag": "experimental",
43+
"pages": [
44+
"docs/features/agents/overview",
45+
"docs/features/agents/review-agent"
46+
]
47+
}
48+
]
49+
},
50+
{
51+
"group": "Configuration",
3052
"pages": [
31-
"docs/connections/overview",
3253
{
33-
"group": "Supported platforms",
54+
"group": "Connecting your code",
3455
"pages": [
56+
"docs/connections/overview",
3557
"docs/connections/github",
3658
"docs/connections/gitlab",
3759
"docs/connections/bitbucket-cloud",
@@ -42,65 +64,24 @@
4264
"docs/connections/local-repos",
4365
"docs/connections/request-new"
4466
]
45-
}
46-
]
47-
},
48-
{
49-
"group": "Search",
50-
"pages": [
51-
"docs/search/syntax-reference",
52-
"docs/search/multi-branch-indexing",
53-
"docs/search/code-navigation",
54-
"docs/search/search-contexts"
55-
]
56-
},
57-
{
58-
"group": "Agents",
59-
"pages": [
60-
"docs/agents/overview",
61-
"docs/agents/review-agent"
62-
]
63-
},
64-
{
65-
"group": "More",
66-
"pages": [
67-
"docs/more/api-keys",
68-
"docs/more/roles-and-permissions",
69-
"docs/more/mcp-server"
70-
]
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": [
67+
},
68+
"docs/license-key",
69+
"docs/configuration/environment-variables",
70+
{
71+
"group": "Authentication",
72+
"pages": [
73+
"docs/configuration/auth/overview",
74+
"docs/configuration/auth/roles-and-permissions"
75+
]
76+
},
77+
"docs/configuration/transactional-emails"
9778
]
9879
},
9980
{
10081
"group": "Upgrade",
10182
"pages": [
102-
"self-hosting/upgrade/v3-to-v4-guide",
103-
"self-hosting/upgrade/v2-to-v3-guide"
83+
"docs/upgrade/v3-to-v4-guide",
84+
"docs/upgrade/v2-to-v3-guide"
10485
]
10586
}
10687
]
@@ -122,21 +103,18 @@
122103
"dark": "/logo/dark.png"
123104
},
124105
"navbar": {
125-
"links": [
126-
{
127-
"label": "GitHub",
128-
"href": "https://github.com/sourcebot-dev/sourcebot"
129-
}
130-
],
131106
"primary": {
132107
"type": "button",
133-
"label": "Sourcebot Cloud",
134-
"href": "https://app.sourcebot.dev"
108+
"label": "GitHub",
109+
"href": "https://github.com/sourcebot-dev/sourcebot"
135110
}
136111
},
137112
"footer": {
138113
"socials": {
139-
"github": "https://github.com/sourcebot-dev/sourcebot"
114+
"github": "https://github.com/sourcebot-dev/sourcebot",
115+
"twitter": "https://x.com/sourcebot_dev",
116+
"discord": "https://discord.gg/Y6b78RqM",
117+
"linkedin": "https://www.linkedin.com/company/sourcebot"
140118
}
141119
},
142120
"integrations": {
@@ -146,6 +124,6 @@
146124
},
147125
"appearance": {
148126
"default": "dark",
149-
"strict": true
127+
"strict": false
150128
}
151129
}

0 commit comments

Comments
 (0)