AI driven algolia search

astro.config.mjs

@@ -7,6 +7,7 @@ import vue from '@astrojs/vue'
 import starlightSidebarTopics from 'starlight-sidebar-topics'
 import starlightImageZoom from 'starlight-image-zoom'
 import { pluginCollapsibleSections } from '@expressive-code/plugin-collapsible-sections'
+import starlightDocSearch from '@astrojs/starlight-docsearch'
 import starlightContextualMenu from 'starlight-contextual-menu'
 import starlightThemeNova from 'starlight-theme-nova'
 import starlightVideos from 'starlight-videos'
@@ -53,18 +54,6 @@ export default defineConfig({
       editLink: {
         baseUrl: 'https://github.com/scalekit-inc/developer-docs/edit/main',
       },
-      pagefind: {
-        rootSelector: 'body',
-        mergeIndex: [
-          // {
-          //   bundlePath: '/apis',
-          //   indexWeight: 1.5, // Give API reference slightly higher weight in search results
-          //   mergeFilter: {
-          //     resource: 'API Reference',
-          //   },
-          // },
-        ],
-      },
       expressiveCode: {
         useStarlightDarkModeSwitch: true,
         // themes: ['vitesse-dark', 'vitesse-light'],
@@ -87,6 +76,12 @@ export default defineConfig({
           showCaptions: true,
         }),
         starlightSidebarTopics(sidebarConfig, { topics, exclude }),
+        starlightDocSearch({
+          appId: '7554BDRAJD',
+          apiKey: 'b2fecf525a556f05d46ef2389ad7e4b6',
+          indexName: 'scalekit-starlight-crawler',
+          askAi: '8jKZkVuXS0hG',
+        }),
         starlightVideos(),
         starlightLinksValidator({
           exclude: ['/apis/**'],

package.json

@@ -21,6 +21,7 @@
     "@astrojs/netlify": "^6.6.3",
     "@astrojs/react": "^4.4.2",
     "@astrojs/starlight": "^0.37.1",
+    "@astrojs/starlight-docsearch": "file:./vendor/docsearch",
     "@astrojs/starlight-tailwind": "^4.0.2",
     "@astrojs/tailwind": "^6.0.2",
     "@astrojs/vue": "^5.1.3",
@@ -68,5 +69,10 @@
     "prettier-plugin-tailwindcss": "^0.6.14",
     "pretty-quick": "^4.2.2",
     "simple-git-hooks": "^2.13.1"
+  },
+  "pnpm": {
+    "overrides": {
+      "@astrojs/starlight-docsearch": "file:./vendor/docsearch"
+    }
   }
 }

project-docs/DOCSEARCH_V4_MIGRATION.md

@@ -0,0 +1,88 @@
+# DocSearch v4 Migration Guide
+
+This document explains the temporary setup for using DocSearch v4 before the official release.
+
+## Current Setup
+
+We are using DocSearch v4 from a fork of the Starlight project:
+
+- **Source**: `https://github.com/dylantientcheu/starlight` (PR #3346)
+- **Local clone**: `vendor/docsearch/` (committed to repo)
+- **Override location**: `package.json` → `pnpm.overrides`
+
+The vendor folder contains only the docsearch package (~44KB) with DocSearch v4 support.
+
+## How to Update to Official Release
+
+When `@astrojs/starlight-docsearch` officially releases DocSearch v4 support:
+
+### Step 1: Remove the override
+
+In `package.json`:
+
+```diff
+{
+  "dependencies": {
+-   "@astrojs/starlight-docsearch": "file:./vendor/docsearch",
++   "@astrojs/starlight-docsearch": "^0.7.0",  // or whatever version is released
+  },
+- "pnpm": {
+-   "overrides": {
+-     "@astrojs/starlight-docsearch": "file:./vendor/docsearch"
+-   }
+- }
+}
+```
+
+### Step 2: Install the official version
+
+```bash
+pnpm install
+```
+
+### Step 3: Clean up (optional)
+
+Remove the vendor folder:
+
+```bash
+rm -rf vendor/docsearch
+```
+
+## How to Update the Fork Manually
+
+To pull the latest changes from the fork:
+
+```bash
+# Clone to temp
+git clone --depth 1 --branch main https://github.com/dylantientcheu/starlight.git /tmp/starlight-tmp
+
+# Copy only docsearch package
+cp -r /tmp/starlight-tmp/packages/docsearch/. vendor/docsearch/
+
+# Clean up
+rm -rf /tmp/starlight-tmp
+```
+
+Then commit the updated vendor folder.
+
+## Tracking
+
+- **Upstream PR**: https://github.com/withastro/starlight/pull/3346
+- **Fork**: https://github.com/dylantientcheu/starlight
+- **DocSearch v4 Docs**: https://docsearch.algolia.com/
+- **Ask AI Docs**: https://docsearch.algolia.com/docs/v4/askai
+
+## Ask AI Configuration
+
+To enable Ask AI (optional), add the `askAi` option to your Starlight DocSearch plugin in `astro.config.mjs`:
+
+```ts
+starlightDocSearch({
+  appId: 'YOUR_APP_ID',
+  apiKey: 'YOUR_SEARCH_API_KEY',
+  indexName: 'YOUR_INDEX_NAME',
+  askAi: 'YOUR_ASSISTANT_ID',  // or as an object with overrides
+}),
+```
+
+See [Ask AI documentation](https://docsearch.algolia.com/docs/v4/askai) for details on getting an assistant ID.

src/components/overrides/Header.astro

@@ -2,7 +2,7 @@
 import type { Props } from '@astrojs/starlight/props'
 import { Icon } from '@astrojs/starlight/components'
 
-import Search from '@astrojs/starlight/components/Search.astro'
+import Search from '@astrojs/starlight-docsearch/DocSearch.astro'
 import SiteTitle from '@astrojs/starlight/components/SiteTitle.astro'
 import SecondaryNav from '../SecondaryNav.astro'
 

src/content/docs/dev-kit/guides/dashboard/billing.mdx

@@ -4,6 +4,19 @@ description: View your current plan, manage payment methods, and monitor your Sc
 tableOfContents: true
 sidebar:
   label: Billing and usage
+head:
+  - tag: style
+    content: |
+      .sl-markdown-content h2 {
+        font-size: var(--sl-text-xl);
+      }
+      .sl-markdown-content h3 {
+        font-size: var(--sl-text-lg);
+      }
+  - tag: meta
+    attrs:
+      name: robots
+      content: noindex
 ---
 
 import { Aside } from '@astrojs/starlight/components'

src/content/docs/dev-kit/guides/dashboard/environments.mdx

@@ -4,6 +4,19 @@ description: Configure and manage development, staging, and production environme
 tableOfContents: true
 sidebar:
   label: Manage environments
+head:
+  - tag: style
+    content: |
+      .sl-markdown-content h2 {
+        font-size: var(--sl-text-xl);
+      }
+      .sl-markdown-content h3 {
+        font-size: var(--sl-text-lg);
+      }
+  - tag: meta
+    attrs:
+      name: robots
+      content: noindex
 ---
 
 import { Aside } from '@astrojs/starlight/components'

src/content/docs/dev-kit/guides/dashboard/manage-team-members.mdx

@@ -4,6 +4,19 @@ description: Invite team members to your Scalekit organization and manage their
 tableOfContents: true
 sidebar:
   label: Manage team members
+head:
+  - tag: style
+    content: |
+      .sl-markdown-content h2 {
+        font-size: var(--sl-text-xl);
+      }
+      .sl-markdown-content h3 {
+        font-size: var(--sl-text-lg);
+      }
+  - tag: meta
+    attrs:
+      name: robots
+      content: noindex
 ---
 
 import { Aside } from '@astrojs/starlight/components'

src/content/docs/dev-kit/guides/testing/scim-simulator.mdx

@@ -4,6 +4,19 @@ description: 'Test your SCIM integration locally with the Scalekit SCIM Simulato
 template: doc
 sidebar:
   label: 'SCIM Simulator'
+head:
+  - tag: style
+    content: |
+      .sl-markdown-content h2 {
+        font-size: var(--sl-text-xl);
+      }
+      .sl-markdown-content h3 {
+        font-size: var(--sl-text-lg);
+      }
+  - tag: meta
+    attrs:
+      name: robots
+      content: noindex
 ---
 
 Coming soon

src/content/docs/dev-kit/guides/testing/sso-simulator.mdx

@@ -4,4 +4,17 @@ description: 'Test your SSO integration locally with the Scalekit SSO Simulator'
 template: doc
 sidebar:
   label: 'SSO Simulator'
+head:
+  - tag: style
+    content: |
+      .sl-markdown-content h2 {
+        font-size: var(--sl-text-xl);
+      }
+      .sl-markdown-content h3 {
+        font-size: var(--sl-text-lg);
+      }
+  - tag: meta
+    attrs:
+      name: robots
+      content: noindex
 ---

vendor/docsearch/CHANGELOG.md

@@ -0,0 +1,68 @@
+# @astrojs/starlight-docsearch
+
+## 0.6.0
+
+### Minor Changes
+
+- [#2578](https://github.com/withastro/starlight/pull/2578) [`f895f75`](https://github.com/withastro/starlight/commit/f895f75b17f36c826cc871ba1826e5ae1dff44ca) and [#2390](https://github.com/withastro/starlight/pull/2390) [`f493361`](https://github.com/withastro/starlight/commit/f493361d7b64a3279980e0f046c3a52196ab94e0) Thanks [@HiDeoo](https://github.com/HiDeoo) and [@delucis](https://github.com/delucis)!  
+  ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.32.0
+
+  Please use the `@astrojs/upgrade` command to upgrade your project:
+
+  ```sh
+  npx @astrojs/upgrade
+  ```
+
+## 0.5.0
+
+### Minor Changes
+
+- [#2822](https://github.com/withastro/starlight/pull/2822) [`e56586a`](https://github.com/withastro/starlight/commit/e56586add37188b43f3f4c8c15883724fe8fdf87) Thanks [@KianNH](https://github.com/KianNH)! - Adds a new `clientOptionsModule` plugin option to support configuring unserializable DocSearch options such as `resultsFooterComponent()`.
+
+  See [“DocSearch configuration”](https://starlight.astro.build/guides/site-search/#docsearch-configuration) in the Starlight docs for more details.
+
+## 0.4.0
+
+### Minor Changes
+
+- [#2612](https://github.com/withastro/starlight/pull/2612) [`8d5a4e8`](https://github.com/withastro/starlight/commit/8d5a4e8000d9e3a4bb9ca8178767cf3d8bc48773) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.30.0
+
+  Please use the `@astrojs/upgrade` command to upgrade your project:
+
+  ```sh
+  npx @astrojs/upgrade
+  ```
+
+### Patch Changes
+
+- [#2664](https://github.com/withastro/starlight/pull/2664) [`62ff007`](https://github.com/withastro/starlight/commit/62ff0074d9a3f82e46f5c62db85c04d87ff5e931) Thanks [@HiDeoo](https://github.com/HiDeoo)! - Publishes provenance containing verifiable data to link a package back to its source repository and the specific build instructions used to publish it.
+
+## 0.3.0
+
+### Minor Changes
+
+- [#2589](https://github.com/withastro/starlight/pull/2589) [`d4cf8cc`](https://github.com/withastro/starlight/commit/d4cf8cc5633dc87474f943657ec4846e821f7f5b) Thanks [@delucis](https://github.com/delucis)! - Adds support for some more of the DocSearch component’s configuration options
+
+## 0.2.0
+
+### Minor Changes
+
+- [#1923](https://github.com/withastro/starlight/pull/1923) [`5269aad`](https://github.com/withastro/starlight/commit/5269aad928773ae08b35ba8e19c0f2832d0d2c89) Thanks [@HiDeoo](https://github.com/HiDeoo)! - ⚠️ **BREAKING CHANGE:** The minimum supported version of Starlight is now 0.28.0
+
+  Please use the `@astrojs/upgrade` command to upgrade your project:
+
+  ```sh
+  npx @astrojs/upgrade
+  ```
+
+## 0.1.1
+
+### Patch Changes
+
+- [#2009](https://github.com/withastro/starlight/pull/2009) [`1e8bfe4`](https://github.com/withastro/starlight/commit/1e8bfe4b7bb8e958ce22e65c4719e7f281cd6e88) Thanks [@delucis](https://github.com/delucis)! - Updates Docsearch packages to 3.6.0
+
+## 0.1.0
+
+### Minor Changes
+
+- [#1168](https://github.com/withastro/starlight/pull/1168) [`8155d1a`](https://github.com/withastro/starlight/commit/8155d1a27c5a783c0abdfb6ce1ec066c6926290d) Thanks [@delucis](https://github.com/delucis)! - Adds a Starlight plugin to support using Algolia DocSearch as the Starlight search provider.