@vercel/geistdocs 2.14.6 → 2.14.7-canary.6ce58a6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cli/index.js +5 -5
- package/dist/config.d.ts +23 -3
- package/dist/config.d.ts.map +1 -1
- package/dist/controls.d.ts +3 -40
- package/dist/controls.d.ts.map +1 -1
- package/dist/controls.js +5 -96
- package/dist/internal/chat-retrieval.d.ts +10 -9
- package/dist/internal/chat-retrieval.d.ts.map +1 -1
- package/dist/internal/chat-retrieval.js +32 -68
- package/dist/internal/controls-client.d.ts +40 -0
- package/dist/internal/controls-client.d.ts.map +1 -0
- package/dist/internal/controls-client.js +87 -0
- package/dist/internal/language-selector.d.ts +2 -0
- package/dist/internal/language-selector.d.ts.map +1 -0
- package/dist/internal/language-selector.js +12 -0
- package/dist/internal/mixedbread-store.d.ts +53 -0
- package/dist/internal/mixedbread-store.d.ts.map +1 -0
- package/dist/internal/mixedbread-store.js +129 -0
- package/dist/internal/navbar/mobile-menu.js +1 -1
- package/dist/internal/page-action-options.d.ts +37 -0
- package/dist/internal/page-action-options.d.ts.map +1 -0
- package/dist/internal/page-action-options.js +39 -0
- package/dist/internal/page-actions-client.d.ts +1 -31
- package/dist/internal/page-actions-client.d.ts.map +1 -1
- package/dist/internal/page-actions-client.js +5 -103
- package/dist/internal/page-actions-gate.d.ts +3 -0
- package/dist/internal/page-actions-gate.d.ts.map +1 -0
- package/dist/internal/page-actions-gate.js +15 -0
- package/dist/internal/provider-client.d.ts.map +1 -1
- package/dist/internal/provider-client.js +26 -1
- package/dist/internal/relative-docs-link.d.ts +7 -0
- package/dist/internal/relative-docs-link.d.ts.map +1 -0
- package/dist/internal/relative-docs-link.js +22 -0
- package/dist/internal/sidebar.d.ts.map +1 -1
- package/dist/internal/sidebar.js +1 -1
- package/dist/internal/toc-actions-client.d.ts +9 -0
- package/dist/internal/toc-actions-client.d.ts.map +1 -0
- package/dist/internal/toc-actions-client.js +78 -0
- package/dist/mdx.d.ts.map +1 -1
- package/dist/mdx.js +5 -2
- package/dist/navbar.js +1 -1
- package/dist/pages/changelog.js +1 -1
- package/dist/pages/docs.d.ts.map +1 -1
- package/dist/pages/docs.js +4 -3
- package/dist/routes/chat.d.ts +4 -4
- package/dist/routes/chat.d.ts.map +1 -1
- package/dist/routes/chat.js +19 -34
- package/dist/routes/openapi.d.ts.map +1 -1
- package/dist/routes/openapi.js +13 -5
- package/dist/routes/search-export.d.ts +1 -1
- package/dist/routes/search-export.d.ts.map +1 -1
- package/dist/routes/search-export.js +5 -2
- package/dist/routes/search.d.ts +10 -2
- package/dist/routes/search.d.ts.map +1 -1
- package/dist/routes/search.js +215 -55
- package/docs/agents.md +3 -3
- package/docs/llms.txt +214 -32
- package/docs/manifest.json +5 -5
- package/docs/pages/ask-ai.md +1 -1
- package/docs/pages/configuration.md +26 -3
- package/docs/pages/env.md +5 -5
- package/docs/pages/index.md +1 -1
- package/docs/pages/llms-txt.md +1 -1
- package/docs/pages/mixedbread-retrieval.md +174 -18
- package/docs/pages/provider.md +3 -0
- package/docs/sitemap.md +2 -2
- package/package.json +6 -6
- package/template/.env.example +1 -0
- package/template/AGENTS.md +11 -7
- package/template/content/docs/ask-ai.mdx +1 -1
- package/template/content/docs/configuration.mdx +26 -3
- package/template/content/docs/env.mdx +5 -5
- package/template/content/docs/index.mdx +1 -1
- package/template/content/docs/llms-txt.mdx +1 -1
- package/template/content/docs/mixedbread-retrieval.mdx +174 -18
- package/template/content/docs/provider.mdx +3 -0
- package/template/geistdocs.tsx +6 -1
- package/template/lib/geistdocs/config.tsx +2 -0
- package/template/package.json +1 -1
package/docs/llms.txt
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# Geistdocs Package Documentation
|
|
2
2
|
|
|
3
|
-
These docs are bundled with `@vercel/geistdocs` 2.14.
|
|
3
|
+
These docs are bundled with `@vercel/geistdocs` 2.14.7-canary.6ce58a6.
|
|
4
4
|
They describe how to build package-backed Geistdocs sites and how to use the package APIs from generated project adapters.
|
|
5
5
|
|
|
6
6
|
## Documentation Index
|
|
7
7
|
|
|
8
8
|
- [Overview](pages/index.md): Geistdocs is a packaged documentation system for creating Next.js and Fumadocs sites with shared runtime features.
|
|
9
9
|
- [Getting Started](pages/getting-started.md): Create a Geistdocs project, run it locally, and edit your first documentation page.
|
|
10
|
-
- [Environment Variables](pages/env.md): Environment variables required by Geistdocs for AI chat, Mixedbread retrieval, proxy mode, eve agent session cookies, and production URL configuration.
|
|
10
|
+
- [Environment Variables](pages/env.md): Environment variables required by Geistdocs for AI chat, Mixedbread retrieval for Ask AI and site search, proxy mode, eve agent session cookies, and production URL configuration.
|
|
11
11
|
- [Deploy to Vercel](pages/deployment.md): Deploy a Geistdocs site to Vercel with the required project settings and environment variables.
|
|
12
12
|
- [Migrate to Geistdocs](pages/migration.md): Move an existing documentation site to @vercel/geistdocs while keeping local content, routing, middleware behavior, and AI-readable surfaces intact.
|
|
13
13
|
- [Choose a Geistdocs package](pages/packages.md): Use the public package by default and the private package only where restricted Vercel npm dependencies are already available.
|
|
@@ -35,7 +35,7 @@ They describe how to build package-backed Geistdocs sites and how to use the pac
|
|
|
35
35
|
- [Edit on GitHub](pages/edit-on-github.md): A direct link on every documentation page that lets readers propose changes through GitHub pull requests.
|
|
36
36
|
- [Feedback](pages/feedback.md): An interactive feedback widget that collects user sentiment and creates structured GitHub Issues automatically.
|
|
37
37
|
- [Image](pages/components/image.md): Use the Geistdocs Image wrapper for documentation-aware Next.js images.
|
|
38
|
-
- [Improve Ask AI
|
|
38
|
+
- [Improve Ask AI and site search with Mixedbread](pages/mixedbread-retrieval.md): Provision a Mixedbread Store for one Geistdocs consumer site, turn on semantic retrieval for Ask AI with ai.retrieval and for site search with search.provider, and sync documentation during production builds.
|
|
39
39
|
- [Input](pages/components/input.md): Use Input for text entry in custom documentation and application interfaces.
|
|
40
40
|
- [Internationalization](pages/internationalization.md): Serve documentation in multiple languages with automatic translation via the Geistdocs CLI and Fumadocs routing.
|
|
41
41
|
- [llms.txt](pages/llms-txt.md): A single endpoint that returns all documentation as plain Markdown text following the llms.txt standard.
|
|
@@ -139,7 +139,7 @@ Advanced projects can use package APIs for versioned docs, multiple content sour
|
|
|
139
139
|
- MDX documentation with custom components
|
|
140
140
|
- Local content in `content/docs`
|
|
141
141
|
- Search and Ask AI
|
|
142
|
-
- Optional Mixedbread semantic retrieval for Ask AI
|
|
142
|
+
- Optional Mixedbread semantic retrieval for Ask AI and site search
|
|
143
143
|
- Page actions, including feedback, copy page, open in chat, and edit on GitHub
|
|
144
144
|
- Agent-readiness metadata with `/agents.md` and `/.well-known/mcp.json`
|
|
145
145
|
- Raw Markdown routes for AI tools
|
|
@@ -327,7 +327,7 @@ Then follow [Deploy to Vercel](/docs/deployment), including environment-variable
|
|
|
327
327
|
title: Environment Variables
|
|
328
328
|
description: Learn about the environment variables used in Geistdocs
|
|
329
329
|
type: reference
|
|
330
|
-
summary: Environment variables required by Geistdocs for AI chat, Mixedbread retrieval, proxy mode, eve agent session cookies, and production URL configuration.
|
|
330
|
+
summary: Environment variables required by Geistdocs for AI chat, Mixedbread retrieval for Ask AI and site search, proxy mode, eve agent session cookies, and production URL configuration.
|
|
331
331
|
url: /docs/env
|
|
332
332
|
source: apps/template/content/docs/env.mdx
|
|
333
333
|
prerequisites:
|
|
@@ -339,7 +339,7 @@ related:
|
|
|
339
339
|
|
|
340
340
|
# Environment Variables
|
|
341
341
|
|
|
342
|
-
Geistdocs uses environment variables to configure Ask AI, optional Mixedbread retrieval, optional Vertex-backed proxy mode, eve agent session cookie signing, and production URL behavior.
|
|
342
|
+
Geistdocs uses environment variables to configure Ask AI, optional Mixedbread retrieval for Ask AI and site search, optional Vertex-backed proxy mode, eve agent session cookie signing, and production URL behavior.
|
|
343
343
|
|
|
344
344
|
Review this Geistdocs project and help me configure the required environment variables. Check whether `AI_GATEWAY_API_KEY`, `MXBAI_API_KEY`, `MXBAI_STORE_ID`, `GEISTDOCS_CHAT_PROXY_URL`, `GEISTDOCS_CHAT_PROXY_TOKEN`, `GEISTDOCS_CHAT_SECRET`, and `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` are needed for the features I enabled, then tell me where to set them locally and on Vercel.
|
|
345
345
|
|
|
@@ -353,13 +353,13 @@ Leave `GEISTDOCS_CHAT_PROXY_URL` unset to use AI Gateway mode.
|
|
|
353
353
|
|
|
354
354
|
## `MXBAI_API_KEY`
|
|
355
355
|
|
|
356
|
-
The server-only API key for Mixedbread retrieval. The Mixedbread Vercel Marketplace integration injects this value when you provision a Store and connect it to the consumer site's Vercel project.
|
|
356
|
+
The server-only API key for Mixedbread retrieval, used by Ask AI and site search. The Mixedbread Vercel Marketplace integration injects this value when you provision a Store and connect it to the consumer site's Vercel project.
|
|
357
357
|
|
|
358
358
|
## `MXBAI_STORE_ID`
|
|
359
359
|
|
|
360
|
-
The Mixedbread Store used by one consumer site.
|
|
360
|
+
The Mixedbread Store used by one consumer site. Configure a unique `siteId`, then set `ai.retrieval`, `search.provider`, or both to `"mixedbread"` before using this value. Ask AI and site search share this Store and `MXBAI_API_KEY`. When either value or `siteId` is missing at runtime, each surface that uses Mixedbread answers from local search instead.
|
|
361
361
|
|
|
362
|
-
Provision the Store by running `vercel integration add mixedbread` from the root of the consumer site's repository, where Vercel CLI is linked to that site's project. Do not run the provisioning command from the Geistdocs package repository. Read [Improve Ask AI
|
|
362
|
+
Provision the Store by running `vercel integration add mixedbread` from the root of the consumer site's repository, where Vercel CLI is linked to that site's project. Do not run the provisioning command from the Geistdocs package repository. Read [Improve Ask AI and site search with Mixedbread](/docs/mixedbread-retrieval) for the complete setup.
|
|
363
363
|
|
|
364
364
|
## `GEISTDOCS_CHAT_PROXY_URL`
|
|
365
365
|
|
|
@@ -1189,7 +1189,10 @@ Read [Configure sidebar navigation](/docs/guides/nested-navigation) for page ord
|
|
|
1189
1189
|
The root `geistdocs.tsx` file is the primary configuration surface:
|
|
1190
1190
|
|
|
1191
1191
|
```tsx title="geistdocs.tsx"
|
|
1192
|
-
import type {
|
|
1192
|
+
import type {
|
|
1193
|
+
GeistdocsNavbarBrand,
|
|
1194
|
+
GeistdocsSearchConfig,
|
|
1195
|
+
} from "@vercel/geistdocs/config";
|
|
1193
1196
|
|
|
1194
1197
|
export const navbarBrand: GeistdocsNavbarBrand = "vercel";
|
|
1195
1198
|
|
|
@@ -1228,6 +1231,8 @@ export const translations = {
|
|
|
1228
1231
|
en: { displayName: "English" },
|
|
1229
1232
|
};
|
|
1230
1233
|
|
|
1234
|
+
export const search = {} satisfies GeistdocsSearchConfig;
|
|
1235
|
+
|
|
1231
1236
|
export const basePath: string | undefined = undefined;
|
|
1232
1237
|
export const siteId: string | undefined = undefined;
|
|
1233
1238
|
```
|
|
@@ -1296,6 +1301,7 @@ import {
|
|
|
1296
1301
|
nav,
|
|
1297
1302
|
navbarBrand,
|
|
1298
1303
|
prompt,
|
|
1304
|
+
search,
|
|
1299
1305
|
siteId,
|
|
1300
1306
|
suggestions,
|
|
1301
1307
|
title,
|
|
@@ -1311,6 +1317,7 @@ export const config = defineConfig({
|
|
|
1311
1317
|
nav,
|
|
1312
1318
|
navbarBrand,
|
|
1313
1319
|
basePath,
|
|
1320
|
+
search,
|
|
1314
1321
|
siteId,
|
|
1315
1322
|
translations,
|
|
1316
1323
|
ai: {
|
|
@@ -1347,7 +1354,7 @@ export const config = defineConfig({
|
|
|
1347
1354
|
});
|
|
1348
1355
|
```
|
|
1349
1356
|
|
|
1350
|
-
The `ai` config accepts `retrieval: "mixedbread"` to use semantic documentation retrieval and `eveAgent` to answer Ask AI requests with a hosted eve framework agent:
|
|
1357
|
+
The `ai` config accepts `retrieval: "mixedbread"` to use semantic documentation retrieval for Ask AI and `eveAgent` to answer Ask AI requests with a hosted eve framework agent:
|
|
1351
1358
|
|
|
1352
1359
|
```tsx title="geistdocs.tsx"
|
|
1353
1360
|
export const ai = {
|
|
@@ -1388,10 +1395,26 @@ export const ai = {
|
|
|
1388
1395
|
|
|
1389
1396
|
The endpoint receives `{ messages, hostPath, summary? }` and must return `{ shareId }`. The public route at `path/<shareId>` must display the saved conversation. Both paths are app-local; Geistdocs adds `basePath` automatically. See [Share a conversation](/docs/ask-ai#share-a-conversation) for the full contract.
|
|
1390
1397
|
|
|
1391
|
-
See [Ask AI](/docs/ask-ai) for the full eve agent mode behavior, including authentication, for moving the chat route adapter when you set `endpoint`, for what a `messageFeedback` vote sends, and for matching a production Vertex or eve setup with `toolLabels` and the server-only `createChatRoute` options. Read [Improve Ask AI
|
|
1398
|
+
See [Ask AI](/docs/ask-ai) for the full eve agent mode behavior, including authentication, for moving the chat route adapter when you set `endpoint`, for what a `messageFeedback` vote sends, and for matching a production Vertex or eve setup with `toolLabels` and the server-only `createChatRoute` options. Read [Improve Ask AI and site search with Mixedbread](/docs/mixedbread-retrieval) before enabling semantic retrieval.
|
|
1392
1399
|
|
|
1393
1400
|
Use [Versioned docs](/docs/versioned-docs) for versioned source setup and [Proxy and markdown routes](/docs/proxy) for route mappings.
|
|
1394
1401
|
|
|
1402
|
+
### Choose the site search provider
|
|
1403
|
+
|
|
1404
|
+
The `search` export selects the index behind the search dialog, `GET /api/search`, and the MCP `search_docs` tool. `provider` accepts `"local"`, the default, or `"mixedbread"`:
|
|
1405
|
+
|
|
1406
|
+
```tsx title="geistdocs.tsx"
|
|
1407
|
+
import type { GeistdocsSearchConfig } from "@vercel/geistdocs/config";
|
|
1408
|
+
|
|
1409
|
+
export const search = {
|
|
1410
|
+
provider: "mixedbread",
|
|
1411
|
+
} satisfies GeistdocsSearchConfig;
|
|
1412
|
+
```
|
|
1413
|
+
|
|
1414
|
+
`"mixedbread"` ranks results with the site's Mixedbread Store and renders every result from the running deployment. It needs a non-empty `siteId` and the server-only `MXBAI_API_KEY` and `MXBAI_STORE_ID` variables. Without them, or when a Mixedbread request fails, the search route answers from the local index. `search.provider` and `ai.retrieval` are independent, and `search.enabled` keeps its existing meaning.
|
|
1415
|
+
|
|
1416
|
+
The generated `lib/geistdocs/config.tsx` forwards `search` to `defineConfig`. A site created before this release adds the `search` export and the forward once. Without the forward, search stays local with no error. Read [Improve Ask AI and site search with Mixedbread](/docs/mixedbread-retrieval#use-mixedbread-for-site-search) for the full setup.
|
|
1417
|
+
|
|
1395
1418
|
## Single-language sites
|
|
1396
1419
|
|
|
1397
1420
|
A site with one language can drop the `[lang]` route segment by setting `singleLanguage: true` in `defineConfig`. Routes then live directly under `app/`, the proxy skips locale rewrites, and route factories resolve every request to `defaultLanguage`. `translations` may only list `defaultLanguage`. Public URLs, `.md` routes, `llms.txt`, and `agents.md` keep their paths.
|
|
@@ -2509,6 +2532,9 @@ The provider handles these behaviors:
|
|
|
2509
2532
|
2. **Analytics**: Integrates Vercel Analytics and Speed Insights when the local adapter includes them.
|
|
2510
2533
|
3. **Search**: Configures the search dialog and connects it to your search API.
|
|
2511
2534
|
4. **Ask AI**: Provides the client state used by the chat sidebar and page actions.
|
|
2535
|
+
5. **Theme shortcut**: Press `T` with no modifiers while the page has focus to switch between light and dark themes. The shortcut is disabled when a theme is forced.
|
|
2536
|
+
|
|
2537
|
+
The shortcut is part of the package provider, so generated consumer projects get it by default. It does not run while an input, button, link, or other element has focus.
|
|
2512
2538
|
|
|
2513
2539
|
## Usage
|
|
2514
2540
|
|
|
@@ -4679,7 +4705,7 @@ By default, the AI assistant includes a built-in `search_docs` tool that:
|
|
|
4679
4705
|
|
|
4680
4706
|
When `GEISTDOCS_CHAT_PROXY_URL` is set, Geistdocs runs local documentation retrieval on the first user message before forwarding the request to the configured proxy. This gives proxy-backed services access to the current page and related local documentation without requiring them to read the site's source files directly. With `contextInjection: "page-only"`, Geistdocs skips this retrieval.
|
|
4681
4707
|
|
|
4682
|
-
Set `ai.retrieval` to `"mixedbread"` to replace local keyword retrieval with semantic retrieval for default, proxy, and hosted eve modes. Mixedbread returns the matching content chunk, while the AI model
|
|
4708
|
+
Set `ai.retrieval` to `"mixedbread"` to replace local keyword retrieval with semantic retrieval for default, proxy, and hosted eve modes. Mixedbread returns the matching content chunk, while the AI model stays the same. Geistdocs falls back to local Orama retrieval when Mixedbread is unavailable. `ai.retrieval` does not change the search dialog. To serve site search from the same Store, set `search.provider` to `"mixedbread"` as well. Read [Improve Ask AI and site search with Mixedbread](/docs/mixedbread-retrieval) to provision a Store and configure production sync.
|
|
4683
4709
|
|
|
4684
4710
|
### Persistent Chat History
|
|
4685
4711
|
|
|
@@ -5722,10 +5748,10 @@ Pass `srcLight` and `srcDark` for theme-aware artwork. `Image` is also included
|
|
|
5722
5748
|
---
|
|
5723
5749
|
|
|
5724
5750
|
---
|
|
5725
|
-
title: Improve Ask AI
|
|
5726
|
-
description: Configure Mixedbread retrieval for
|
|
5751
|
+
title: Improve Ask AI and site search with Mixedbread
|
|
5752
|
+
description: Configure Mixedbread semantic retrieval for Geistdocs Ask AI, site search, or both, and sync documentation to a site-specific Store
|
|
5727
5753
|
type: guide
|
|
5728
|
-
summary: Provision a Mixedbread Store for one Geistdocs consumer site,
|
|
5754
|
+
summary: Provision a Mixedbread Store for one Geistdocs consumer site, turn on semantic retrieval for Ask AI with ai.retrieval and for site search with search.provider, and sync documentation during production builds.
|
|
5729
5755
|
url: /docs/mixedbread-retrieval
|
|
5730
5756
|
source: apps/template/content/docs/mixedbread-retrieval.mdx
|
|
5731
5757
|
prerequisites:
|
|
@@ -5737,26 +5763,35 @@ related:
|
|
|
5737
5763
|
- /docs/llms-txt
|
|
5738
5764
|
---
|
|
5739
5765
|
|
|
5740
|
-
# Improve Ask AI
|
|
5766
|
+
# Improve Ask AI and site search with Mixedbread
|
|
5741
5767
|
|
|
5742
|
-
Mixedbread retrieval
|
|
5768
|
+
Mixedbread retrieval matches documentation to a reader's words by meaning instead of by keyword. A Geistdocs site can use its Mixedbread Store for Ask AI, for site search, or for both, and each surface has its own setting.
|
|
5743
5769
|
|
|
5744
|
-
|
|
5770
|
+
Both settings default to local Orama search. A site that sets neither behaves exactly as before, and a site that already uses Mixedbread for Ask AI keeps the same Ask AI behavior.
|
|
5745
5771
|
|
|
5746
|
-
Help me enable Mixedbread retrieval for this Geistdocs consumer site. Confirm that I am in this site's own repository and linked to the correct Vercel project before provisioning a Store. Then verify `siteId`, `ai.retrieval`, the search export route, the build script, and the `MXBAI` environment variables.
|
|
5772
|
+
Help me enable Mixedbread retrieval for this Geistdocs consumer site. Confirm that I am in this site's own repository and linked to the correct Vercel project before provisioning a Store. Then verify `siteId`, `ai.retrieval`, `search.provider`, the `search` config forwarded by `lib/geistdocs/config.tsx`, the search export route, the build script, and the `MXBAI` environment variables.
|
|
5747
5773
|
|
|
5748
5774
|
## How Mixedbread retrieval works
|
|
5749
5775
|
|
|
5750
|
-
|
|
5776
|
+
Two independent settings decide which surfaces read the Store:
|
|
5777
|
+
|
|
5778
|
+
| Setting | Surfaces | Default |
|
|
5779
|
+
| --- | --- | --- |
|
|
5780
|
+
| `ai.retrieval: "mixedbread"` | The documentation retrieval Ask AI runs before it sends a question to the AI model | `"local"` |
|
|
5781
|
+
| `search.provider: "mixedbread"` | The search dialog, `GET /api/search`, and the MCP `search_docs` tool, which calls the same route | `"local"` |
|
|
5782
|
+
|
|
5783
|
+
A site can set either, both, or neither. One Store and one sync serve both surfaces.
|
|
5784
|
+
|
|
5785
|
+
For Ask AI, the default local retriever matches keywords with Orama. Mixedbread adds semantic matching and returns the relevant content chunk instead of the start of a matching page. The AI model stays the same.
|
|
5786
|
+
|
|
5787
|
+
For site search, Mixedbread ranks pages and sections, and Geistdocs renders each result from the running deployment. The response shape stays the same, so the search dialog needs no change.
|
|
5751
5788
|
|
|
5752
5789
|
The production build performs an incremental sync:
|
|
5753
5790
|
|
|
5754
5791
|
1. Next.js statically generates `/api/search/export` from the site's configured content sources.
|
|
5755
5792
|
2. `geistdocs search sync` uploads new or changed Markdown documents to the site's Mixedbread Store.
|
|
5756
|
-
3. Ask AI
|
|
5757
|
-
4. Geistdocs
|
|
5758
|
-
|
|
5759
|
-
Pages with `internal: true` or `excludeFrom: [chat]` are omitted from the export and removed from the Store on the next successful sync.
|
|
5793
|
+
3. Ask AI, site search, or both query the Store by `siteId` and locale.
|
|
5794
|
+
4. Geistdocs answers from the local Orama index if Mixedbread is unavailable or its credentials are missing at runtime.
|
|
5760
5795
|
|
|
5761
5796
|
## Prerequisites
|
|
5762
5797
|
|
|
@@ -5764,7 +5799,7 @@ Before enabling Mixedbread retrieval, confirm that:
|
|
|
5764
5799
|
|
|
5765
5800
|
- The Mixedbread Marketplace integration is installed on your Vercel team.
|
|
5766
5801
|
- The consumer site has its own Vercel project.
|
|
5767
|
-
- The consumer repository uses a Geistdocs release that includes `geistdocs search sync` and `createSearchExportRoute`.
|
|
5802
|
+
- The consumer repository uses a Geistdocs release that includes `geistdocs search sync` and `createSearchExportRoute`. Site search needs a release that includes `search.provider`.
|
|
5768
5803
|
- `source.config.ts` enables `includeProcessedMarkdown`, as generated Geistdocs projects do by default.
|
|
5769
5804
|
- `next.config.ts` enables `cacheComponents`, as generated Geistdocs projects do by default. Next.js must statically prerender `/api/search/export` before the sync command runs.
|
|
5770
5805
|
|
|
@@ -5799,7 +5834,13 @@ vercel integration list --integration mixedbread
|
|
|
5799
5834
|
|
|
5800
5835
|
## Configure the consumer site
|
|
5801
5836
|
|
|
5802
|
-
Set a unique `siteId`
|
|
5837
|
+
Set a unique `siteId` in the consumer repository's root `geistdocs.tsx` file, then turn on Mixedbread for Ask AI, site search, or both. Both surfaces need `siteId`, and both read the same `MXBAI_API_KEY` and `MXBAI_STORE_ID` variables.
|
|
5838
|
+
|
|
5839
|
+
Keep `MXBAI_API_KEY` and `MXBAI_STORE_ID` out of `geistdocs.tsx` and every other config value, because that config is available to client components.
|
|
5840
|
+
|
|
5841
|
+
### Use Mixedbread for Ask AI
|
|
5842
|
+
|
|
5843
|
+
Set `ai.retrieval` in `geistdocs.tsx`:
|
|
5803
5844
|
|
|
5804
5845
|
```tsx title="geistdocs.tsx"
|
|
5805
5846
|
import type {
|
|
@@ -5813,7 +5854,64 @@ export const ai = {
|
|
|
5813
5854
|
} satisfies GeistdocsAIConfig;
|
|
5814
5855
|
```
|
|
5815
5856
|
|
|
5816
|
-
The generated `lib/geistdocs/config.tsx` spreads `ai` into the package config.
|
|
5857
|
+
The generated `lib/geistdocs/config.tsx` spreads `ai` into the package config.
|
|
5858
|
+
|
|
5859
|
+
### Use Mixedbread for site search
|
|
5860
|
+
|
|
5861
|
+
Site search takes two edits. First, set `search.provider` in `geistdocs.tsx`:
|
|
5862
|
+
|
|
5863
|
+
```tsx title="geistdocs.tsx"
|
|
5864
|
+
import type {
|
|
5865
|
+
GeistdocsSearchConfig,
|
|
5866
|
+
} from "@vercel/geistdocs/config";
|
|
5867
|
+
|
|
5868
|
+
export const siteId = "my-product-docs";
|
|
5869
|
+
|
|
5870
|
+
export const search = {
|
|
5871
|
+
provider: "mixedbread",
|
|
5872
|
+
} satisfies GeistdocsSearchConfig;
|
|
5873
|
+
```
|
|
5874
|
+
|
|
5875
|
+
Second, make sure `lib/geistdocs/config.tsx` imports `search` and passes it to `defineConfig`:
|
|
5876
|
+
|
|
5877
|
+
```tsx title="lib/geistdocs/config.tsx"
|
|
5878
|
+
import { defineConfig } from "@vercel/geistdocs/config";
|
|
5879
|
+
import {
|
|
5880
|
+
// ...your other exports
|
|
5881
|
+
search,
|
|
5882
|
+
siteId,
|
|
5883
|
+
} from "@/geistdocs";
|
|
5884
|
+
|
|
5885
|
+
export const config = defineConfig({
|
|
5886
|
+
// ...
|
|
5887
|
+
search,
|
|
5888
|
+
siteId,
|
|
5889
|
+
});
|
|
5890
|
+
```
|
|
5891
|
+
|
|
5892
|
+
New projects generated from the template already export `search` as `{}` and forward it, so they only change the `provider` value. A site created before this release adds the `search` export and the forward once. Without the forward, the setting never reaches the search route, and search stays local with no error.
|
|
5893
|
+
|
|
5894
|
+
The search route file doesn't change. `createSearchRoute({ config, sources })` reads `search.provider` from `config`, and `search.enabled` keeps its existing meaning.
|
|
5895
|
+
|
|
5896
|
+
### Override the connection on the server
|
|
5897
|
+
|
|
5898
|
+
To pass credentials another way, or to use a non-default Mixedbread API origin, set the server-only `mixedbread` option on the search route. It has the same shape as the `mixedbread` option on `createChatRoute`:
|
|
5899
|
+
|
|
5900
|
+
```ts title="app/api/search/route.ts"
|
|
5901
|
+
import { createSearchRoute } from "@vercel/geistdocs/routes/search";
|
|
5902
|
+
import { config } from "@/lib/geistdocs/config";
|
|
5903
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
5904
|
+
|
|
5905
|
+
export const GET = createSearchRoute({
|
|
5906
|
+
config,
|
|
5907
|
+
sources: [geistdocsSource],
|
|
5908
|
+
mixedbread: {
|
|
5909
|
+
apiBaseUrl: "https://mixedbread.example.com/v1",
|
|
5910
|
+
},
|
|
5911
|
+
});
|
|
5912
|
+
```
|
|
5913
|
+
|
|
5914
|
+
The option also accepts `apiKey`, `storeId`, and `requestTimeoutMs`, which defaults to 1,500 ms for site search. `MXBAI_API_KEY` and `MXBAI_STORE_ID` fill any credential you omit. The runtime does not read `MXBAI_BASE_URL`. Only the `geistdocs search sync` command reads it, so set `apiBaseUrl` on the route for runtime requests.
|
|
5817
5915
|
|
|
5818
5916
|
## Add the export route to an existing site
|
|
5819
5917
|
|
|
@@ -5832,6 +5930,38 @@ export const { GET } = createSearchExportRoute({
|
|
|
5832
5930
|
|
|
5833
5931
|
Pass every configured source in `sources` when the site has multiple sections or documentation versions.
|
|
5834
5932
|
|
|
5933
|
+
## Control which pages reach the Store
|
|
5934
|
+
|
|
5935
|
+
The export holds the pages of every surface that reads the Store:
|
|
5936
|
+
|
|
5937
|
+
| Configuration | Pages in the export |
|
|
5938
|
+
| --- | --- |
|
|
5939
|
+
| Only `ai.retrieval: "mixedbread"` | Chat-visible pages, as before |
|
|
5940
|
+
| Only `search.provider: "mixedbread"` | Search-visible pages |
|
|
5941
|
+
| Both | Pages visible to chat, search, or both |
|
|
5942
|
+
|
|
5943
|
+
Pages with `internal: true` are never exported. A page that leaves the export is removed from the Store on the next successful sync.
|
|
5944
|
+
|
|
5945
|
+
When site search uses Mixedbread, a page with `excludeFrom: [chat]` that search can still show is uploaded to the Mixedbread Store. Ask AI still never retrieves it, because Ask AI checks every Store hit against chat visibility.
|
|
5946
|
+
|
|
5947
|
+
Each surface checks every Store hit against the running deployment before it uses the hit. Site search never shows a page with `excludeFrom: [search]`, an `internal: true` page, a page that the search route's `filterPage` rejects, or a page that no longer exists, whatever the Store holds. Ask AI applies the same check for chat.
|
|
5948
|
+
|
|
5949
|
+
To keep a page out of the Store entirely, reject it with `filterPage` on the export route:
|
|
5950
|
+
|
|
5951
|
+
```ts title="app/api/search/export/route.ts"
|
|
5952
|
+
import { createSearchExportRoute } from "@vercel/geistdocs/routes/search-export";
|
|
5953
|
+
import { config } from "@/lib/geistdocs/config";
|
|
5954
|
+
import { geistdocsSource } from "@/lib/geistdocs/source";
|
|
5955
|
+
|
|
5956
|
+
export const { GET } = createSearchExportRoute({
|
|
5957
|
+
config,
|
|
5958
|
+
sources: [geistdocsSource],
|
|
5959
|
+
filterPage: (page) => !page.url.includes("/internal"),
|
|
5960
|
+
});
|
|
5961
|
+
```
|
|
5962
|
+
|
|
5963
|
+
Pass the same `filterPage` to the export, chat, and search routes. The search route can only drop more hits at request time, and a page that the export filter rejects is not in the Store.
|
|
5964
|
+
|
|
5835
5965
|
## Sync after each production build
|
|
5836
5966
|
|
|
5837
5967
|
New Geistdocs projects run the sync from their build script. For an existing site, update `package.json`:
|
|
@@ -5844,7 +5974,9 @@ New Geistdocs projects run the sync from their build script. For an existing sit
|
|
|
5844
5974
|
}
|
|
5845
5975
|
```
|
|
5846
5976
|
|
|
5847
|
-
Deploy the site to production. The first production build uploads every
|
|
5977
|
+
Deploy the site to production. The first production build uploads every exported page. Later builds upload changed pages and remove stale pages while leaving unrelated Store files untouched.
|
|
5978
|
+
|
|
5979
|
+
The sync runs when Ask AI, site search, or both use Mixedbread. When neither does, it prints `Geistdocs search sync skipped: neither Ask AI nor site search uses Mixedbread.`
|
|
5848
5980
|
|
|
5849
5981
|
Local and preview builds skip the remote sync. To test a sync outside a production Vercel build, build the site and run the sync with the linked project's production environment variables:
|
|
5850
5982
|
|
|
@@ -5854,18 +5986,68 @@ vercel env run --environment production -- \
|
|
|
5854
5986
|
pnpm exec geistdocs search sync --allow-non-production
|
|
5855
5987
|
```
|
|
5856
5988
|
|
|
5857
|
-
The sync command fails when
|
|
5989
|
+
The sync command fails when Ask AI or site search uses Mixedbread for a production build but the Store environment variables are missing. The error prints the provisioning command and reminds you to run it from the correct consumer repository.
|
|
5990
|
+
|
|
5991
|
+
An existing Ask AI site uploads nothing new when it upgrades Geistdocs, because Store metadata and content hashes are unchanged. Turning on `search.provider` adds the search-visible pages that chat excludes.
|
|
5992
|
+
|
|
5993
|
+
## Preview and local deployments
|
|
5994
|
+
|
|
5995
|
+
The Store holds the content of the last production sync. Preview and local deployments that have the `MXBAI_*` variables query the production Store, and Geistdocs still renders and checks every result against the deployment that serves the request.
|
|
5996
|
+
|
|
5997
|
+
A page that exists only in a preview deployment is not in the Store. That page appears in search results only when local search answers.
|
|
5998
|
+
|
|
5999
|
+
The provisioning command connects the Store to the production environment. A preview deployment without the `MXBAI_*` variables serves local search and local Ask AI retrieval.
|
|
6000
|
+
|
|
6001
|
+
## What readers see in site search
|
|
6002
|
+
|
|
6003
|
+
Mixedbread decides which pages and sections match and in what order. Every string in a result, including the title, breadcrumbs, heading, anchor, excerpt, and URL, comes from the page in the running deployment. Geistdocs never shows text stored in Mixedbread.
|
|
6004
|
+
|
|
6005
|
+
Each query returns up to 8 pages, and each page shows up to 3 sections. URLs stay app-local, as they are with local search. The generated OpenAPI document describes the search operation as semantic search when `search.provider` is `"mixedbread"`.
|
|
6006
|
+
|
|
6007
|
+
## When local search answers instead
|
|
6008
|
+
|
|
6009
|
+
Site search never fails because of Mixedbread. The search route answers from the local index with status 200 when:
|
|
6010
|
+
|
|
6011
|
+
- `MXBAI_API_KEY`, `MXBAI_STORE_ID`, or `siteId` is missing. The server logs one warning per route instance, such as `[Geistdocs search] search.provider is "mixedbread" but MXBAI_STORE_ID is missing. Serving local search.`
|
|
6012
|
+
- The Mixedbread request fails or exceeds its timeout, which is 1,500 ms by default, with no retries. The server logs `[Geistdocs search] Mixedbread search failed. Serving local search.` with the error.
|
|
6013
|
+
- Mixedbread returns nothing that the deployment can show, for example before the first production sync.
|
|
6014
|
+
|
|
6015
|
+
The local route always answers these requests without calling Mixedbread:
|
|
6016
|
+
|
|
6017
|
+
- A request with an empty query.
|
|
6018
|
+
- A request with a `tag` parameter. The built-in local index still returns no results for a tagged request, as before.
|
|
6019
|
+
- A request for a locale the site does not configure.
|
|
5858
6020
|
|
|
5859
6021
|
## Verify retrieval
|
|
5860
6022
|
|
|
5861
|
-
Open the Mixedbread dashboard through Vercel and confirm that the Store contains one file per
|
|
6023
|
+
Open the Mixedbread dashboard through Vercel and confirm that the Store contains one file per exported documentation page:
|
|
5862
6024
|
|
|
5863
6025
|
```bash title="Terminal"
|
|
5864
6026
|
vercel integration open mixedbread
|
|
5865
6027
|
```
|
|
5866
6028
|
|
|
6029
|
+
### Verify Ask AI
|
|
6030
|
+
|
|
5867
6031
|
Ask a question that uses different words from the page title. Ask AI should cite the relevant page and answer from the matching section. If Mixedbread returns an error or exceeds the request timeout, Geistdocs logs a warning and retries the question with local Orama retrieval.
|
|
5868
6032
|
|
|
6033
|
+
### Verify site search
|
|
6034
|
+
|
|
6035
|
+
Every search response from a site with `search.provider: "mixedbread"` carries the `x-geistdocs-search-provider` header. Request a query and read the header:
|
|
6036
|
+
|
|
6037
|
+
```bash title="Terminal"
|
|
6038
|
+
curl -si 'https://docs.example.com/api/search?query=deploy%20a%20site&locale=en'
|
|
6039
|
+
```
|
|
6040
|
+
|
|
6041
|
+
| Header value | Meaning |
|
|
6042
|
+
| --- | --- |
|
|
6043
|
+
| `mixedbread` | Mixedbread ranked the results. |
|
|
6044
|
+
| `local` | The site opted in, but local search answered this request. Check the server logs for a warning. |
|
|
6045
|
+
| No header | The setting did not reach the search route. Check that `geistdocs.tsx` sets `search.provider` and that `lib/geistdocs/config.tsx` forwards `search`. |
|
|
6046
|
+
|
|
6047
|
+
## Request cost
|
|
6048
|
+
|
|
6049
|
+
The search dialog sends one request per debounced query. Each request that reaches Mixedbread is one Mixedbread search request. Geistdocs does not cache search results.
|
|
6050
|
+
|
|
5869
6051
|
|
|
5870
6052
|
---
|
|
5871
6053
|
|
|
@@ -6120,7 +6302,7 @@ export const { GET } = createLlmsRoute({
|
|
|
6120
6302
|
});
|
|
6121
6303
|
```
|
|
6122
6304
|
|
|
6123
|
-
`filterPage` receives the page plus its language and source. Use the same synchronous filter function for every public aggregate route so `/llms.txt`, `sitemap.md`,
|
|
6305
|
+
`filterPage` receives the page plus its language and source. Use the same synchronous filter function for every public aggregate route so `/llms.txt`, `sitemap.md`, site search, Mixedbread search export, and Ask AI expose the same cacheable page set. Pass that function as `canViewPage` to `createDocsMarkdownRoute`. Request-specific HTML access belongs in `createDocsPage({ canViewPage })`; do not personalize public indexes.
|
|
6124
6306
|
|
|
6125
6307
|
## The llms.txt standard
|
|
6126
6308
|
|
package/docs/manifest.json
CHANGED
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
"description": "Learn about the environment variables used in Geistdocs",
|
|
31
31
|
"path": "pages/env.md",
|
|
32
32
|
"source": "apps/template/content/docs/env.mdx",
|
|
33
|
-
"summary": "Environment variables required by Geistdocs for AI chat, Mixedbread retrieval, proxy mode, eve agent session cookies, and production URL configuration.",
|
|
33
|
+
"summary": "Environment variables required by Geistdocs for AI chat, Mixedbread retrieval for Ask AI and site search, proxy mode, eve agent session cookies, and production URL configuration.",
|
|
34
34
|
"title": "Environment Variables",
|
|
35
35
|
"type": "reference",
|
|
36
36
|
"url": "/docs/env"
|
|
@@ -279,11 +279,11 @@
|
|
|
279
279
|
"url": "/docs/components/image"
|
|
280
280
|
},
|
|
281
281
|
{
|
|
282
|
-
"description": "Configure Mixedbread retrieval for
|
|
282
|
+
"description": "Configure Mixedbread semantic retrieval for Geistdocs Ask AI, site search, or both, and sync documentation to a site-specific Store",
|
|
283
283
|
"path": "pages/mixedbread-retrieval.md",
|
|
284
284
|
"source": "apps/template/content/docs/mixedbread-retrieval.mdx",
|
|
285
|
-
"summary": "Provision a Mixedbread Store for one Geistdocs consumer site,
|
|
286
|
-
"title": "Improve Ask AI
|
|
285
|
+
"summary": "Provision a Mixedbread Store for one Geistdocs consumer site, turn on semantic retrieval for Ask AI with ai.retrieval and for site search with search.provider, and sync documentation during production builds.",
|
|
286
|
+
"title": "Improve Ask AI and site search with Mixedbread",
|
|
287
287
|
"type": "guide",
|
|
288
288
|
"url": "/docs/mixedbread-retrieval"
|
|
289
289
|
},
|
|
@@ -467,5 +467,5 @@
|
|
|
467
467
|
}
|
|
468
468
|
],
|
|
469
469
|
"source": "apps/template/content/docs",
|
|
470
|
-
"version": "2.14.
|
|
470
|
+
"version": "2.14.7-canary.6ce58a6"
|
|
471
471
|
}
|
package/docs/pages/ask-ai.md
CHANGED
|
@@ -720,7 +720,7 @@ By default, the AI assistant includes a built-in `search_docs` tool that:
|
|
|
720
720
|
|
|
721
721
|
When `GEISTDOCS_CHAT_PROXY_URL` is set, Geistdocs runs local documentation retrieval on the first user message before forwarding the request to the configured proxy. This gives proxy-backed services access to the current page and related local documentation without requiring them to read the site's source files directly. With `contextInjection: "page-only"`, Geistdocs skips this retrieval.
|
|
722
722
|
|
|
723
|
-
Set `ai.retrieval` to `"mixedbread"` to replace local keyword retrieval with semantic retrieval for default, proxy, and hosted eve modes. Mixedbread returns the matching content chunk, while the AI model
|
|
723
|
+
Set `ai.retrieval` to `"mixedbread"` to replace local keyword retrieval with semantic retrieval for default, proxy, and hosted eve modes. Mixedbread returns the matching content chunk, while the AI model stays the same. Geistdocs falls back to local Orama retrieval when Mixedbread is unavailable. `ai.retrieval` does not change the search dialog. To serve site search from the same Store, set `search.provider` to `"mixedbread"` as well. Read [Improve Ask AI and site search with Mixedbread](/docs/mixedbread-retrieval) to provision a Store and configure production sync.
|
|
724
724
|
|
|
725
725
|
### Persistent Chat History
|
|
726
726
|
|
|
@@ -50,7 +50,10 @@ Read [Configure sidebar navigation](/docs/guides/nested-navigation) for page ord
|
|
|
50
50
|
The root `geistdocs.tsx` file is the primary configuration surface:
|
|
51
51
|
|
|
52
52
|
```tsx title="geistdocs.tsx"
|
|
53
|
-
import type {
|
|
53
|
+
import type {
|
|
54
|
+
GeistdocsNavbarBrand,
|
|
55
|
+
GeistdocsSearchConfig,
|
|
56
|
+
} from "@vercel/geistdocs/config";
|
|
54
57
|
|
|
55
58
|
export const navbarBrand: GeistdocsNavbarBrand = "vercel";
|
|
56
59
|
|
|
@@ -89,6 +92,8 @@ export const translations = {
|
|
|
89
92
|
en: { displayName: "English" },
|
|
90
93
|
};
|
|
91
94
|
|
|
95
|
+
export const search = {} satisfies GeistdocsSearchConfig;
|
|
96
|
+
|
|
92
97
|
export const basePath: string | undefined = undefined;
|
|
93
98
|
export const siteId: string | undefined = undefined;
|
|
94
99
|
```
|
|
@@ -157,6 +162,7 @@ import {
|
|
|
157
162
|
nav,
|
|
158
163
|
navbarBrand,
|
|
159
164
|
prompt,
|
|
165
|
+
search,
|
|
160
166
|
siteId,
|
|
161
167
|
suggestions,
|
|
162
168
|
title,
|
|
@@ -172,6 +178,7 @@ export const config = defineConfig({
|
|
|
172
178
|
nav,
|
|
173
179
|
navbarBrand,
|
|
174
180
|
basePath,
|
|
181
|
+
search,
|
|
175
182
|
siteId,
|
|
176
183
|
translations,
|
|
177
184
|
ai: {
|
|
@@ -208,7 +215,7 @@ export const config = defineConfig({
|
|
|
208
215
|
});
|
|
209
216
|
```
|
|
210
217
|
|
|
211
|
-
The `ai` config accepts `retrieval: "mixedbread"` to use semantic documentation retrieval and `eveAgent` to answer Ask AI requests with a hosted eve framework agent:
|
|
218
|
+
The `ai` config accepts `retrieval: "mixedbread"` to use semantic documentation retrieval for Ask AI and `eveAgent` to answer Ask AI requests with a hosted eve framework agent:
|
|
212
219
|
|
|
213
220
|
```tsx title="geistdocs.tsx"
|
|
214
221
|
export const ai = {
|
|
@@ -249,10 +256,26 @@ export const ai = {
|
|
|
249
256
|
|
|
250
257
|
The endpoint receives `{ messages, hostPath, summary? }` and must return `{ shareId }`. The public route at `path/<shareId>` must display the saved conversation. Both paths are app-local; Geistdocs adds `basePath` automatically. See [Share a conversation](/docs/ask-ai#share-a-conversation) for the full contract.
|
|
251
258
|
|
|
252
|
-
See [Ask AI](/docs/ask-ai) for the full eve agent mode behavior, including authentication, for moving the chat route adapter when you set `endpoint`, for what a `messageFeedback` vote sends, and for matching a production Vertex or eve setup with `toolLabels` and the server-only `createChatRoute` options. Read [Improve Ask AI
|
|
259
|
+
See [Ask AI](/docs/ask-ai) for the full eve agent mode behavior, including authentication, for moving the chat route adapter when you set `endpoint`, for what a `messageFeedback` vote sends, and for matching a production Vertex or eve setup with `toolLabels` and the server-only `createChatRoute` options. Read [Improve Ask AI and site search with Mixedbread](/docs/mixedbread-retrieval) before enabling semantic retrieval.
|
|
253
260
|
|
|
254
261
|
Use [Versioned docs](/docs/versioned-docs) for versioned source setup and [Proxy and markdown routes](/docs/proxy) for route mappings.
|
|
255
262
|
|
|
263
|
+
### Choose the site search provider
|
|
264
|
+
|
|
265
|
+
The `search` export selects the index behind the search dialog, `GET /api/search`, and the MCP `search_docs` tool. `provider` accepts `"local"`, the default, or `"mixedbread"`:
|
|
266
|
+
|
|
267
|
+
```tsx title="geistdocs.tsx"
|
|
268
|
+
import type { GeistdocsSearchConfig } from "@vercel/geistdocs/config";
|
|
269
|
+
|
|
270
|
+
export const search = {
|
|
271
|
+
provider: "mixedbread",
|
|
272
|
+
} satisfies GeistdocsSearchConfig;
|
|
273
|
+
```
|
|
274
|
+
|
|
275
|
+
`"mixedbread"` ranks results with the site's Mixedbread Store and renders every result from the running deployment. It needs a non-empty `siteId` and the server-only `MXBAI_API_KEY` and `MXBAI_STORE_ID` variables. Without them, or when a Mixedbread request fails, the search route answers from the local index. `search.provider` and `ai.retrieval` are independent, and `search.enabled` keeps its existing meaning.
|
|
276
|
+
|
|
277
|
+
The generated `lib/geistdocs/config.tsx` forwards `search` to `defineConfig`. A site created before this release adds the `search` export and the forward once. Without the forward, search stays local with no error. Read [Improve Ask AI and site search with Mixedbread](/docs/mixedbread-retrieval#use-mixedbread-for-site-search) for the full setup.
|
|
278
|
+
|
|
256
279
|
## Single-language sites
|
|
257
280
|
|
|
258
281
|
A site with one language can drop the `[lang]` route segment by setting `singleLanguage: true` in `defineConfig`. Routes then live directly under `app/`, the proxy skips locale rewrites, and route factories resolve every request to `defaultLanguage`. `translations` may only list `defaultLanguage`. Public URLs, `.md` routes, `llms.txt`, and `agents.md` keep their paths.
|
package/docs/pages/env.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: Environment Variables
|
|
3
3
|
description: Learn about the environment variables used in Geistdocs
|
|
4
4
|
type: reference
|
|
5
|
-
summary: Environment variables required by Geistdocs for AI chat, Mixedbread retrieval, proxy mode, eve agent session cookies, and production URL configuration.
|
|
5
|
+
summary: Environment variables required by Geistdocs for AI chat, Mixedbread retrieval for Ask AI and site search, proxy mode, eve agent session cookies, and production URL configuration.
|
|
6
6
|
url: /docs/env
|
|
7
7
|
source: apps/template/content/docs/env.mdx
|
|
8
8
|
prerequisites:
|
|
@@ -14,7 +14,7 @@ related:
|
|
|
14
14
|
|
|
15
15
|
# Environment Variables
|
|
16
16
|
|
|
17
|
-
Geistdocs uses environment variables to configure Ask AI, optional Mixedbread retrieval, optional Vertex-backed proxy mode, eve agent session cookie signing, and production URL behavior.
|
|
17
|
+
Geistdocs uses environment variables to configure Ask AI, optional Mixedbread retrieval for Ask AI and site search, optional Vertex-backed proxy mode, eve agent session cookie signing, and production URL behavior.
|
|
18
18
|
|
|
19
19
|
Review this Geistdocs project and help me configure the required environment variables. Check whether `AI_GATEWAY_API_KEY`, `MXBAI_API_KEY`, `MXBAI_STORE_ID`, `GEISTDOCS_CHAT_PROXY_URL`, `GEISTDOCS_CHAT_PROXY_TOKEN`, `GEISTDOCS_CHAT_SECRET`, and `NEXT_PUBLIC_VERCEL_PROJECT_PRODUCTION_URL` are needed for the features I enabled, then tell me where to set them locally and on Vercel.
|
|
20
20
|
|
|
@@ -28,13 +28,13 @@ Leave `GEISTDOCS_CHAT_PROXY_URL` unset to use AI Gateway mode.
|
|
|
28
28
|
|
|
29
29
|
## `MXBAI_API_KEY`
|
|
30
30
|
|
|
31
|
-
The server-only API key for Mixedbread retrieval. The Mixedbread Vercel Marketplace integration injects this value when you provision a Store and connect it to the consumer site's Vercel project.
|
|
31
|
+
The server-only API key for Mixedbread retrieval, used by Ask AI and site search. The Mixedbread Vercel Marketplace integration injects this value when you provision a Store and connect it to the consumer site's Vercel project.
|
|
32
32
|
|
|
33
33
|
## `MXBAI_STORE_ID`
|
|
34
34
|
|
|
35
|
-
The Mixedbread Store used by one consumer site.
|
|
35
|
+
The Mixedbread Store used by one consumer site. Configure a unique `siteId`, then set `ai.retrieval`, `search.provider`, or both to `"mixedbread"` before using this value. Ask AI and site search share this Store and `MXBAI_API_KEY`. When either value or `siteId` is missing at runtime, each surface that uses Mixedbread answers from local search instead.
|
|
36
36
|
|
|
37
|
-
Provision the Store by running `vercel integration add mixedbread` from the root of the consumer site's repository, where Vercel CLI is linked to that site's project. Do not run the provisioning command from the Geistdocs package repository. Read [Improve Ask AI
|
|
37
|
+
Provision the Store by running `vercel integration add mixedbread` from the root of the consumer site's repository, where Vercel CLI is linked to that site's project. Do not run the provisioning command from the Geistdocs package repository. Read [Improve Ask AI and site search with Mixedbread](/docs/mixedbread-retrieval) for the complete setup.
|
|
38
38
|
|
|
39
39
|
## `GEISTDOCS_CHAT_PROXY_URL`
|
|
40
40
|
|
package/docs/pages/index.md
CHANGED
|
@@ -78,7 +78,7 @@ Advanced projects can use package APIs for versioned docs, multiple content sour
|
|
|
78
78
|
- MDX documentation with custom components
|
|
79
79
|
- Local content in `content/docs`
|
|
80
80
|
- Search and Ask AI
|
|
81
|
-
- Optional Mixedbread semantic retrieval for Ask AI
|
|
81
|
+
- Optional Mixedbread semantic retrieval for Ask AI and site search
|
|
82
82
|
- Page actions, including feedback, copy page, open in chat, and edit on GitHub
|
|
83
83
|
- Agent-readiness metadata with `/agents.md` and `/.well-known/mcp.json`
|
|
84
84
|
- Raw Markdown routes for AI tools
|
package/docs/pages/llms-txt.md
CHANGED
|
@@ -82,7 +82,7 @@ export const { GET } = createLlmsRoute({
|
|
|
82
82
|
});
|
|
83
83
|
```
|
|
84
84
|
|
|
85
|
-
`filterPage` receives the page plus its language and source. Use the same synchronous filter function for every public aggregate route so `/llms.txt`, `sitemap.md`,
|
|
85
|
+
`filterPage` receives the page plus its language and source. Use the same synchronous filter function for every public aggregate route so `/llms.txt`, `sitemap.md`, site search, Mixedbread search export, and Ask AI expose the same cacheable page set. Pass that function as `canViewPage` to `createDocsMarkdownRoute`. Request-specific HTML access belongs in `createDocsPage({ canViewPage })`; do not personalize public indexes.
|
|
86
86
|
|
|
87
87
|
## The llms.txt standard
|
|
88
88
|
|