Skip to content

feat(search): update Docsearch to v4-beta #11327

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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

dylantientcheu
Copy link

@dylantientcheu dylantientcheu commented Jul 15, 2025

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

image
  • 10 years of DocSearch!
    It’s been a decade since DocSearch was launched, empowering millions of developers to find documentation faster and more intuitively.

  • 5 years since DocSearch v3:
    After half a decade of feedback and innovation, we’re excited to unveil the next major leap.

  • This PR updates DocSearch to its latest version (v4) and introduces the Ask AI feature, reflecting our vision for the next generation of documentation search. Our goal is to provide a more powerful, accessible, and intelligent search experience for your users.

  • Ask AI is completely optional and never enabled by default. DocSearch v4 can be used independently of Ask AI, giving you full control over your integration.

What is included in this PR

  • Upgraded the version of docsearch to use the latest beta
  • Added the new askAi prop
  • Added the new translation keys for docsearch
  • Updated the Algolia logo on the contextual search page
  • [wip] - Update Algolia Search documentation section.

Test Plan

Try the new search experience by clicking the search button or using the keyboard shortcut (Cmd + K or Ctrl + K).

Features

DocSearch v4

  • Completely modernized UI: DocSearch v4 features a brand new, ground-up redesign for a more intuitive and visually appealing experience.
  • Still 💯 Free: DocSearch stays free for all eligible documentation/technical blog websites as it has always been.
  • Core functionality preserved: All the features users love from previous versions remain, ensuring a seamless transition.
  • Customization-first: Extensive customization options remain at the heart of DocSearch, allowing you to tailor the look and feel to your brand.
  • Recent searches & favorites: Continue to quickly revisit previous keyword searches and save favorites for easy access.
  • Enhanced accessibility and performance: Improved ARIA support, keyboard navigation, and even faster load times.
  • Mobile-optimized: Responsive and touch-friendly for a great experience on any device.
  • Dark mode: Seamless integration with your site’s dark theme.

Ask AI

  • Conversational search: Users can ask questions in natural language and get context-aware answers.
  • Completely free: Ask AI is available at no additional cost.
  • BYOLLM (Bring Your Own LLM): You can use your own language model provider, giving you full control over the AI experience.
  • Direct Algolia index integration: The provider/models retrieve relevant context directly from your Algolia index, ensuring accurate and up-to-date answers.
  • Recently asked & conversation history: Easily revisit your recent questions and jump back into previous Ask AI conversations.
  • Seamless integration: Ask AI is available directly from the search modal.

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

N/A

References:

@meta-cla meta-cla bot added the CLA Signed Signed Facebook CLA label Jul 15, 2025
Copy link

netlify bot commented Jul 15, 2025

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 4752b94
🔍 Latest deploy log https://app.netlify.com/projects/docusaurus-2/deploys/6877659aa0dbb90008c272e9
😎 Deploy Preview https://deploy-preview-11327--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

github-actions bot commented Jul 15, 2025

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🟠 68 🟢 98 🟢 100 🟢 100 Report
/docs/installation 🟠 61 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 69 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 59 🟢 96 🟢 100 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 57 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 57 🟢 96 🟢 100 🟠 86 Report
/blog/tags 🟠 68 🟢 100 🟢 100 🟠 86 Report

Copy link

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Addednode-releases@​2.0.191001004179100
Addedhasown@​2.0.2671007052100
Added@​algolia/​requester-browser-xhr@​5.25.01001004898100
Addeddefine-properties@​1.2.1671009251100
Addedaggregate-error@​3.1.0671008551100
Addedpath-parse@​1.0.7671007851100
Addedindent-string@​4.0.0671008851100
Addedobject-keys@​1.1.1671009151100
Addedes-define-property@​1.0.1671008151100
Addedhas-symbols@​1.1.0671008151100
Addedobject.assign@​4.1.76710010052100
Addedfunction-bind@​1.1.2671008252100
Addedobject-assign@​4.1.1671008554100
Addedis-arrayish@​0.2.11001005576100
Added@​babel/​plugin-transform-react-jsx-development@​7.27.11001005792100
Added@​docsearch/​css@​3.9.01001005894100
Added@​babel/​plugin-syntax-dynamic-import@​7.8.31001006081100
Added@​webassemblyjs/​ieee754@​1.13.21001006180100
Added@​babel/​plugin-transform-dotall-regex@​7.27.11001006192100
Added@​babel/​plugin-transform-regexp-modifiers@​7.27.11001006191100
Added@​babel/​plugin-transform-unicode-regex@​7.27.11001006192100
Added@​babel/​plugin-syntax-unicode-sets-regex@​7.18.61001006281100
Added@​webassemblyjs/​wasm-opt@​1.14.11001006279100
Added@​babel/​plugin-transform-unicode-sets-regex@​7.27.11001006292100
Added@​babel/​plugin-transform-reserved-words@​7.27.11001006392100
Added@​babel/​plugin-syntax-jsx@​7.27.11001006392100
Added@​babel/​helper-annotate-as-pure@​7.27.31001006393100
Addedcore-util-is@​1.0.31001006376100
Added@​babel/​plugin-transform-class-properties@​7.27.11001006392100
Added@​babel/​plugin-transform-private-methods@​7.27.11001006392100
Added@​algolia/​requester-fetch@​5.25.010010063100100
Added@​babel/​plugin-transform-named-capturing-groups-regex@​7.27.11001006392100
Added@​babel/​plugin-transform-optional-catch-binding@​7.27.11001006392100
See 580 more rows in the dashboard

View full report

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant