V4 docs refactor #322
V4 docs refactor #322
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThis update restructures and enhances documentation for Sourcebot, consolidating and rewriting guides, updating internal links, and introducing new pages such as the deployment and license key guides. Several outdated or redundant files were removed. Metadata and navigation structures were revised, and a GitHub Actions workflow was added to check for broken links in documentation. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant GitHub Actions
participant Docs Repo
User->>GitHub Actions: Open PR targeting main branch (docs/** changed)
GitHub Actions->>Docs Repo: Checkout code
GitHub Actions->>GitHub Actions: Setup Node.js 20.x
GitHub Actions->>GitHub Actions: Install Mintlify CLI
GitHub Actions->>Docs Repo: Run Mintlify CLI to check for broken links
GitHub Actions-->>User: Report broken links (if any)
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
brendan-kellam
force-pushed
the
bkellam/v4_docs_refactor
branch
from
2e20c32 to
2f5b26f
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
docs/docs/overview.mdx (1)
60-67: Refer to the earlier suggestion for adding accessibility attributes to video embeds.
🧹 Nitpick comments (26)
.github/workflows/docs-broken-links.yml (1)
21-23: Pin the Mintlify CLI to a fixed version
Installing the CLI unpinned (npm i -g mintlify) can introduce breaking changes when a new release drops. Pin to a known stable version in your action to ensure reproducible runs.Proposed diff:
- - name: Install Mintlify CLI - run: npm i -g mintlify + - name: Install Mintlify CLI + run: npm install -g mintlify@<stable-version>docs/docs/features/code-navigation.mdx (1)
7-7: Import new licensing component
Addingimport LicenseKeyRequiredsupports the upcoming<LicenseKeyRequired />usage; consider grouping MDX imports for clarity.docs/docs/features/agents/overview.mdx (1)
10-10: Minor style suggestion for American English.Consider changing "you've setup" to "you have set up" to align with American English conventions, as suggested by the static analysis tool.
-Agents are automations that leverage the code indexed on Sourcebot to perform a specific task. Once you've setup Sourcebot, check out the +Agents are automations that leverage the code indexed on Sourcebot to perform a specific task. Once you have set up Sourcebot, check out the🧰 Tools
🪛 LanguageTool
[style] ~10-~10: In American English, “you” and “have” do not usually form a contraction unless they’re followed by a past participle.
Context: ...rcebot to perform a specific task. Once you've setup Sourcebot, check out the guides b...(IVE_I_HAVE_AMERICAN_STYLE)
docs/docs/features/search/search-contexts.mdx (1)
18-18: Update Declarative Config Link & WordingThe internal link to the declarative config is now
/docs/configuration/declarative-config. Also consider simplifying “inside of a” to “in a” to remove redundancy.🧰 Tools
🪛 LanguageTool
[style] ~18-~18: This phrase is redundant. Consider using “inside”.
Context: ...xts are defined in thecontextobject inside of a [declarative config](/docs/configurat...(OUTSIDE_OF)
docs/docs/configuration/auth/overview.mdx (1)
19-19: Grammar: ‘setup’ → ‘set up’Use the verb phrase “set up emails” instead of “setup emails”:
- You can setup emails to be sent when new join requests… + You can set up emails to be sent when new join requests…🧰 Tools
🪛 LanguageTool
[grammar] ~19-~19: The word “setup” is a noun. The verb is spelled with a space.
Context: ... and approved on registration. You can setup emails to be sent when new join request...(NOUN_VERB_CONFUSION)
CHANGELOG.md (4)
20-20: Adjust verb form: ‘Checkout’ → ‘Check out’Prefer the phrasal verb “check out” for imperative statements:
- Sourcebot V4 introduces authentication... Checkout the [migration guide]... + Sourcebot V4 introduces authentication... Check out the [migration guide]...🧰 Tools
🪛 LanguageTool
[grammar] ~20-~20: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...mance improvements and code navigation. Checkout the [migration guide](https://docs.sour...(SENT_START_NN_DT)
47-47: Adjust verb form: ‘Checkout’ → ‘Check out’Consistency: convert to phrasal verb “check out”:
- Added AI code review agent [#298](...). Checkout the [docs](...). + Added AI code review agent [#298](...). Check out the [docs](...).🧰 Tools
🪛 LanguageTool
[grammar] ~47-~47: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ....com//pull/298). Checkout the [docs](https://docs.sourcebot.dev/d...(SENT_START_NN_DT)
116-116: Adjust verb form: ‘Checkout’ → ‘Check out’Make the imperative phrase consistent:
- Sourcebot v3 is here... Checkout the [migration guide](...). + Sourcebot v3 is here... Check out the [migration guide](...).🧰 Tools
🪛 LanguageTool
[grammar] ~116-~116: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...cation support, multitenancy, and more. Checkout the [migration guide](https://docs.sour...(SENT_START_NN_DT)
127-127: Article usage: ‘a’ → ‘an’.Use “an integrated web-editor” for correct article grammar:
- connection management: create and manage your JSON configs via a integrated web-editor. + connection management: create and manage your JSON configs via an integrated web-editor.🧰 Tools
🪛 LanguageTool
[misspelling] ~127-~127: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...create and manage your JSON configs via a integrated web-editor. - secrets: imp...(EN_A_VS_AN)
docs/docs/configuration/environment-variables.mdx (1)
14-15: Grammar: ‘Checkout’ → ‘Check out’Convert to the imperative phrasal verb:
- Checkout the [auth docs](/docs/configuration/auth/overview) for more info + Check out the [auth docs](/docs/configuration/auth/overview) for more info🧰 Tools
🪛 LanguageTool
[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...d at rest within the postgres database. Checkout the [auth docs](/docs/configuration/aut...(SENT_START_NN_DT)
[grammar] ~15-~15: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...EMAIL_FROM_ADDRESSmust also be set. Checkout the [auth docs](/docs/configuration/aut...(SENT_START_NN_DT)
docs/docs/connections/overview.mdx (1)
46-46: Fix grammar: use "its" instead of "it's".The possessive form should be "its" rather than the contraction "it's".
-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: +When running Sourcebot, this file must be mounted in a volume that is accessible to the container, with its path specified in the `CONFIG_FILE` environment variable. For example:🧰 Tools
🪛 LanguageTool
[uncategorized] ~46-~46: Did you mean “its” (the possessive pronoun)?
Context: ...at is accessible to the container, with it's path specified in theCONFIG_FILEenv...(ITS_PREMIUM)
docs/docs.json (4)
18-18: Validate the Docs anchor icon
Ensure that thebooksicon aligns with the design system and is available in the icon library used by the documentation framework.
54-66: Verify 'Connecting your code' subgroup paths
TheConnecting your codesubgroup lists platform-specific pages underdocs/connections/. Please ensure each MDX file exists and is referenced with the correct path.
83-85: Consider ordering upgrade guides chronologically
Currently the Upgrade group listsv3-to-v4beforev2-to-v3. You may want to present them in chronological order (v2→v3 then v3→v4) to improve discoverability.
127-127: Double-checkstrictmode setting
Setting"strict": falsedisables strict link validation. Confirm this is intentional to allow flexible paths, or consider enabling strict mode if you want build-time link checks.docs/docs/overview.mdx (11)
20-22: UseInfocomponent for overview
Good use of<Info>to highlight the features overview. Consider linking to the deployment guide here for quick access.
24-24: Typo in search heading
Consider revising to "### Fast, index-based search" to correct punctuation and improve readability.
29-37: Refine bullet for language count
The bullet “Syntax highlighting support for over [100+ languages]” is redundant; consider “Syntax highlighting for 100+ languages” or “support for over 100 languages.”
39-46: Add accessibility attributes to video embed
Consider addingaria-labelor a descriptive caption and includingcontrolsso keyboard and screen-reader users can interact with the demo.
53-57: Grammar fix in hover popover description
Change “in a inline preview” to “in an inline preview” for correct article usage.
70-70: Heading hyphenation suggestion
Consider updating to "### Cross-code-host support" to match standard hyphenation rules.
73-77: Fix typos in 'Key benefits' bullets
- Replace “a expressive” with “an expressive”.
- Correct “exaclty” to “exactly”.
79-95: Normalize 'Bitbucket' casing and title consistency
In the platform cards, unify the naming for Bitbucket. The tooltip reads “Bitbucket cloud | Bitbucket Data Center” but the Card title is “BitBucket” (with capital ‘B’). Standardize to “Bitbucket.”
123-127: Fix hyphenation in 'No vendor lock-in'
Change “No-vendor lock-in:” to “No vendor lock-in:” for correct hyphen placement.
146-146: Remove or address TODO comment
The placeholder for outlining containerized services should be implemented or removed before merging.
156-156: Improve phrasing for style
Reduce redundancy by changing “run outside of the Sourcebot container” to “run outside the Sourcebot container”.🧰 Tools
🪛 LanguageTool
[style] ~156-~156: This phrase is redundant. Consider using “outside”.
Context: ...aged Redis / Postgres services that run outside of the Sourcebot container by providing th...(OUTSIDE_OF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
docs/images/bitbucket.pngis excluded by!**/*.pngdocs/images/gerrit.pngis excluded by!**/*.pngdocs/images/git.pngis excluded by!**/*.pngdocs/images/gitea.pngis excluded by!**/*.pngdocs/images/github.pngis excluded by!**/*.pngdocs/images/gitlab.pngis excluded by!**/*.pngdocs/images/local.pngis excluded by!**/*.png
📒 Files selected for processing (47)
.github/workflows/docs-broken-links.yml(1 hunks)CHANGELOG.md(3 hunks)docs/development.mdx(0 hunks)docs/docs.json(5 hunks)docs/docs/configuration/auth/overview.mdx(3 hunks)docs/docs/configuration/environment-variables.mdx(1 hunks)docs/docs/configuration/tenancy.mdx(1 hunks)docs/docs/configuration/transactional-emails.mdx(1 hunks)docs/docs/connections/bitbucket-cloud.mdx(1 hunks)docs/docs/connections/bitbucket-data-center.mdx(1 hunks)docs/docs/connections/generic-git-host.mdx(1 hunks)docs/docs/connections/gerrit.mdx(1 hunks)docs/docs/connections/gitea.mdx(3 hunks)docs/docs/connections/github.mdx(3 hunks)docs/docs/connections/gitlab.mdx(3 hunks)docs/docs/connections/local-repos.mdx(1 hunks)docs/docs/connections/overview.mdx(1 hunks)docs/docs/connections/request-new.mdx(1 hunks)docs/docs/deployment-guide.mdx(1 hunks)docs/docs/features/agents/overview.mdx(1 hunks)docs/docs/features/agents/review-agent.mdx(1 hunks)docs/docs/features/code-navigation.mdx(2 hunks)docs/docs/features/mcp-server.mdx(6 hunks)docs/docs/features/search/search-contexts.mdx(4 hunks)docs/docs/features/search/syntax-reference.mdx(1 hunks)docs/docs/getting-started-selfhost.mdx(0 hunks)docs/docs/getting-started.mdx(0 hunks)docs/docs/license-key.mdx(1 hunks)docs/docs/more/api-keys.mdx(0 hunks)docs/docs/overview.mdx(1 hunks)docs/docs/upgrade/v3-to-v4-guide.mdx(4 hunks)docs/self-hosting/license-key.mdx(0 hunks)docs/self-hosting/overview.mdx(0 hunks)docs/snippets/bitbucket-app-password.mdx(2 hunks)docs/snippets/bitbucket-token.mdx(2 hunks)docs/snippets/license-key-required.mdx(1 hunks)docs/snippets/schemas/v3/index.schema.mdx(1 hunks)packages/mcp/README.md(2 hunks)packages/schemas/src/v3/index.schema.ts(1 hunks)packages/schemas/src/v3/index.type.ts(1 hunks)packages/web/src/app/[domain]/agents/page.tsx(1 hunks)packages/web/src/app/[domain]/browse/components/bottomPanel.tsx(1 hunks)packages/web/src/app/[domain]/settings/license/page.tsx(1 hunks)packages/web/src/app/login/components/loginForm.tsx(4 hunks)packages/web/src/env.mjs(1 hunks)packages/web/src/lib/newsData.ts(1 hunks)schemas/v3/index.json(1 hunks)
💤 Files with no reviewable changes (6)
- docs/docs/getting-started-selfhost.mdx
- docs/docs/more/api-keys.mdx
- docs/docs/getting-started.mdx
- docs/self-hosting/license-key.mdx
- docs/development.mdx
- docs/self-hosting/overview.mdx
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/web/src/app/login/components/loginForm.tsx (1)
packages/web/src/components/ui/loading-button.tsx (1)
LoadingButton(30-30)
🪛 LanguageTool
docs/docs/configuration/auth/overview.mdx
[grammar] ~19-~19: The word “setup” is a noun. The verb is spelled with a space.
Context: ... and approved on registration. You can setup emails to be sent when new join request...
(NOUN_VERB_CONFUSION)
docs/docs/features/agents/overview.mdx
[style] ~10-~10: In American English, “you” and “have” do not usually form a contraction unless they’re followed by a past participle.
Context: ...rcebot to perform a specific task. Once you've setup Sourcebot, check out the guides b...
(IVE_I_HAVE_AMERICAN_STYLE)
CHANGELOG.md
[grammar] ~20-~20: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...mance improvements and code navigation. Checkout the [migration guide](https://docs.sour...
(SENT_START_NN_DT)
[grammar] ~47-~47: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ....com//pull/298). Checkout the [docs](https://docs.sourcebot.dev/d...
(SENT_START_NN_DT)
[grammar] ~116-~116: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...cation support, multitenancy, and more. Checkout the [migration guide](https://docs.sour...
(SENT_START_NN_DT)
[duplication] ~122-~122: Possible typo: you repeated a word.
Context: ...tool's color-palette in dark mode. ### Added - Added parallelized repo indexing and connecti...
(ENGLISH_WORD_REPEAT_RULE)
[misspelling] ~127-~127: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...create and manage your JSON configs via a integrated web-editor. - secrets: imp...
(EN_A_VS_AN)
docs/docs/configuration/environment-variables.mdx
[grammar] ~14-~14: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ...d at rest within the postgres database. Checkout the [auth docs](/docs/configuration/aut...
(SENT_START_NN_DT)
[grammar] ~15-~15: This sentence should probably be started with a verb instead of the noun ‘Checkout’. If not, consider inserting a comma for better clarity.
Context: ... EMAIL_FROM_ADDRESS must also be set. Checkout the [auth docs](/docs/configuration/aut...
(SENT_START_NN_DT)
docs/docs/overview.mdx
[style] ~156-~156: This phrase is redundant. Consider using “outside”.
Context: ...aged Redis / Postgres services that run outside of the Sourcebot container by providing th...
(OUTSIDE_OF)
docs/docs/connections/overview.mdx
[uncategorized] ~46-~46: Did you mean “its” (the possessive pronoun)?
Context: ...at is accessible to the container, with it's path specified in the CONFIG_FILE env...
(ITS_PREMIUM)
docs/docs/features/search/search-contexts.mdx
[style] ~18-~18: This phrase is redundant. Consider using “inside”.
Context: ...xts are defined in the context object inside of a [declarative config](/docs/configurat...
(OUTSIDE_OF)
🪛 GitHub Actions: Check for broken links in docs
docs/docs/license-key.mdx
[error] 1-1: Broken link found: /docs/features/search/overview
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (87)
.github/workflows/docs-broken-links.yml (1)
1-8: Workflow trigger and path filters are correctly scoped
The PR is set to run only on changes todocs/**targetingmain, which aligns with the intent to validate documentation links without adding noise to other workflows.docs/docs/connections/gerrit.mdx (1)
4-4: Icon metadata addition looks good
Addingicon: crowaligns with other connection pages and improves navigation consistency.docs/docs/connections/generic-git-host.mdx (1)
3-3: Added frontmatter icon for consistency
Thegit-alticon matches the pattern used across other connection docs.docs/docs/connections/request-new.mdx (1)
5-5: Frontmatter icon metadata update approved
Introducingicon: pluskeeps the visual theme uniform across the docs navigation.packages/web/src/app/[domain]/agents/page.tsx (1)
12-12: Updated agent docs URL to new path hierarchy
ChangingconfigureUrlto/docs/features/agents/review-agentmatches the repo’s restructuring—please verify the new URL resolves correctly.docs/docs/features/search/syntax-reference.mdx (1)
35-35: Corrected link path
The updated link target now correctly points to/docs/features/search/search-contexts, matching the new documentation hierarchy.docs/snippets/license-key-required.mdx (1)
2-4: Added license requirement note
This<Note>snippet clearly informs users that an Enterprise license is needed and directs them to the consolidated/docs/license-keypage.docs/docs/configuration/tenancy.mdx (1)
7-7: Updated authentication link
The warning now correctly references/docs/configuration/auth/overviewunder the reorganized docs structure.docs/docs/features/agents/review-agent.mdx (1)
13-13: Fixed deployment guide link
This change updates the getting-started link to/docs/deployment-guide, aligning with the new docs layout.packages/web/src/app/[domain]/settings/license/page.tsx (1)
36-36: Updated documentation URL
The “No License Found” message now points tohttps://docs.sourcebot.dev/docs/license-key, ensuring users land on the correct, updated licensing page.docs/docs/connections/local-repos.mdx (1)
3-3: Icon metadata added
The newicon: folderfield in the frontmatter follows the established pattern across connection docs and will correctly render the folder icon in navigation.packages/mcp/README.md (1)
5-5: Docs badge link updated
The Docs badge now points to/docs/features/mcp-server, aligning with the reorganized documentation structure.docs/docs/configuration/transactional-emails.mdx (1)
10-10: Updated link to email codes section
The link now correctly points to/docs/configuration/auth/overview#email-codes, matching the new docs hierarchy.schemas/v3/index.json (1)
86-86: Corrected search-contexts URL
The description now references/docs/features/search/search-contexts, reflecting the updated path for the search contexts guide.docs/snippets/bitbucket-app-password.mdx (2)
3-3: Updated declarative config link
The Note now links to/docs/configuration/declarative-config, consistent with the consolidated docs structure.
30-30: Updated authentication link
The Note now points to/docs/configuration/auth/overview, aligning with the new authentication documentation path.docs/docs/connections/bitbucket-data-center.mdx (2)
4-4: Add icon metadata for consistency
The newicon: Bitbucketfrontmatter aligns with other connection docs and will improve visual navigation in the sidebar.
11-13: Cross-link to Bitbucket Cloud docs
The<Note>component pointing users to/docs/connections/bitbucket-cloudimproves discoverability and avoids misdirected readers.docs/snippets/bitbucket-token.mdx (2)
3-3: Update declarative config link
Switching the URL to/docs/configuration/declarative-configcorrectly reflects the new docs structure.
28-29: Update authentication link
Pointing to/docs/configuration/auth/overviewensures the snippet references the current auth overview page.docs/docs/connections/bitbucket-cloud.mdx (2)
4-4: Add icon metadata for Bitbucket Cloud
Theicon: Bitbucketaddition matches the Data Center doc and standardizes the UI.
11-13: Reciprocal cross-link to Data Center docs
The<Note>directing users to/docs/connections/bitbucket-data-centercompletes the bidirectional linking pattern.docs/docs/features/code-navigation.mdx (2)
9-9: Replace manual license note
Using the reusable<LicenseKeyRequired />centralizes license messaging and keeps docs consistent.
27-27: Update search syntax link path
Changing to/docs/features/search/syntax-referenceensures the link targets the new feature-focused structure.packages/schemas/src/v3/index.type.ts (1)
19-19: URL update aligns with documentation restructuring.The documentation URL has been correctly updated to reflect the new path structure under
/docs/features/search/. This maintains consistency with the broader documentation reorganization effort.packages/schemas/src/v3/index.schema.ts (1)
190-190: Schema description URL correctly updated.The URL in the schema description has been properly updated to match the new documentation structure. This ensures consistency between the schema definitions and the actual documentation paths.
docs/docs/features/agents/overview.mdx (2)
6-8: Good improvement in messaging about experimental features.Changing from a
<Note>to a<Warning>block better emphasizes that agents are experimental and sets appropriate user expectations.
14-14: URL update aligns with documentation restructuring.The href has been correctly updated to the new documentation path structure under
/docs/features/agents/.docs/docs/upgrade/v3-to-v4-guide.mdx (1)
11-11: Comprehensive URL updates align with documentation restructuring.All documentation links have been systematically updated from the old
/self-hosting/paths to the new/docs/structure. This consolidation improves navigation and maintains consistency across the documentation.The updates include:
- License key documentation
- Authentication configuration guides
- Transactional emails setup
- Internal cross-references
This ensures all links remain functional after the documentation reorganization.
Also applies to: 25-25, 30-30, 39-39, 50-50, 54-54
packages/web/src/app/[domain]/browse/components/bottomPanel.tsx (1)
21-21: URL constant updated to maintain functional documentation links.The
CODE_NAV_DOCS_URLconstant has been correctly updated to reflect the new documentation path structure. This ensures the "Learn more" links in the component continue to point to the correct code navigation documentation.packages/web/src/lib/newsData.ts (3)
8-8: URLs Updated to New Docs Structure – ApprovedThe URL for the “Code navigation” news item has been updated to the new
/docs/features/code-navigationpath, matching the restructured documentation.
14-14: SSO News Link Adjusted – ApprovedThe SSO item’s URL now correctly points to
/docs/configuration/auth/overview, aligning with the refactored auth docs.
20-20: Search Contexts Link Refreshed – ApprovedThe “Search contexts” news link has been updated to the new
/docs/features/search/search-contextspath; consistent with the updated docs hierarchy.packages/web/src/env.mjs (1)
28-34: Visual Separation of Enterprise Auth Variables – ApprovedBlank lines have been added between groups of Enterprise Auth environment variables to enhance readability without changing schema definitions.
docs/docs/features/search/search-contexts.mdx (3)
7-9: Introduce<LicenseKeyRequired />Component – ApprovedThe new import and corresponding
<LicenseKeyRequired />insertion replaces the manual Enterprise license note, promoting reuse and consistency across docs.
43-43: Config.json Reference Link Corrected – ApprovedThe example now links to
/docs/configuration/declarative-configinstead of the old self-hosting path.
107-107: Search Syntax Reference Link Updated – ApprovedThe final “See this doc” link now points to
/docs/features/search/syntax-reference, matching the new structure.docs/docs/features/mcp-server.mdx (6)
12-12: Deployment Guide Link Updated – ApprovedThe “Launch Sourcebot” step now references the consolidated
/docs/deployment-guideinstead of the self-hosting quick start.
17-23: Add “Create an API key” Step – ApprovedNew step clearly guides users to create and set
SOURCEBOT_API_KEYbefore running the MCP server.
45-48: Cursor Snippet: IncludeSOURCEBOT_API_KEY– ApprovedThe Cursor example now includes both
SOURCEBOT_HOSTandSOURCEBOT_API_KEYenvironment variables.
69-72: Windsurf Snippet: AddSOURCEBOT_API_KEY– ApprovedWindsurf configuration has been updated to pass your API key via
SOURCEBOT_API_KEY.
95-97: VS Code Snippet: AddSOURCEBOT_API_KEY– ApprovedVS Code MCP settings now include both host and API key env vars.
112-112: Claude CLI: PassSOURCEBOT_API_KEY– ApprovedThe shell command for Claude CLI has been updated to include
-e SOURCEBOT_API_KEY, ensuring authenticated requests.docs/docs/connections/github.mdx (3)
4-4: Addicon: GitHubMetadata – ApprovedThe new
iconproperty in frontmatter will display the GitHub logo in the docs sidebar.
115-115: Update Declarative Config Note – ApprovedThe Note now correctly references
/docs/configuration/declarative-configfor environment variables in declarative config.
140-140: Update Auth Overview Note – ApprovedThe Note under “Secret” now links to
/docs/configuration/auth/overview, matching the updated auth documentation.docs/docs/configuration/auth/overview.mdx (5)
2-2: Frontmatter title updated correctly.Renaming the title from "Authentication" to "Overview" aligns with the restructuring and improves clarity.
7-8: Updated member approval instructions.The revised link to
/docs/configuration/auth/overview#approving-new-memberscorrectly reflects the new URL structure.
16-17: Repositioned enterprise license note.Linking to
/docs/license-keyhere is accurate and the phrasing is clear.
39-39: Link reference is correct.The link to
/docs/configuration/transactional-emailsis properly updated.
43-45: Warning placement and link updated.The relocated
<Warning>block and updated/docs/configuration/environment-variableslink follow the new doc layout.CHANGELOG.md (3)
25-25: Links updated to new/docspaths.The link to configuration roles and permissions correctly points to
/docs/configuration/auth/roles-and-permissions.
28-28: Authentication overview link updated.Good update: the link now uses
/docs/configuration/auth/overview.
32-32: New feature docs link inserted.The documentation link for search-based code navigation is accurate and well-formatted.
docs/docs/connections/gitlab.mdx (4)
4-4: Icon metadata added.The
icon: GitLabfrontmatter correctly introduces the GitLab logo in the sidebar.
38-38: Updated internal link for custom host.The link now points to
/docs/connections/gitlab#connecting-to-a-custom-gitlab-host—it matches the updated docs structure.
120-121: Note on environment variable support updated.Changing the declarative config link to
/docs/configuration/declarative-configis accurate.
145-145: Secret support note link updated.The link to authentication overview (
/docs/configuration/auth/overview) is correct.docs/docs/configuration/environment-variables.mdx (6)
2-4: Frontmatter titles and layout mode updated.Renaming “Environment variables” (lowercase) and adding
mode: "wide"keeps the page consistent with the new design.
7-7: Quickstart recommendation updated.Pointing users to the new
/docs/deployment-guideis clear and aligns with the refactor.
18-18: Declarative config link correct.The reference to
/docs/configuration/declarative-configis accurate.
23-23: Transactional emails link correct.The
/docs/configuration/transactional-emailslink is properly updated.
27-27: SMTP link correct.Internal link for SMTP configuration points to
/docs/configuration/transactional-emails.
30-30: Telemetry link correct.The link to
/docs/overview.mdx#telemetryaccurately navigates to telemetry docs.docs/docs/connections/gitea.mdx (3)
4-4: Icon metadata added.Adding
icon: mug-teain the frontmatter matches the updated sidebar style.
86-87: Declarative config note link updated.The declarative config link now correctly references
/docs/configuration/declarative-config.
111-112: Authentication overview note link updated.Pointing to
/docs/configuration/auth/overviewis consistent with the new structure.docs/docs/license-key.mdx (1)
1-43: Well-structured license documentation.The licensing information is clear and well-organized. The format effectively explains the distinction between OSS and licensed features, and the activation instructions are straightforward.
🧰 Tools
🪛 GitHub Actions: Check for broken links in docs
[error] 1-1: Broken link found: /docs/features/search/overview
packages/web/src/app/login/components/loginForm.tsx (2)
142-157: Excellent UX improvement with loading state management.The addition of loading state to the authentication buttons provides better user feedback during sign-in processes. The implementation correctly sets the loading state before triggering the authentication flow.
30-33: Clean code formatting improvement.The reformatted
signIncall options improve readability without changing functionality.docs/docs/connections/overview.mdx (1)
9-44: Excellent documentation restructuring with clear examples.The updated documentation effectively explains connection configuration through JSON files, and the concrete example provides practical guidance for users setting up multiple connections.
docs/docs/deployment-guide.mdx (1)
1-101: Comprehensive and well-structured deployment guide.The deployment guide is excellent with clear step-by-step instructions, helpful video walkthrough, and good use of MDX components for organization. The progression from requirements through completion is logical and user-friendly.
docs/docs.json (6)
3-3: Confirm the new theme identifier
Please verify that thewillowtheme is a supported Mintlify theme, as changing the theme could affect site styling if the theme is not available.
68-78: Confirm configuration group page existence
New pages under Configuration (license-key,authentication,transactional-emails) must have corresponding MDX files. Ensure these exist and render correctly:
docs/docs/license-key.mdxdocs/docs/configuration/auth/overview.mdxdocs/docs/configuration/auth/roles-and-permissions.mdxdocs/docs/configuration/transactional-emails.mdx
108-109: Navbar primary button updated correctly
Changing the primary navbar button to link to GitHub (instead of Sourcebot Cloud) aligns with the documentation focus.
114-117: Expanded footer social links
Good addition of Twitter, Discord, and LinkedIn to the footer for better community engagement.
21-25:✅ Verification successful
Verify new Getting Started page paths
The Getting Started navigation now includesdocs/deployment-guide. Please confirm thatdocs/docs/deployment-guide.mdxexists and its slug matches/docs/deployment-guide.
🏁 Script executed:
#!/bin/bash # Check for the deployment guide file rg -l "title:.*Deployment Guide" -g "docs/docs/deployment-guide.mdx" || echo "Deployment guide file not found"Length of output: 141
🏁 Script executed:
#!/bin/bash # List all files under docs containing 'deployment-guide' in their name find docs -type f \( -iname "*deployment-guide*.mdx" -o -iname "*deployment-guide*.md" \) || echo "No markdown files with 'deployment-guide' in the docs directory"Length of output: 124
🏁 Script executed:
#!/bin/bash # Extract YAML frontmatter from deployment-guide.mdx to verify slug and title awk ' /^---/ { count++; next } count == 1 { print } count == 2 { exit } ' docs/docs/deployment-guide.mdx || echo "No frontmatter found in deployment-guide.mdx"Length of output: 138
🏁 Script executed:
#!/bin/bash # Check for explicit slug in frontmatter rg -n '^slug:' docs/docs/deployment-guide.mdx || echo "No slug defined in frontmatter"Length of output: 118
Deployment Guide page path verified
docs/docs/deployment-guide.mdxexists.- Frontmatter title is
Deployment guide.- No explicit
slugis defined, so the default slug (deployment-guide) yields the intended route/docs/deployment-guide.All set!
28-48:✅ Verification successful
Ensure consistency of feature page paths
The Features navigation introduces nested groups (Search,Agents) and standalone pages (code-navigation,mcp-server). Please confirm that:
docs/features/mcp-server.mdxexists and aligns with nav.- File names on disk match the hyphenation and casing used here.
🏁 Script executed:
#!/bin/bash # List any missing MDX files referenced in the Features nav for path in \ docs/features/mcp-server.mdx \ docs/features/code-navigation.mdx \ docs/features/agents/overview.mdx \ docs/features/agents/review-agent.mdx; do [ ! -f "$path" ] && echo "Missing: $path" doneLength of output: 1176
🏁 Script executed:
#!/bin/bash # List all Markdown and MDX files in docs/features and docs/features/agents echo "docs/features/ directory files:" find docs/features -maxdepth 1 -type f \( -iname "*.md" -o -iname "*.mdx" \) | sed 's/^/ /' echo "" echo "docs/features/agents/ directory files:" find docs/features/agents -maxdepth 1 -type f \( -iname "*.md" -o -iname "*.mdx" \) | sed 's/^/ /'Length of output: 476
🏁 Script executed:
#!/bin/bash # Search for any 'features' directories in the repo echo "Searching for 'features' directories:" find . -type d -name features echo "" # List all Markdown/MDX files under any 'features' path echo "Listing MD/MDX files within 'features' directories:" find . -type f -path "*features*" \( -iname "*.md" -o -iname "*.mdx" \) | sed 's/^/ /'Length of output: 805
All feature page paths are correct
Verified that every entry in the Features navigation corresponds to an existing MDX file underdocs/docs/featureswith matching hyphens and casing. No missing pages detected.docs/docs/overview.mdx (9)
5-5: Update overview introduction
The new description succinctly explains what Sourcebot is. The GitHub link is correct.
7-15: Add 'Why Sourcebot?' accordion
The<AccordionGroup>markup provides a concise “Why Sourcebot?” summary. Ensure the component is properly imported and styled.
17-17: Features heading updated
The## Featuresheader is correctly introduced.
27-27: Search description
The search feature description is clear and concise.
49-49: Code Navigation section
The header and link align correctly with the navigation configuration.
50-50: Verify internal link
Ensure that/docs/features/code-navigationmatches the slug generated bydocs/features/code-navigation.mdx.
98-98: Authentication section header
The Authentication header correctly reflects the nav grouping.
100-100: Verify anchor links for authentication methods
Ensure that the fragment identifiers (#email-%2F-password,#email-codes,#enterprise-authentication-providers) match the actual headings indocs/configuration/auth/overview.mdx.
133-136: Confirm CardGroup link targets
Ensure eachhrefpoints to a valid slug:
/docs/deployment-guide/docs/connections/overview/docs/features/search/syntax-reference/docs/features/code-navigation
| @@ -188,7 +188,7 @@ | |||
| }, | |||
| "contexts": { | |||
| "type": "object", | |||
| "description": "[Sourcebot EE] Defines a collection of search contexts. This is only available in single-tenancy mode. See: https://docs.sourcebot.dev/docs/search/search-contexts", | |||
| "description": "[Sourcebot EE] Defines a collection of search contexts. This is only available in single-tenancy mode. See: https://docs.sourcebot.dev/docs/features/search/search-contexts", | |||
There was a problem hiding this comment.
Avoid manual edits in auto-generated schema
This file is auto-generated—manual updates here will be overwritten. Update the schema generator or templates to propagate this link change.
🤖 Prompt for AI Agents
In docs/snippets/schemas/v3/index.schema.mdx at line 191, the file is
auto-generated and manual edits will be overwritten. To update the description
link, modify the schema generator or the template files responsible for
generating this schema instead of editing this file directly.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (5)
docs/docs/connections/overview.mdx (2)
13-42: Adjust code block language for JSON with comments
The snippet uses//comments, which aren’t valid in strict JSON. To avoid confusion and improve syntax highlighting, either remove the comments or change the fence to a JSONC/JS code block.Proposed diff:
-```json +```jsoncAlternatively, remove all
// …lines so it remains pure JSON.--- `46-46`: **Fix possessive pronoun** Change “it's path” to the correct possessive “its path.” ```diff - ... with it's path specified in the `CONFIG_FILE` environment variable. + ... with its path specified in the `CONFIG_FILE` environment variable.🧰 Tools
🪛 LanguageTool
[uncategorized] ~46-~46: Did you mean “its” (the possessive pronoun)?
Context: ...at is accessible to the container, with it's path specified in theCONFIG_FILEenv...(ITS_PREMIUM)
docs/docs/overview.mdx (3)
24-24: Correct heading phrasing
“Fast-indexed based search” is awkward. Consider “Fast indexed search” or “Indexed-based search” for clarity.- ### Fast-indexed based search + ### Fast indexed search
146-146: Remove or resolve the inline TODO
The JSX comment<{/*TODO: outline ...*/}>is still present. Either implement this detail or remove the placeholder.Would you like help fleshing out the service descriptions here?
156-156: Simplify wording
The phrase “run outside of the Sourcebot container” can be shortened to “run outside the Sourcebot container.”- managed Redis / Postgres services that run outside of the Sourcebot container + managed Redis / Postgres services that run outside the Sourcebot container🧰 Tools
🪛 LanguageTool
[style] ~156-~156: This phrase is redundant. Consider using “outside”.
Context: ...aged Redis / Postgres services that run outside of the Sourcebot container by providing th...(OUTSIDE_OF)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/docs/connections/overview.mdx(1 hunks)docs/docs/deployment-guide.mdx(1 hunks)docs/docs/overview.mdx(1 hunks)packages/web/src/features/entitlements/server.ts(0 hunks)
💤 Files with no reviewable changes (1)
- packages/web/src/features/entitlements/server.ts
✅ Files skipped from review due to trivial changes (1)
- docs/docs/deployment-guide.mdx
🧰 Additional context used
🪛 LanguageTool
docs/docs/connections/overview.mdx
[uncategorized] ~46-~46: Did you mean “its” (the possessive pronoun)?
Context: ...at is accessible to the container, with it's path specified in the CONFIG_FILE env...
(ITS_PREMIUM)
docs/docs/overview.mdx
[style] ~156-~156: This phrase is redundant. Consider using “outside”.
Context: ...aged Redis / Postgres services that run outside of the Sourcebot container by providing th...
(OUTSIDE_OF)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
🔇 Additional comments (6)
docs/docs/connections/overview.mdx (3)
7-7: Verify the schema snippet import path
Please confirm that the path/snippets/schemas/v3/index.schema.mdxis correct for the current docs version. If this is a v4 refactor, you might need to update the snippet directory accordingly.
9-9: Great clarification of “connection” concept
The new definition is clear and concise.
11-11: JSON config introduction is on point
The explanation of using a JSON file for connections is accurate and user-friendly.docs/docs/overview.mdx (3)
5-5: Introductory highlight is effective
The emphasized opening sentence clearly communicates Sourcebot’s mission.
7-15: Accordion “Why Sourcebot?” reads well
The benefits list is comprehensive and formatted consistently.
20-20: Info block usage is clear
Good use of the<Info>component to draw attention to the features overview.
Docs refresh
Summary by CodeRabbit
New Features
Documentation
Style
Chores