Paul Jankowski
ecd905d440
feat: promote DocSearch v5 to main ( #2968 )
...
* feat(askai): add compatibility with algolia mcp search tool [DASH-2294] (#2862 )
## Summary
Fixes DASH-2294
Add compatibility with the Algolia MCP search tool (`algolia_search_index_${string}`) in AskAI.
## Changes
- Add `AlgoliaMCPSearchTool` type to handle the Algolia MCP server search tool
- Refactor how number of hits are retrieved in `ToolCall` into a `getNumberOfHits` helper
## Test plan
- Added unit tests for modified code ✅
* chore: Update to use tsdown for build system (#2824 )
* chore: Update to use tsdown for build system
* fix: docsearch-react build
* fix: lint
* fix: glob resolved to incorrect version
* chore: migrate to from yarn, lerna and shipjs to bun & changesets (#2827 )
* chore: add tool-versions file for node and bun versions (#2866 )
* chore: watch in parallel (#2867 )
* feat: agent studio feedback integration (#2868 )
* feat(askai): Split Ask AI modal into own component (#2884 )
* feat(askai): Split Ask AI modal into own component
* refactor(react): share modal utilities
* refactor(react): share search box form
* refactor(react): extract start screen sections
* refactor(react): extract shared modal hooks
* fix: lint adapter
* refactor(react): reorganize modal files
* fix: type error in examples
* fix: remove ai modal from adapter for now, fix import paths of react package
* feat(askai): Agent Studio core tools (#2886 )
* feat(askai): Implement dynamic tool calls
* move ToolCall to components dir
* Converge Agent Studio search tools to same definition, fix client side tools breaking UI state
* add examples for custom tools
* fix: lint & types
* feat(askai): add Agent Studio memory support (#2888 )
* feat(askai): remove Ask AI transport layer (#2889 )
* feat(askai): add Agent Studio memory support
* refactor(askai): remove Ask AI transport abstraction
* feat(askai): Feedback notes and tags (#2890 )
* feat(askai): add Agent Studio memory support
* refactor(askai): remove Ask AI transport abstraction
* feat(askai): Feedback notes and tags
* fix: bump css bundle size limit
* move feedback actions to components
* chore: fix deploys for v5 branch
* feat(askai): Aggregate MCP search tool calls (#2891 )
* feat(askai): add Agent Studio memory support
* refactor(askai): remove Ask AI transport abstraction
* feat(askai): Feedback notes and tags
* fix: bump css bundle size limit
* move feedback actions to components
* feat(askai): Aggregate MCP search tool calls
* feat(askai): Allow dynamic indices for Agent Studio (#2893 )
* feat(v5): UI updates (#2896 )
* feat(v5): UI updates
* fix: css file size
* fix: e2e tests
* fix: e2e tests
* fix: e2e tests
* chore: add theme toggle to react demo example
* Update sources panel display, update dark theme
* fix: lint
* fix(askai): address ui review feedback
* fix: pin icon positioning
* fix(askai): improve a11y and dark-mode shimmer for thinking and error states
- add role=alert/status and aria-hidden on error/thinking UI
- support dark-mode shimmer gradients via CSS variables
- respect prefers-reduced-motion for shimmer
- handle null date in useRelativeFormattedDate with fallback translation
* feat(v5): Add hit breadcrumbs (#2897 )
* feat(v5): UI updates
* fix: css file size
* fix: e2e tests
* fix: e2e tests
* fix: e2e tests
* chore: add theme toggle to react demo example
* Update sources panel display, update dark theme
* fix: lint
* fix(askai): address ui review feedback
* fix: pin icon positioning
* fix(askai): improve a11y and dark-mode shimmer for thinking and error states
- add role=alert/status and aria-hidden on error/thinking UI
- support dark-mode shimmer gradients via CSS variables
- respect prefers-reduced-motion for shimmer
- handle null date in useRelativeFormattedDate with fallback translation
* feat(v5): Add hit breadcrumbs
* fix: bump css bundle size limit
* Fix after conflicts
* chore: move CSS building to lightning css (#2898 )
* feat: Facet filters for search (#2899 )
* feat(v5): Initial facet filters work
* Perf updates, dark theme, facet chips, a11y improvements
* fix: bump css bundle size limit
* Dedupe facet filters, refetch facets on searchParameters changes
* Add chevron flourish
* fix(askai): Fix new conversation causing thread depth errors (#2900 )
* feat(v5): Add hit result badge (#2901 )
* feat(v5): Add hit result badge
* Add background to hit result badge
* feat(v5): Add follow up prompt suggestions (#2902 )
* feat(v5): Add follow up prompt suggestions
* fix: bump css bundle size limit
* docs(agents): document Cursor Cloud dev environment setup for v5 (Bun) (#2903 )
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
* feat(mcp): setup mcp plugins (#2895 )
* feat(v5): Add prompt suggestions to keyword search (#2912 )
* feat(v5): Add prompt suggestions to keyword search
* cleanup: Move consistent object to reusable constant
* chore(v5): Split Ask AI related CSS into own bundle (#2913 )
* chore(v5): Split Ask AI related CSS into own bundle
* move style.css to include modal and askai
* fix: Ensure stage level and watch level scripts use bun runtime (#2915 )
* fix: Ensure stage level and watch level scripts use bun runtime
* chore: move to node@24 update imports
* fix: lint
* feat(js): Document JS based hybrid mode, fix JS packages (#2916 )
* feat(js): Document JS based hybrid mode, fix JS packages
* update: add model onOpen to docs
* feat(cli): add @docsearch/cli for MCP setup and search (#2911 )
* chore(tsdown): Bump to latest tsdown version (#2918 )
* chore(tsdown): Bump to latest tsdown version
* fix: bump nvmrc node version
* fix: cli tsconfig
* fix: website build
* fix: example build
* fix: circleci install bun
* fix: lint
* fix: circleci install bun
* fix: circleci install bun
* fix: circleci install bun
* refactor(docusaurus-adapter): rework theme config for v5 and modularize SearchPage (#2904 )
Co-authored-by: Paul Jankowski <8BitTitan@gmail.com>
* feat(askai): Move askai related props under root askai (#2919 )
* feat(askai): Move askai related props under root askai
* fix: playwright test case
* fix(docusaurus): validate Ask AI options
* feat(js): Split JS bundles for search only (#2920 )
* chore: Move to oxlint and oxfmt (#2923 )
* chore: Get NPM OIDC token before publishing (#2924 )
* chore: Enter v5 beta (#2925 )
* chore: Enter pre release mode for v5
* chore: update release summary
* chore: version bump
* fix: Remove NPM_ID_TOKEN for release
* fix: Try setting blank NPM_TOKEN
* fix: Try blank NPM_AUTH_TOKEN
* chore: bump node and npm for release job
* docs(mcp): add service disclaimer (#2921 )
* fix: Agent Studio MCP search tool (#2927 )
* fix: Agent Studio MCP search tool
* Add changeset
* chore: Update stylelint (#2926 )
* chore: stylelint update
* bun.lock
* Add changeset
* fix(website): use bare @import for tailwindcss (#2933 )
Tailwind's build-time `@import` cannot be written with `url()` notation,
so `@import url('tailwindcss')` was passed through as a plain CSS import
instead of being processed by Tailwind.
Also syncs bun.lock with the 5.0.0-beta.0 versions already committed to
package.json.
* chore: version v5.0.0-beta.1 (#2932 )
* feat(react): remove deprecated index props (#2936 )
* feat(mcp): add ChatGPT and Codex DocSearch plugin package (#2938 )
* fix: cleanup claude
* feat: website redesign (#2930 )
Co-authored-by: Cursor <cursoragent@cursor.com>
* fix: lint
* fix: crash on the demo (#2940 )
* feat(docs): Document v5 beta (#2935 )
* chore(docs): v5 documentation
* Writing style clean up
* fix: website after conflicts
* fix: reported issues on mobile (#2944 )
* chore: Introduce a11y smoke tests (#2943 )
* chore: Add Lorris as codeowner (#2946 )
* fix(askai): Ask AI fixes for v5 (#2945 )
* fix: General v5 fixes (#2947 )
- Fix `ref` console error for a `FacetMenu`
- Whitespace only search/conversation input does not trigger requests
- Fix flash of no results page on search
* feat: v5 general improvements (#2948 )
* feat(v5): General fixes and improvements
* add changeset
* fix: bundlesize
* feat(v5): UI and DX improvements (#2949 )
* feat: Rename assistantId to agentId
* feat: Allow reading default facet values from index searchParameters
* feat: Remove indexName prop from Sidepanel, cleanup documentation pages
* feat: Move appId and apiKey up into @docsearch/core
* feat: Add back nested grouping of search results
* add changeset
* revert changes to example demo
* fix: e2e tests
* chore: push git tags on version release (#2951 )
* chore: release v5.0.0-beta.2 (#2950 )
* chore: Fix pushing git tags (#2953 )
* fix(askai): sanitize markdown HTML in v5 (#2954 )
Backport of #2929.\n\nOriginal commit: 681cbfec03#2958 )
* fix(v5): stop truncating mobile snippets
Backport of #2907.\n\nOriginal commit: 9ad6d169fe#2907 by overriding later v5 child-level truncation rules.\n\nOriginal commit: 9ad6d169fe9ad6d169fe#2952 )
* feat(v5): Add new footerAction prop
* Resolve PR comments
* fix(v5): recognize conversation depth errors (#2957 )
Backport of #2881.\n\nOriginal commit: f68e52251c#2956 )
* fix(v5): expose Sidepanel search parameter types
Backport of #2906.\n\nOriginal commit: 4710d0ca77#2955 )
Backport of #2871.\n\nOriginal commit: 0e41a78c44#2959 )
* fix(agentStudio): agents dynamic mode enabled
* fix(askai): use string[] for dynamic agentStudio indices
* feat(docs): add Ask AI to Agent Studio migration guide (#2931 )
* feat(docs): add Ask AI to Agent Studio migration guide
* feat(docs): agentStudio migrating from askAI
* feat(docs): renaming agentId
* feat(agentStudio): dynamic mode indices updated
* fix: Docusaurus adapter styling, DocSearch website fixes (#2960 )
* chore: release v5.0.0-beta.3 (#2961 )
* feat(website): Launch updates (#2964 )
* fix(website): Fix font loading (#2966 )
* feat(v5): Back port cost control errors (#2965 )
* chore: release v5.0.0-beta.4 (#2967 )
---------
Co-authored-by: Vincent Lemeunier <vincentlemeunier+git@gmail.com>
Co-authored-by: Dylan Tientcheu <dylan.tientcheu@algolia.com>
Co-authored-by: Lorris Saint-Genez <lorrissaintgenez@gmail.com>
Co-authored-by: Cursor Agent <cursoragent@cursor.com>
Co-authored-by: Dylan Tientcheu <dylantientcheu@gmail.com>
Co-authored-by: Vasco Bettencourt <32492444+vascobettencourt@users.noreply.github.com>
Co-authored-by: Divyansh Singh <40380293+brc-dd@users.noreply.github.com>
Co-authored-by: Felipe Bermudez <felipeberm@gmail.com>
Co-authored-by: Sigmabro <122412346+Sigmabrogz@users.noreply.github.com>
2026-08-06 15:31:45 -04:00
Kim Pohas
047a769791
fix(docs): fix spelling, grammar, and formatting across docs ( #2882 )
...
- Fix typos and grammar across 18 docs files (curly apostrophe in code
sample, verb agreement, possessives, missing punctuation, etc.)
- Capitalize proper nouns: JavaScript, DocSearch, Ask AI, LLM, Starlight
- Fix code sample syntax: missing trailing comma in record-extractor,
missing semicolon in sidepanel advanced-use-cases
- Add missing Solution paragraph to AI-211 error entry in askai-errors
- Remove trailing colons from section headings (api.mdx, api-reference.mdx)
- Fix internal link in askai-markdown-indexing (.mdx extension removed)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-18 12:10:06 -04:00
Dylan Tientcheu
a069544286
chore: add documentation for agentStudio searchParameters object ( #2870 )
2026-03-24 16:24:21 +01:00
Paul Jankowski
ffa2835194
feat(askai): Allow use of Agent Studio for chat backend ( #2832 )
...
* feat(askai): Allow use of Agent Studio for chat backend
* feat(askai): Remove feedback actions if using Agent Studio
* feat(askai): Document agentStudio param
* Remove module resolution
* Update packages/website/docs/api.mdx
Co-authored-by: Dylan Tientcheu <dylan.tientcheu@algolia.com>
* Use css var for sidepanel button background
---------
Co-authored-by: Natan Yagudayev <natanyagudayev@gmail.com>
Co-authored-by: Dylan Tientcheu <dylan.tientcheu@algolia.com>
2026-01-13 10:58:11 -05:00
Paul Jankowski
e5ae33fe90
feat(composable-api): Document Composable API ( #2793 )
2025-11-04 09:40:05 -05:00
Paul Jankowski
2b4779ad06
feat(suggested-questions): Add suggested questions ( #2787 )
...
* feat(suggested-questions): Add suggested questions
* fix: build
* add docs, fix react-example
* add some more documentation
2025-10-28 14:31:44 -04:00
Vasco Bettencourt
5381e76126
fix(docsearch-js): resultsFooterComponent not working in JS CDN version ( #2786 )
...
* fix: resultsFooterComponent not working in JS CDN version
* fix: ci
* feat: implement htm templates
* fix: ci
* fix
* fix
* fix: ci
* fix: types
* fix: rollup
* fix: ci
* fix
* feat: add hitComponent updated docs
* fix: formatting
2025-10-15 09:57:00 +01:00
Paul Jankowski
8980d47dbc
fix(website): Fix API Reference docs page formatting ( #2783 )
2025-10-08 14:00:20 -04:00
Vasco Bettencourt
9986cbf426
feat: update Ask AI docs ( #2775 )
...
* feat: add link to Ask AI Algolia docs
* docs: add dual SDK support to Ask AI API docs
* fix: ci
* docs: uniformize Ask AI copy
* fix
2025-10-05 23:43:03 +01:00
Vasco Bettencourt
d8ad7f6d5f
feat: curate AskAI search parameters ( #2768 )
...
* feat: curate AskAI search parameters
* fix
* fix docs
* fix
* fix: remove attributesToSnippet
* fix
---------
Co-authored-by: Dylan Tientcheu <dylan.tientcheu@algolia.com>
2025-09-24 19:40:08 +01:00
Paul Jankowski
0267f55453
feat: Modal and AskAI UX tweaks ( #2765 )
...
* feat: UX tweaks for Modal
* Prepare new conversation screen to accept suggested questions
* Add conversation history screen
* Reset basic askai config
* Reset askai api url
* Document new translations
* Remove unused CSS
* Add translation for stopped streaming text
* Add rest of translations
* Bump allowed bundle size
* Bump allowed bundle size
2025-09-23 11:44:23 -04:00
Dylan Tientcheu
6921e7225a
chore: Promote DocSearch v4 from Beta to Stable ( #2752 )
...
Co-authored-by: Paul Jankowski <8BitTitan@gmail.com>
Co-authored-by: Paul Jankowski <33367713+8bittitan@users.noreply.github.com>
2025-09-15 16:41:59 +02:00
Greg Brimble
5be3e846a9
Add keyboardShortcuts property to allow users to customize shortcuts ( #2740 )
...
Co-authored-by: Paul Jankowski <33367713+8bittitan@users.noreply.github.com>
2025-09-04 09:05:08 -04:00
Paul Jankowski
905e26d693
feat(v4): Add support for multi-index search ( #2736 )
...
* feat(v4): Add support for multi-index search
* feat(docs): Document new indices property and mark indeName and searchParameters as deprecated
---------
Co-authored-by: Dylan Tientcheu <dylan.tientcheu@algolia.com>
2025-09-02 11:18:38 -04:00
Dylan Tientcheu
d5c9c527d7
feat: a11y and ux tweaks ( #2712 )
...
Co-authored-by: Natan Yagudayev <natanyagudayev@gmail.com>
2025-08-14 20:04:30 +02:00
Paul Jankowski
95af410f82
feat: Add recent searches limit param ( #2704 )
2025-08-07 12:39:25 -04:00
Natan Yagudayev
4210e3b503
feat(docs): added tips for facetFilters ( #2680 )
2025-07-23 10:08:04 -04:00
Dylan Tientcheu
55e3eb301c
feat(askai): add facet filtering ( #2676 )
2025-07-22 11:28:18 +02:00
Dylan Tientcheu
19c1ef9192
feat(v4): release v4 ( #2555 ) ( #2666 )
...
* feat(v4): add new UI (#2555 )
* feat: add new footer ui
* feat: add new search box ui
* feat: add searchbox actions
* feat: add start screen
* feat: add no results screen
* feat: add new card ui
* feat: add new icons
* feat: add new key press class
* fix: cypress tests
* fix: circleci
* fix: circleci
* fix: close aria label
* fix: circleci
* fix: remove unused classes
* fix: circleci
* feat: update version
* feat: add new dark mode ui
* fix: colors
* fix: design review
* fix: hit title length
* fix: improve accessibility
* fix: ci
* chore: increase bundle size threshold
* fix: css
* feat(v4): ask-ai foundations ✨ (#2574 )
* feat(v4): docsearch askAI context (#2587 )
* fix(v4): ask ai updates (#2654 )
* feat(v4): update beta documentation (#2659 )
* chore: release v4.0.0-beta.0 (#2660 )
* fix: make release run on branches like v4
* chore: release v4.0.0-beta.0
* hotfix: closing on askai error
* chore: release v4.0.0-beta.1 (#2661 )
* fix: add a section on models
* fix: update to `<package>@beta`
* feat(docsearch-website): Updated docs (#2662 )
* feat(v4): update the landing page (#2665 )
* fix: beta in readme
* feat: added glow around the search bar and a little copy above the keyboard
* feat: add glow around the search bar and copy above the keyboard
* fix: Add more styling
* fix: polishing v4 (#2667 )
* chore: release v4.0.0-beta.2 (#2668 )
* fix: update docusaurus tarballs
* fix(website): update docusaurus tarballs
* fix: mobile search bar
---------
Co-authored-by: Vasco Bettencourt <32492444+vascobettencourt@users.noreply.github.com>
Co-authored-by: Natan Yagudayev <natanyagudayev@gmail.com>
2025-07-17 15:53:46 +02:00
NiteshSingh17
85568ce095
feat: add theme prop ( #2651 )
...
Co-authored-by: Dylan Tientcheu <dylantientcheu@gmail.com>
2025-07-08 20:05:25 +02:00
Pierre Millot
08d9a37807
fix(types): use a minimal type for transformSearchClient ( #2348 )
2024-11-12 16:15:02 +01:00
Pierre Millot
93578a4de0
fix: upgrade algoliasearch to v5 ( #2326 )
...
We can use the new generated client to stay up to date and upgrade packages that depends on docsearch.
---------
Co-authored-by: shortcuts <vannicattec@gmail.com>
2024-10-30 15:46:38 +01:00
Heather Buchel
df60b8ebe8
fix: add accessible label to SearchBox input ( #2193 )
2024-02-28 11:14:04 +01:00
Julius
fbe746c38c
docs: add missing backtick to placeholder default example ( #2097 )
2023-10-12 08:47:17 +02:00
Shane Afsar
066539c2c9
docs(api): add maxResultsPerGroup ( #1897 )
2023-05-25 16:16:04 -04:00
Clément Vannicatte
d0d866ce6c
docs: remove duplicate links in API toc ( #1494 )
2022-08-09 09:24:59 +02:00
Clément Vannicatte
142fd13e8f
chore: rename next branch to main ( #1478 )
2022-08-02 17:49:20 +02:00
Clément Vannicatte
1219a68b67
docs: document recordVersion ( #1380 )
2022-04-26 13:12:47 +02:00
Sarah German
9cc9801f6f
docs: document resultsFooterComponent ( #1379 )
...
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
2022-04-26 09:30:04 +02:00
Clément Vannicatte
59a3ebf5ec
fix(footer): make SVG accessible ( #1306 )
2022-02-22 10:53:16 +01:00
Clément Vannicatte
2c1fe7c77c
feat(noResults): allow providing URL to report missing results ( #1289 )
2022-02-02 10:39:44 +01:00
Clément Vannicatte
ef13dea393
feat(translations): expose Button and Modal translations ( #1183 )
2021-11-22 14:24:07 +01:00
Peter Etelej
f626552fb7
docs(website): Fix invalid links to legacy docs ( #1055 )
2021-10-11 10:17:27 +02:00
Clément Vannicatte
9a89cde746
feat(website): new documentation ( #1048 )
2021-10-07 12:27:45 +02:00
