Skip to content

V4 docs refactor #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 2, 2025
Merged

V4 docs refactor #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c4106e4
wip on refactoring docs
brendan-kellam May 30, 2025
2f5b26f
wip
brendan-kellam May 31, 2025
34105cd
add gh workflow for catching broken links
brendan-kellam May 31, 2025
c96d2cd
further wip
brendan-kellam May 31, 2025
6df4b11
fix
brendan-kellam May 31, 2025
aa834a0
further wip on docs
brendan-kellam Jun 1, 2025
d411126
feedback
brendan-kellam Jun 2, 2025
c77d85a
fix broken links
brendan-kellam Jun 2, 2025
0958b21
nits
brendan-kellam Jun 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions .github/workflows/docs-broken-links.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Check for broken links in docs

on:
pull_request:
branches: ["main"]
paths:
- "docs/**"

jobs:
check-links:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Use Node.Js
uses: actions/setup-node@v4
with:
node-version: '20.x'

- name: Install Mintlify CLI
run: npm i -g mintlify

- name: Check for broken links
working-directory: docs
run: mintlify broken-links
22 changes: 11 additions & 11 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [4.0.0] - 2025-05-28

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.
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.

### 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)).
- The first user that logs into the instance is given the `owner` role. ([docs](https://docs.sourcebot.dev/docs/configuration/auth/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)).
- Additional login providers, including email links and SSO, can be configured with additional environment variables. ([docs](https://docs.sourcebot.dev/docs/configuration/auth/overview)).
- 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 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)
- [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)
- Added collapsible filter panel. [#315](https://github.com/sourcebot-dev/sourcebot/pull/315)
- Added Sourcebot API key management for external clients. [#311](https://github.com/sourcebot-dev/sourcebot/pull/311)

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

### Added
- 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.
- 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.

### Fixed
- 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)
Expand Down Expand Up @@ -113,20 +113,20 @@ Sourcebot V4 introduces authentication, performance improvements and code naviga

## [3.0.0] - 2025-04-01

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.
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.

### Changed
- [**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).
- [**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).
- Updated the tool's color-palette in dark mode.

### Added
- Added parallelized repo indexing and connection syncing via Redis & BullMQ. See the [architecture overview](https://docs.sourcebot.dev/self-hosting/overview#architecture).
- Added parallelized repo indexing and connection syncing via Redis & BullMQ. See the [architecture overview](https://docs.sourcebot.dev/docs/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/configuration/authentication).
- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/self-hosting/configuration/authentication)**:
- Added authentication support via OAuth or email/password. For instructions on enabling, see [this doc](https://docs.sourcebot.dev/docs/configuration/auth/overview).
- Added the following UI for managing your deployment when **[auth is enabled](https://docs.sourcebot.dev/docs/configuration/auth/overview)**:
- 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).
- 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).
- Added multi-tenancy support. See [this doc](https://docs.sourcebot.dev/self-hosting/more/tenancy).

### Removed
Expand Down
107 changes: 0 additions & 107 deletions docs/development.mdx
View file
Open in desktop

This file was deleted.

122 changes: 50 additions & 72 deletions docs/docs.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"theme": "willow",
"name": "Sourcebot",
"colors": {
"primary": "#851EE7",
Expand All @@ -15,23 +15,45 @@
"anchors": [
{
"anchor": "Docs",
"icon": "book-open",
"icon": "books",
"groups": [
{
"group": "General",
"group": "Getting Started",
"pages": [
"docs/overview",
"docs/getting-started",
"docs/getting-started-selfhost"
"docs/deployment-guide"
]
},
{
"group": "Connecting your code",
"group": "Features",
"pages": [
{
"group": "Search",
"pages": [
"docs/features/search/syntax-reference",
"docs/features/search/multi-branch-indexing",
"docs/features/search/search-contexts"
]
},
"docs/features/code-navigation",
"docs/features/mcp-server",
{
"group": "Agents",
"tag": "experimental",
"pages": [
"docs/features/agents/overview",
"docs/features/agents/review-agent"
]
}
]
},
{
"group": "Configuration",
"pages": [
"docs/connections/overview",
{
"group": "Supported platforms",
"group": "Connecting your code",
"pages": [
"docs/connections/overview",
"docs/connections/github",
"docs/connections/gitlab",
"docs/connections/bitbucket-cloud",
Expand All @@ -42,65 +64,24 @@
"docs/connections/local-repos",
"docs/connections/request-new"
]
}
]
},
{
"group": "Search",
"pages": [
"docs/search/syntax-reference",
"docs/search/multi-branch-indexing",
"docs/search/code-navigation",
"docs/search/search-contexts"
]
},
{
"group": "Agents",
"pages": [
"docs/agents/overview",
"docs/agents/review-agent"
]
},
{
"group": "More",
"pages": [
"docs/more/api-keys",
"docs/more/roles-and-permissions",
"docs/more/mcp-server"
]
}
]
},
{
"anchor": "Self Hosting",
"icon": "server",
"groups": [
{
"group": "Getting Started",
"pages": [
"self-hosting/overview",
"self-hosting/license-key"
]
},
{
"group": "Configuration",
"pages": [
"self-hosting/configuration/environment-variables",
"self-hosting/configuration/authentication",
"self-hosting/configuration/transactional-emails",
"self-hosting/configuration/declarative-config"
]
},
{
"group": "Security",
"pages": [
},
"docs/license-key",
"docs/configuration/environment-variables",
{
"group": "Authentication",
"pages": [
"docs/configuration/auth/overview",
"docs/configuration/auth/roles-and-permissions"
]
},
"docs/configuration/transactional-emails"
]
},
{
"group": "Upgrade",
"pages": [
"self-hosting/upgrade/v3-to-v4-guide",
"self-hosting/upgrade/v2-to-v3-guide"
"docs/upgrade/v3-to-v4-guide",
"docs/upgrade/v2-to-v3-guide"
]
}
]
Expand All @@ -122,21 +103,18 @@
"dark": "/logo/dark.png"
},
"navbar": {
"links": [
{
"label": "GitHub",
"href": "https://github.com/sourcebot-dev/sourcebot"
}
],
"primary": {
"type": "button",
"label": "Sourcebot Cloud",
"href": "https://app.sourcebot.dev"
"label": "GitHub",
"href": "https://github.com/sourcebot-dev/sourcebot"
}
},
"footer": {
"socials": {
"github": "https://github.com/sourcebot-dev/sourcebot"
"github": "https://github.com/sourcebot-dev/sourcebot",
"twitter": "https://x.com/sourcebot_dev",
"discord": "https://discord.gg/Y6b78RqM",
"linkedin": "https://www.linkedin.com/company/sourcebot"
}
},
"integrations": {
Expand All @@ -146,6 +124,6 @@
},
"appearance": {
"default": "dark",
"strict": true
"strict": false
}
}
Loading