diff --git a/.changeset/config.json b/.changeset/config.json index 7590bcd4..4853d3df 100644 --- a/.changeset/config.json +++ b/.changeset/config.json @@ -16,7 +16,7 @@ ], "linked": [], "access": "public", - "baseBranch": "v5", + "baseBranch": "main", "updateInternalDependencies": "patch", "ignore": [ "@docsearch/website", diff --git a/README.md b/README.md index 92edd88b..d20c2b8b 100644 --- a/README.md +++ b/README.md @@ -33,15 +33,15 @@ DocSearch crawls your documentation, pushes the content to an Algolia index and #### Installation ```sh -bun add @docsearch/js@4 +bun add @docsearch/js@5 # or -npm install @docsearch/js@4 +npm install @docsearch/js@5 ``` If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` #### Get started @@ -74,15 +74,15 @@ docsearch({ #### Installation ```bash -bun add @docsearch/react@4 +bun add @docsearch/react@5 # or -npm install @docsearch/react@4 +npm install @docsearch/react@5 ``` If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` #### Get started diff --git a/packages/docsearch-css/README.md b/packages/docsearch-css/README.md index ad61bc7c..742ab655 100644 --- a/packages/docsearch-css/README.md +++ b/packages/docsearch-css/README.md @@ -5,13 +5,13 @@ Style package for [DocSearch](http://docsearch.algolia.com/), the best search ex ## Installation ```bash -npm install @docsearch/css@4 +npm install @docsearch/css@5 ``` If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` ## Get started @@ -22,4 +22,4 @@ import '@docsearch/css'; ## Documentation -[Read documentation →](https://docsearch.algolia.com/docs/styling) +[Read documentation →](https://docsearch.algolia.com/docs/packages/css/styling) diff --git a/packages/docsearch-js/README.md b/packages/docsearch-js/README.md index c9cd6f8c..9fdc8308 100644 --- a/packages/docsearch-js/README.md +++ b/packages/docsearch-js/README.md @@ -76,4 +76,4 @@ Both UMD entries expose callable `window.docsearch`. Load only one of them: the ## Documentation -[Read documentation →](https://docsearch.algolia.com/docs/docsearch-v3) +[Read documentation →](https://docsearch.algolia.com/docs/packages/js/getting-started) diff --git a/packages/docsearch-react/README.md b/packages/docsearch-react/README.md index e411af8a..34069867 100644 --- a/packages/docsearch-react/README.md +++ b/packages/docsearch-react/README.md @@ -5,13 +5,13 @@ React package for [DocSearch](http://docsearch.algolia.com/), the best search ex ## Installation ```bash -npm install @docsearch/react@4 +npm install @docsearch/react@5 ``` If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` ## Get started @@ -38,4 +38,4 @@ export default App; ## Documentation -[Read documentation →](https://docsearch.algolia.com/docs/docsearch-v3) +[Read documentation →](https://docsearch.algolia.com/docs/packages/react/getting-started) diff --git a/packages/docsearch-sidepanel-js/README.md b/packages/docsearch-sidepanel-js/README.md index 95097ac7..822b4012 100644 --- a/packages/docsearch-sidepanel-js/README.md +++ b/packages/docsearch-sidepanel-js/README.md @@ -13,7 +13,7 @@ npm install @docsearch/sidepanel-js If you don’t want to use a package manager, you can use a standalone endpoint: ```html - + ``` To get started, you need a [`container`](https://docsearch.algolia.com/docs/api#container) for your DocSearch Sidepanel component to go in. If you don’t have one already, you can insert one into your markup: @@ -36,10 +36,10 @@ sidepanel({ indexName: 'YOUR_INDEX_NAME', appId: 'YOUR_APP_ID', apiKey: 'YOUR_SEARCH_API_KEY', - assistantId: 'YOUR_ASSISTANT_ID', + agentId: 'YOUR_AGENT_ID', }); ``` ## Documentation -[Read documentation →](https://docsearch.algolia.com) +[Read documentation →](https://docsearch.algolia.com/docs/packages/sidepanel-js/getting-started) diff --git a/packages/docsearch-sidepanel/README.md b/packages/docsearch-sidepanel/README.md index 3880324a..e3908c1b 100644 --- a/packages/docsearch-sidepanel/README.md +++ b/packages/docsearch-sidepanel/README.md @@ -6,7 +6,7 @@ React package for [DocSearch Sidepanel](http://docsearch.algolia.com/), a standa ```bash # or -npm install @docsearch/core@4 @docsearch/sidepanel@4 @docsearch/css@4 +npm install @docsearch/core@5 @docsearch/sidepanel@5 @docsearch/css@5 ``` If you don’t want to use a package manager, you can use a standalone endpoint: @@ -37,7 +37,7 @@ function App() { ); @@ -46,4 +46,4 @@ function App() { ## Documentation -[Read documentation →](https://docsearch.algolia.com) +[Read documentation →](https://docsearch.algolia.com/docs/packages/sidepanel/getting-started) diff --git a/packages/website/WRITING_GUIDE.md b/packages/website/WRITING_GUIDE.md index ae2aff81..cd41881a 100644 --- a/packages/website/WRITING_GUIDE.md +++ b/packages/website/WRITING_GUIDE.md @@ -19,7 +19,6 @@ ## Version references -- When referencing installing a `v5` package, MUST use the caret (`^`) based versioning: `@^5.0.0-beta` - When displaying install commands, ONLY include `@docsearch/*` packages, there's no need to include any other packages unless specified ## Pages diff --git a/packages/website/docs/agent-studio/getting-started.mdx b/packages/website/docs/agent-studio/getting-started.mdx index 84e0a0e2..43c87686 100644 --- a/packages/website/docs/agent-studio/getting-started.mdx +++ b/packages/website/docs/agent-studio/getting-started.mdx @@ -30,28 +30,28 @@ Install the React package and styles: ```bash -npm install @docsearch/react@^5.0.0-beta @docsearch/css@^5.0.0-beta +npm install @docsearch/react@^5 @docsearch/css@^5 ``` ```bash -yarn add @docsearch/react@^5.0.0-beta @docsearch/css@^5.0.0-beta +yarn add @docsearch/react@^5 @docsearch/css@^5 ``` ```bash -pnpm add @docsearch/react@^5.0.0-beta @docsearch/css@^5.0.0-beta +pnpm add @docsearch/react@^5 @docsearch/css@^5 ``` ```bash -bun add @docsearch/react@^5.0.0-beta @docsearch/css@^5.0.0-beta +bun add @docsearch/react@^5 @docsearch/css@^5 ``` @@ -88,28 +88,28 @@ Install the JavaScript package and styles: ```bash -npm install @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +npm install @docsearch/js@^5 @docsearch/css@^5 ``` ```bash -yarn add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +yarn add @docsearch/js@^5 @docsearch/css@^5 ``` ```bash -pnpm add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +pnpm add @docsearch/js@^5 @docsearch/css@^5 ``` ```bash -bun add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +bun add @docsearch/js@^5 @docsearch/css@^5 ``` diff --git a/packages/website/docs/composable-api.mdx b/packages/website/docs/composable-api.mdx index 25eaff3f..71e6a3cb 100644 --- a/packages/website/docs/composable-api.mdx +++ b/packages/website/docs/composable-api.mdx @@ -35,28 +35,28 @@ Install matching v5 versions of the DocSearch packages: ```bash -npm install @docsearch/core@^5.0.0-beta @docsearch/modal@^5.0.0-beta @docsearch/css@^5.0.0-beta +npm install @docsearch/core@^5 @docsearch/modal@^5 @docsearch/css@^5 ``` ```bash -yarn add @docsearch/core@^5.0.0-beta @docsearch/modal@^5.0.0-beta @docsearch/css@^5.0.0-beta +yarn add @docsearch/core@^5 @docsearch/modal@^5 @docsearch/css@^5 ``` ```bash -pnpm add @docsearch/core@^5.0.0-beta @docsearch/modal@^5.0.0-beta @docsearch/css@^5.0.0-beta +pnpm add @docsearch/core@^5 @docsearch/modal@^5 @docsearch/css@^5 ``` ```bash -bun add @docsearch/core@^5.0.0-beta @docsearch/modal@^5.0.0-beta @docsearch/css@^5.0.0-beta +bun add @docsearch/core@^5 @docsearch/modal@^5 @docsearch/css@^5 ``` diff --git a/packages/website/docs/hybrid-mode.mdx b/packages/website/docs/hybrid-mode.mdx index 41172847..936d7271 100644 --- a/packages/website/docs/hybrid-mode.mdx +++ b/packages/website/docs/hybrid-mode.mdx @@ -54,28 +54,28 @@ Install the connected React packages and CSS: ```bash -npm install @docsearch/core@^5.0.0-beta @docsearch/modal@^5.0.0-beta @docsearch/sidepanel@^5.0.0-beta @docsearch/css@^5.0.0-beta +npm install @docsearch/core@^5 @docsearch/modal@^5 @docsearch/sidepanel@^5 @docsearch/css@^5 ``` ```bash -yarn add @docsearch/core@^5.0.0-beta @docsearch/modal@^5.0.0-beta @docsearch/sidepanel@^5.0.0-beta @docsearch/css@^5.0.0-beta +yarn add @docsearch/core@^5 @docsearch/modal@^5 @docsearch/sidepanel@^5 @docsearch/css@^5 ``` ```bash -pnpm add @docsearch/core@^5.0.0-beta @docsearch/modal@^5.0.0-beta @docsearch/sidepanel@^5.0.0-beta @docsearch/css@^5.0.0-beta +pnpm add @docsearch/core@^5 @docsearch/modal@^5 @docsearch/sidepanel@^5 @docsearch/css@^5 ``` ```bash -bun add @docsearch/core@^5.0.0-beta @docsearch/modal@^5.0.0-beta @docsearch/sidepanel@^5.0.0-beta @docsearch/css@^5.0.0-beta +bun add @docsearch/core@^5 @docsearch/modal@^5 @docsearch/sidepanel@^5 @docsearch/css@^5 ``` @@ -196,28 +196,28 @@ The JavaScript packages create independent DocSearch and Sidepanel instances. Co ```bash -npm install @docsearch/js@^5.0.0-beta @docsearch/sidepanel-js@^5.0.0-beta @docsearch/css@^5.0.0-beta +npm install @docsearch/js@^5 @docsearch/sidepanel-js@^5 @docsearch/css@^5 ``` ```bash -yarn add @docsearch/js@^5.0.0-beta @docsearch/sidepanel-js@^5.0.0-beta @docsearch/css@^5.0.0-beta +yarn add @docsearch/js@^5 @docsearch/sidepanel-js@^5 @docsearch/css@^5 ``` ```bash -pnpm add @docsearch/js@^5.0.0-beta @docsearch/sidepanel-js@^5.0.0-beta @docsearch/css@^5.0.0-beta +pnpm add @docsearch/js@^5 @docsearch/sidepanel-js@^5 @docsearch/css@^5 ``` ```bash -bun add @docsearch/js@^5.0.0-beta @docsearch/sidepanel-js@^5.0.0-beta @docsearch/css@^5.0.0-beta +bun add @docsearch/js@^5 @docsearch/sidepanel-js@^5 @docsearch/css@^5 ``` @@ -327,28 +327,28 @@ Install the adapter and keep `@docusaurus/preset-classic`: ```bash -npm install @docsearch/docusaurus-adapter@^5.0.0-beta +npm install @docsearch/docusaurus-adapter@^5 ``` ```bash -yarn add @docsearch/docusaurus-adapter@^5.0.0-beta +yarn add @docsearch/docusaurus-adapter@^5 ``` ```bash -pnpm add @docsearch/docusaurus-adapter@^5.0.0-beta +pnpm add @docsearch/docusaurus-adapter@^5 ``` ```bash -bun add @docsearch/docusaurus-adapter@^5.0.0-beta +bun add @docsearch/docusaurus-adapter@^5 ``` @@ -434,7 +434,7 @@ Import both `style.css` and `sidepanel.css`. Check that your bundler includes CS ### Docusaurus rejects the configuration -Use `themeConfig.docsearch`, pass `askAi` as an object, and put `sidePanel` beside `askAi`. Install `@docsearch/docusaurus-adapter@^5.0.0-beta` instead of configuring hybrid mode through the built-in Algolia theme. +Use `themeConfig.docsearch`, pass `askAi` as an object, and put `sidePanel` beside `askAi`. Install `@docsearch/docusaurus-adapter@^5` instead of configuring hybrid mode through the built-in Algolia theme. ### Server rendering fails with `window` or `document` errors diff --git a/packages/website/docs/migrating-from-v4.mdx b/packages/website/docs/migrating-from-v4.mdx index fd631f55..4c81158a 100644 --- a/packages/website/docs/migrating-from-v4.mdx +++ b/packages/website/docs/migrating-from-v4.mdx @@ -1,6 +1,6 @@ --- title: Migrate from DocSearch v4 -description: Move a DocSearch v4 integration to the 5.0.0 beta packages and Agent Studio APIs. +description: Move a DocSearch v4 integration to the v5 and Agent Studio APIs. --- import TabItem from '@theme/TabItem'; @@ -12,7 +12,7 @@ Review the complete [v5 breaking changes](./v5-breaking-changes) before releasin ## 1. Upgrade the beta packages -Upgrade every DocSearch package in the integration together with the `^5.0.0-beta` range. +Upgrade every DocSearch package in the integration together with the `^5` range. @@ -21,28 +21,28 @@ Upgrade every DocSearch package in the integration together with the `^5.0.0-bet ```bash -npm install @docsearch/react@^5.0.0-beta @docsearch/css@^5.0.0-beta +npm install @docsearch/react@^5 @docsearch/css@^5 ``` ```bash -yarn add @docsearch/react@^5.0.0-beta @docsearch/css@^5.0.0-beta +yarn add @docsearch/react@^5 @docsearch/css@^5 ``` ```bash -pnpm add @docsearch/react@^5.0.0-beta @docsearch/css@^5.0.0-beta +pnpm add @docsearch/react@^5 @docsearch/css@^5 ``` ```bash -bun add @docsearch/react@^5.0.0-beta @docsearch/css@^5.0.0-beta +bun add @docsearch/react@^5 @docsearch/css@^5 ``` @@ -55,28 +55,28 @@ bun add @docsearch/react@^5.0.0-beta @docsearch/css@^5.0.0-beta ```bash -npm install @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +npm install @docsearch/js@^5 @docsearch/css@^5 ``` ```bash -yarn add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +yarn add @docsearch/js@^5 @docsearch/css@^5 ``` ```bash -pnpm add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +pnpm add @docsearch/js@^5 @docsearch/css@^5 ``` ```bash -bun add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +bun add @docsearch/js@^5 @docsearch/css@^5 ``` @@ -85,7 +85,7 @@ bun add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta -If you use the Composable API or Sidepanel, also upgrade `@docsearch/core@^5.0.0-beta`, `@docsearch/modal@^5.0.0-beta`, `@docsearch/sidepanel@^5.0.0-beta`, or `@docsearch/sidepanel-js@^5.0.0-beta`. +If you use the Composable API or Sidepanel, also upgrade `@docsearch/core@^5`, `@docsearch/modal@^5`, `@docsearch/sidepanel@^5`, or `@docsearch/sidepanel-js@^5`. ## 2. Choose keyword-only or AI-capable search @@ -106,7 +106,7 @@ For a CDN integration, replace the root bundle with the keyword-only UMD file: ```diff title="index.html" - -+ ++ ``` ### JavaScript with Ask AI @@ -168,16 +168,15 @@ Replace `DocSearch` with `DocSearchAI`: ## 3. Move Ask AI to Agent Studio -V5 removes the legacy Ask AI token and chat transport. Create the assistant in [Agent Studio](/docs/agent-studio/getting-started) before switching production traffic. If you already have an Ask AI assistant, follow [Migrate Ask AI to Agent Studio](/docs/agent-studio/migrate-to-agent-studio). +V5 removes the legacy Ask AI token and chat transport. Create the agent in [Agent Studio](/docs/agent-studio/getting-started) before switching production traffic. If you already have an Ask AI assistant, follow [Migrate Ask AI to Agent Studio](/docs/agent-studio/migrate-to-agent-studio). -Rename `assistantId` to `agentId`. Remove `agentStudio` and `useStagingEnv` from `askAi`. Agent Studio is the only Ask AI backend in v5. +Rename `assistantId` to `agentId`. Remove `agentStudio` from `askAi`. Agent Studio is the only Ask AI backend in v5. ```diff title="app.js" askAi: { - assistantId: 'YOUR_ASSISTANT_ID', + agentId: 'YOUR_AGENT_ID', - agentStudio: true, -- useStagingEnv: false, } ``` diff --git a/packages/website/docs/packages/core/overview.mdx b/packages/website/docs/packages/core/overview.mdx index 0dfad6df..56dd1afb 100644 --- a/packages/website/docs/packages/core/overview.mdx +++ b/packages/website/docs/packages/core/overview.mdx @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; :::info v5 beta -These instructions use the `^5.0.0-beta` range. +These instructions use the `^5` range. ::: @@ -20,28 +20,28 @@ These instructions use the `^5.0.0-beta` range. ```bash -npm install @docsearch/core@^5.0.0-beta +npm install @docsearch/core@^5 ``` ```bash -yarn add @docsearch/core@^5.0.0-beta +yarn add @docsearch/core@^5 ``` ```bash -pnpm add @docsearch/core@^5.0.0-beta +pnpm add @docsearch/core@^5 ``` ```bash -bun add @docsearch/core@^5.0.0-beta +bun add @docsearch/core@^5 ``` diff --git a/packages/website/docs/packages/css/bundle-exports.mdx b/packages/website/docs/packages/css/bundle-exports.mdx index b59cc7a8..667b4756 100644 --- a/packages/website/docs/packages/css/bundle-exports.mdx +++ b/packages/website/docs/packages/css/bundle-exports.mdx @@ -57,7 +57,7 @@ The Sidepanel reuses Agent Studio response and Markdown classes from the root bu ```html title="index.html" ``` @@ -66,7 +66,7 @@ Add the Sidepanel asset when needed: ```html title="index.html" ``` diff --git a/packages/website/docs/packages/css/styling.mdx b/packages/website/docs/packages/css/styling.mdx index 600409cb..4045bf01 100644 --- a/packages/website/docs/packages/css/styling.mdx +++ b/packages/website/docs/packages/css/styling.mdx @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; :::info v5 beta -These instructions use the `^5.0.0-beta` range. +These instructions use the `^5` range. ::: @@ -20,28 +20,28 @@ These instructions use the `^5.0.0-beta` range. ```bash -npm install @docsearch/css@^5.0.0-beta +npm install @docsearch/css@^5 ``` ```bash -yarn add @docsearch/css@^5.0.0-beta +yarn add @docsearch/css@^5 ``` ```bash -pnpm add @docsearch/css@^5.0.0-beta +pnpm add @docsearch/css@^5 ``` ```bash -bun add @docsearch/css@^5.0.0-beta +bun add @docsearch/css@^5 ``` diff --git a/packages/website/docs/packages/docusaurus-adapter/getting-started.mdx b/packages/website/docs/packages/docusaurus-adapter/getting-started.mdx index 7523afb2..cef4b875 100644 --- a/packages/website/docs/packages/docusaurus-adapter/getting-started.mdx +++ b/packages/website/docs/packages/docusaurus-adapter/getting-started.mdx @@ -21,34 +21,34 @@ Use Node.js 20 or later, Docusaurus 3.10.2 or later in the Docusaurus 3 release ## Install the adapter -Install `@docsearch/docusaurus-adapter@^5.0.0-beta`: +Install `@docsearch/docusaurus-adapter@^5`: ```bash -npm install @docsearch/docusaurus-adapter@^5.0.0-beta +npm install @docsearch/docusaurus-adapter@^5 ``` ```bash -yarn add @docsearch/docusaurus-adapter@^5.0.0-beta +yarn add @docsearch/docusaurus-adapter@^5 ``` ```bash -pnpm add @docsearch/docusaurus-adapter@^5.0.0-beta +pnpm add @docsearch/docusaurus-adapter@^5 ``` ```bash -bun add @docsearch/docusaurus-adapter@^5.0.0-beta +bun add @docsearch/docusaurus-adapter@^5 ``` diff --git a/packages/website/docs/packages/docusaurus-adapter/migrating-from-v4.mdx b/packages/website/docs/packages/docusaurus-adapter/migrating-from-v4.mdx index 598d2df2..65693554 100644 --- a/packages/website/docs/packages/docusaurus-adapter/migrating-from-v4.mdx +++ b/packages/website/docs/packages/docusaurus-adapter/migrating-from-v4.mdx @@ -16,34 +16,34 @@ Upgrade the site to Node.js 20 or later and Docusaurus 3.10.2 or later in the Do ## 2. Install the v5 adapter -Install `@docsearch/docusaurus-adapter@^5.0.0-beta`: +Install `@docsearch/docusaurus-adapter@^5`: ```bash -npm install @docsearch/docusaurus-adapter@^5.0.0-beta +npm install @docsearch/docusaurus-adapter@^5 ``` ```bash -yarn add @docsearch/docusaurus-adapter@^5.0.0-beta +yarn add @docsearch/docusaurus-adapter@^5 ``` ```bash -pnpm add @docsearch/docusaurus-adapter@^5.0.0-beta +pnpm add @docsearch/docusaurus-adapter@^5 ``` ```bash -bun add @docsearch/docusaurus-adapter@^5.0.0-beta +bun add @docsearch/docusaurus-adapter@^5 ``` diff --git a/packages/website/docs/packages/js/api-reference.mdx b/packages/website/docs/packages/js/api-reference.mdx index 511c9364..6c169bca 100644 --- a/packages/website/docs/packages/js/api-reference.mdx +++ b/packages/website/docs/packages/js/api-reference.mdx @@ -1,6 +1,6 @@ --- title: JS package API reference -description: Configure @docsearch/js 5.0.0-beta.0 and control its returned instance. +description: Configure @docsearch/js 5 and control its returned instance. toc_max_heading_level: 2 --- diff --git a/packages/website/docs/packages/js/getting-started.mdx b/packages/website/docs/packages/js/getting-started.mdx index 9bbfcf29..c8bde0d1 100644 --- a/packages/website/docs/packages/js/getting-started.mdx +++ b/packages/website/docs/packages/js/getting-started.mdx @@ -18,28 +18,28 @@ Collect your Algolia application ID, Search API key, and index name. To add Ask ```bash -npm install @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +npm install @docsearch/js@^5 @docsearch/css@^5 ``` ```bash -yarn add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +yarn add @docsearch/js@^5 @docsearch/css@^5 ``` ```bash -pnpm add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +pnpm add @docsearch/js@^5 @docsearch/css@^5 ``` ```bash -bun add @docsearch/js@^5.0.0-beta @docsearch/css@^5.0.0-beta +bun add @docsearch/js@^5 @docsearch/css@^5 ``` @@ -101,9 +101,9 @@ Load the complete stylesheet and one JavaScript bundle. Both UMD bundles expose ```html title="index.html" - + + +