Repository navigation
Switch to the DocSearch Docusaurus adapter - #1295
Merged
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
🔵 Needs a closer look
The new Algolia key and Agent Studio agent depend on external configuration, requiring live preview verification of search, prompt suggestions, Ask AI, and light/dark modal and menu readability before approval.
No open issues 🎉
What changed in this PR
Migrates the site's search integration to the DocSearch v5 Docusaurus adapter, including Agent Studio-powered Ask AI and updated theme styling.
Changes:
- Replaces
themeConfig.algoliawiththemeConfig.docsearch, configuring search, the Ask AI agent, and prompt suggestions. - Adds the adapter and pins shared DocSearch packages to 5.2.0 to address duplicate React contexts.
- Updates search colors and popover styling for light and dark modes.
| File | Description |
|---|---|
src/css/custom.css |
Updates DocSearch variables and menu colors for v5. |
package.json |
Adds the adapter and shared-package version overrides. |
package-lock.json |
Records the updated DocSearch dependency tree. |
docusaurus.config.ts |
Registers the adapter and migrates search and Ask AI configuration. |
Review effort: Balanced
2 of 4 tasks
Collaborator
Author
|
/update-snapshots |
Contributor
|
📸 Regenerated visual baselines per your |
danbarr
force-pushed
the
switch-to-docsearch-adapter
branch
from
October 30, 2026 20:23
e482964 to
19b3159
Compare
danbarr
enabled auto-merge (squash)
October 30, 2026 22:40
Replace the built-in Algolia theme with @docsearch/docusaurus-adapter and move themeConfig.algolia to themeConfig.docsearch, using a new search-only API key and the Agent Studio agent for Ask AI. Pin @docsearch/core, react, and css to 5.2.0 with npm overrides. preset-classic hoists a 4.x @docsearch/core, which makes npm install a separate 5.x copy under each adapter package. Each copy has its own React context, so the modal throws "useDocSearch must be used within the DocSearch provider". Remove the overrides once algolia/docsearch#3074 is fixed. Leave askAi.indices unset because the agent's search tool is in static mode and rejects per-request index overrides. Point askAi.promptSuggestions at the stacklok-markdown_prompt_suggestions index. Update the DocSearch variables in custom.css for the v5 markup. The adapter's stock theme leaves the modal transparent in light mode and uses fixed light colors for hovered rows, keys, and menus in dark mode (algolia/docsearch#3075). Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
danbarr
force-pushed
the
switch-to-docsearch-adapter
branch
from
November 2, 2026 14:04
19b3159 to
268fcf8
Compare
aponcedeleonch
approved these changes
Nov 5, 2026
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Replaces the built-in Algolia search theme with
@docsearch/docusaurus-adapter(v5) and movesthemeConfig.algoliatothemeConfig.docsearch. It uses a new search-only API key and the Agent Studio agent for Ask AI.stacklok-markdown_prompt_suggestionsindex (askAi.promptSuggestions).askAi.indicesis intentionally unset. The agent's search tool is in static mode and rejects per-request index overrides.package.jsonpins@docsearch/core,react, andcssto 5.2.0 with npmoverrides.preset-classichoists a 4.x@docsearch/core, so npm installs a separate 5.x copy under each adapter package. Each copy has its own React context, and the search modal throwsuseDocSearch must be used within the DocSearch provider. The overrides can go once @docsearch/docusaurus-adapter 5.2.0: "useDocSearch must be used within the DocSearch provider" when a 4.x @docsearch/core is hoisted algolia/docsearch#3074 is fixed. That is also whypackage-lock.jsonhas a large diff.custom.cssupdates the DocSearch variables for the v5 markup. The adapter's stock theme leaves the modal transparent in light mode and uses fixed light colors for hovered rows, keys, and menus in dark mode (Docusaurus adapter: modal is transparent in light mode and several surfaces and menus don't follow dark mode algolia/docsearch#3075).The sidepanel is not enabled. I tried it and it crowded the navbar.
Type of change
Related issues/PRs
🤖 Generated with Claude Code
Visual regression screenshots
Auto-generated by CI from
scripts/pr-screenshot-summary.mjs— edits inside this block are overwritten on the next push.🟡 Changed
/diff
diff
/toolhive/guides-mcp/context7diff
diff
/theme-previewdiff
diff