Skip to content

Commit 4e6003d

Browse files
Merge pull request #136 from sqlitecloud/stage
feat(aisearch): aisearch-action guide
2 parents e9eab67 + b5c46c1 commit 4e6003d

File tree

2 files changed

+416
-67
lines changed

2 files changed

+416
-67
lines changed

sqlite-cloud/_nav.ts

Lines changed: 283 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -3,86 +3,302 @@ import type { SidebarNavStruct } from "@docs-website/types/sidebar-navigation";
33
const sidebarNav: SidebarNavStruct = [
44
{ title: "", type: "primary" },
55
// ### AI ###
6-
{ title: "AI", type: "secondary", icon: "docs-star",},
6+
{ title: "AI", type: "secondary", icon: "docs-star" },
77
{ title: "Overview", filePath: "ai-overview", type: "inner", level: 0 },
88
{ title: "SQLite-AI", filePath: "sqlite-ai", type: "inner", level: 0 },
99
{ title: "SQLite-JS", filePath: "sqlite-js", type: "inner", level: 0 },
1010
{ title: "SQLite-Sync", type: "inner", level: 0 },
11-
{ title: "Introduction", filePath: "sqlite-sync-introduction", type: "inner", level: 1 },
12-
{ title: "Getting Started", filePath: "sqlite-sync-getting-started", type: "inner", level: 1 },
13-
{ title: "Best Practices", filePath: "sqlite-sync-best-practices", type: "inner", level: 1 },
14-
{ title: "Quick Starts", type: "inner", level: 1 },
15-
{ title: "Android", filePath: "sqlite-sync-quick-start-android", type: "inner", level: 2 },
16-
{ title: "iOS", filePath: "sqlite-sync-quick-start-ios", type: "inner", level: 2 },
17-
{ title: "Linux", filePath: "sqlite-sync-quick-start-linux", type: "inner", level: 2 },
18-
{ title: "macOS", filePath: "sqlite-sync-quick-start-macos", type: "inner", level: 2 },
19-
{ title: "React Native Expo", filePath: "sqlite-sync-quick-start-expo", type: "inner", level: 2 },
20-
{ title: "WASM", filePath: "sqlite-sync-quick-start-wasm", type: "inner", level: 2 },
21-
{ title: "Windows", filePath: "sqlite-sync-quick-start-windows", type: "inner", level: 2 },
22-
{ title: "API Reference", type: "inner", level: 1 },
23-
{ title: "cloudsync_init", filePath: "sqlite-sync-api-cloudsync-init", type: "inner", level: 2 },
24-
{ title: "cloudsync_enable", filePath: "sqlite-sync-api-cloudsync-enable", type: "inner", level: 2 },
25-
{ title: "cloudsync_disable", filePath: "sqlite-sync-api-cloudsync-disable", type: "inner", level: 2 },
26-
{ title: "cloudsync_is_enabled", filePath: "sqlite-sync-api-cloudsync-is-enabled", type: "inner", level: 2 },
27-
{ title: "cloudsync_cleanup", filePath: "sqlite-sync-api-cloudsync-cleanup", type: "inner", level: 2 },
28-
{ title: "cloudsync_terminate", filePath: "sqlite-sync-api-cloudsync-terminate", type: "inner", level: 2 },
29-
{ title: "cloudsync_version", filePath: "sqlite-sync-api-cloudsync-version", type: "inner", level: 2 },
30-
{ title: "cloudsync_siteid", filePath: "sqlite-sync-api-cloudsync-siteid", type: "inner", level: 2 },
31-
{ title: "cloudsync_db_version", filePath: "sqlite-sync-api-cloudsync-db-version", type: "inner", level: 2 },
32-
{ title: "cloudsync_uuid", filePath: "sqlite-sync-api-cloudsync-uuid", type: "inner", level: 2 },
33-
{ title: "cloudsync_begin_alter", filePath: "sqlite-sync-api-cloudsync-begin-alter", type: "inner", level: 2 },
34-
{ title: "cloudsync_commit_alter", filePath: "sqlite-sync-api-cloudsync-commit-alter", type: "inner", level: 2 },
35-
{ title: "cloudsync_network_init", filePath: "sqlite-sync-api-cloudsync-network-init", type: "inner", level: 2 },
36-
{ title: "cloudsync_network_cleanup", filePath: "sqlite-sync-api-cloudsync-network-cleanup", type: "inner", level: 2 },
37-
{ title: "cloudsync_network_set_token", filePath: "sqlite-sync-api-cloudsync-network-set-token", type: "inner", level: 2 },
38-
{ title: "cloudsync_network_set_apikey", filePath: "sqlite-sync-api-cloudsync-network-set-apikey", type: "inner", level: 2 },
39-
{ title: "cloudsync_network_has_unsent_changes", filePath: "sqlite-sync-api-cloudsync-network-has-unsent-changes", type: "inner", level: 2 },
40-
{ title: "cloudsync_network_send_changes", filePath: "sqlite-sync-api-cloudsync-network-send-changes", type: "inner", level: 2 },
41-
{ title: "cloudsync_network_check_changes", filePath: "sqlite-sync-api-cloudsync-network-check-changes", type: "inner", level: 2 },
42-
{ title: "cloudsync_network_sync", filePath: "sqlite-sync-api-cloudsync-network-sync", type: "inner", level: 2 },
43-
{ title: "cloudsync_network_reset_sync_version", filePath: "sqlite-sync-api-cloudsync-network-reset-sync-version", type: "inner", level: 2 },
44-
{ title: "cloudsync_network_logout", filePath: "sqlite-sync-api-cloudsync-network-logout", type: "inner", level: 2 },
45-
{ title: "SQLite-Vector", filePath: "sqlite-vector", type: "inner", level: 0 },
46-
{ title: "MCP (Model Context Protocol)", filePath: "mcp-server", type: "inner", level: 0 },
11+
{
12+
title: "Introduction",
13+
filePath: "sqlite-sync-introduction",
14+
type: "inner",
15+
level: 1,
16+
},
17+
{
18+
title: "Getting Started",
19+
filePath: "sqlite-sync-getting-started",
20+
type: "inner",
21+
level: 1,
22+
},
23+
{
24+
title: "Best Practices",
25+
filePath: "sqlite-sync-best-practices",
26+
type: "inner",
27+
level: 1,
28+
},
29+
{ title: "Quick Starts", type: "inner", level: 1 },
30+
{
31+
title: "Android",
32+
filePath: "sqlite-sync-quick-start-android",
33+
type: "inner",
34+
level: 2,
35+
},
36+
{
37+
title: "iOS",
38+
filePath: "sqlite-sync-quick-start-ios",
39+
type: "inner",
40+
level: 2,
41+
},
42+
{
43+
title: "Linux",
44+
filePath: "sqlite-sync-quick-start-linux",
45+
type: "inner",
46+
level: 2,
47+
},
48+
{
49+
title: "macOS",
50+
filePath: "sqlite-sync-quick-start-macos",
51+
type: "inner",
52+
level: 2,
53+
},
54+
{
55+
title: "React Native Expo",
56+
filePath: "sqlite-sync-quick-start-expo",
57+
type: "inner",
58+
level: 2,
59+
},
60+
{
61+
title: "WASM",
62+
filePath: "sqlite-sync-quick-start-wasm",
63+
type: "inner",
64+
level: 2,
65+
},
66+
{
67+
title: "Windows",
68+
filePath: "sqlite-sync-quick-start-windows",
69+
type: "inner",
70+
level: 2,
71+
},
72+
{ title: "API Reference", type: "inner", level: 1 },
73+
{
74+
title: "cloudsync_init",
75+
filePath: "sqlite-sync-api-cloudsync-init",
76+
type: "inner",
77+
level: 2,
78+
},
79+
{
80+
title: "cloudsync_enable",
81+
filePath: "sqlite-sync-api-cloudsync-enable",
82+
type: "inner",
83+
level: 2,
84+
},
85+
{
86+
title: "cloudsync_disable",
87+
filePath: "sqlite-sync-api-cloudsync-disable",
88+
type: "inner",
89+
level: 2,
90+
},
91+
{
92+
title: "cloudsync_is_enabled",
93+
filePath: "sqlite-sync-api-cloudsync-is-enabled",
94+
type: "inner",
95+
level: 2,
96+
},
97+
{
98+
title: "cloudsync_cleanup",
99+
filePath: "sqlite-sync-api-cloudsync-cleanup",
100+
type: "inner",
101+
level: 2,
102+
},
103+
{
104+
title: "cloudsync_terminate",
105+
filePath: "sqlite-sync-api-cloudsync-terminate",
106+
type: "inner",
107+
level: 2,
108+
},
109+
{
110+
title: "cloudsync_version",
111+
filePath: "sqlite-sync-api-cloudsync-version",
112+
type: "inner",
113+
level: 2,
114+
},
115+
{
116+
title: "cloudsync_siteid",
117+
filePath: "sqlite-sync-api-cloudsync-siteid",
118+
type: "inner",
119+
level: 2,
120+
},
121+
{
122+
title: "cloudsync_db_version",
123+
filePath: "sqlite-sync-api-cloudsync-db-version",
124+
type: "inner",
125+
level: 2,
126+
},
127+
{
128+
title: "cloudsync_uuid",
129+
filePath: "sqlite-sync-api-cloudsync-uuid",
130+
type: "inner",
131+
level: 2,
132+
},
133+
{
134+
title: "cloudsync_begin_alter",
135+
filePath: "sqlite-sync-api-cloudsync-begin-alter",
136+
type: "inner",
137+
level: 2,
138+
},
139+
{
140+
title: "cloudsync_commit_alter",
141+
filePath: "sqlite-sync-api-cloudsync-commit-alter",
142+
type: "inner",
143+
level: 2,
144+
},
145+
{
146+
title: "cloudsync_network_init",
147+
filePath: "sqlite-sync-api-cloudsync-network-init",
148+
type: "inner",
149+
level: 2,
150+
},
151+
{
152+
title: "cloudsync_network_cleanup",
153+
filePath: "sqlite-sync-api-cloudsync-network-cleanup",
154+
type: "inner",
155+
level: 2,
156+
},
157+
{
158+
title: "cloudsync_network_set_token",
159+
filePath: "sqlite-sync-api-cloudsync-network-set-token",
160+
type: "inner",
161+
level: 2,
162+
},
163+
{
164+
title: "cloudsync_network_set_apikey",
165+
filePath: "sqlite-sync-api-cloudsync-network-set-apikey",
166+
type: "inner",
167+
level: 2,
168+
},
169+
{
170+
title: "cloudsync_network_has_unsent_changes",
171+
filePath: "sqlite-sync-api-cloudsync-network-has-unsent-changes",
172+
type: "inner",
173+
level: 2,
174+
},
175+
{
176+
title: "cloudsync_network_send_changes",
177+
filePath: "sqlite-sync-api-cloudsync-network-send-changes",
178+
type: "inner",
179+
level: 2,
180+
},
181+
{
182+
title: "cloudsync_network_check_changes",
183+
filePath: "sqlite-sync-api-cloudsync-network-check-changes",
184+
type: "inner",
185+
level: 2,
186+
},
187+
{
188+
title: "cloudsync_network_sync",
189+
filePath: "sqlite-sync-api-cloudsync-network-sync",
190+
type: "inner",
191+
level: 2,
192+
},
193+
{
194+
title: "cloudsync_network_reset_sync_version",
195+
filePath: "sqlite-sync-api-cloudsync-network-reset-sync-version",
196+
type: "inner",
197+
level: 2,
198+
},
199+
{
200+
title: "cloudsync_network_logout",
201+
filePath: "sqlite-sync-api-cloudsync-network-logout",
202+
type: "inner",
203+
level: 2,
204+
},
205+
{
206+
title: "SQLite-Vector",
207+
filePath: "sqlite-vector",
208+
type: "inner",
209+
level: 0,
210+
},
211+
{
212+
title: "MCP (Model Context Protocol)",
213+
filePath: "mcp-server",
214+
type: "inner",
215+
level: 0,
216+
},
217+
{
218+
title: "AI-Powered Docs Search",
219+
filePath: "aisearch-documents",
220+
type: "inner",
221+
level: 0,
222+
},
47223

48224
// ### CLOUD ###
49-
{ title: "Cloud", type: "secondary", icon: "docs-star",},
225+
{ title: "Cloud", type: "secondary", icon: "docs-star" },
50226
{ title: "Overview", filePath: "overview", type: "inner", level: 0 },
51227
{ title: "Scaling", filePath: "architecture", type: "inner", level: 0 },
52228
{ title: "Getting Started", type: "inner", level: 0 },
53-
{ title: "Connecting", filePath: "connect-cluster", type: "inner", level: 1 },
54-
{ title: "Creating a database", filePath: "create-database", type: "inner", level: 1 },
55-
{ title: "Writing data", filePath: "write-data", type: "inner", level: 1 },
229+
{ title: "Connecting", filePath: "connect-cluster", type: "inner", level: 1 },
230+
{
231+
title: "Creating a database",
232+
filePath: "create-database",
233+
type: "inner",
234+
level: 1,
235+
},
236+
{ title: "Writing data", filePath: "write-data", type: "inner", level: 1 },
56237
{ title: "Quick Start Guides", type: "inner", level: 0 },
57-
{ title: "CDN", filePath: "quick-start-cdn", type: "inner", level: 1 },
58-
{ title: "Node.js", filePath: "quick-start-node", type: "inner", level: 1 },
59-
{ title: "React", filePath: "quick-start-react", type: "inner", level: 1 },
60-
{ title: "React Native", filePath: "quick-start-react-native", type: "inner", level: 1 },
61-
{ title: "Apollo / GraphQL", filePath: "quick-start-apollo-graphql", type: "inner", level: 1 },
62-
{ title: "Next.js", filePath: "quick-start-next", type: "inner", level: 1 },
63-
{ title: "Django", filePath: "quick-start-django", type: "inner", level: 1 },
64-
{ title: "Flask", filePath: "quick-start-flask", type: "inner", level: 1 },
65-
{ title: "SQLAlchemy", filePath: "quick-start-sqlalchemy-orm", type: "inner", level: 1 },
66-
{ title: "Streamlit", filePath: "quick-start-streamlit", type: "inner", level: 1 },
67-
{ title: "PHP / Laravel", filePath: "quick-start-php-laravel", type: "inner", level: 1 },
68-
{ title: "Gin", filePath: "quick-start-gin", type: "inner", level: 1 },
69-
{ title: "Knex.js", filePath: "quick-start-knex", type: "inner", level: 1 },
238+
{ title: "CDN", filePath: "quick-start-cdn", type: "inner", level: 1 },
239+
{ title: "Node.js", filePath: "quick-start-node", type: "inner", level: 1 },
240+
{ title: "React", filePath: "quick-start-react", type: "inner", level: 1 },
241+
{
242+
title: "React Native",
243+
filePath: "quick-start-react-native",
244+
type: "inner",
245+
level: 1,
246+
},
247+
{
248+
title: "Apollo / GraphQL",
249+
filePath: "quick-start-apollo-graphql",
250+
type: "inner",
251+
level: 1,
252+
},
253+
{ title: "Next.js", filePath: "quick-start-next", type: "inner", level: 1 },
254+
{ title: "Django", filePath: "quick-start-django", type: "inner", level: 1 },
255+
{ title: "Flask", filePath: "quick-start-flask", type: "inner", level: 1 },
256+
{
257+
title: "SQLAlchemy",
258+
filePath: "quick-start-sqlalchemy-orm",
259+
type: "inner",
260+
level: 1,
261+
},
262+
{
263+
title: "Streamlit",
264+
filePath: "quick-start-streamlit",
265+
type: "inner",
266+
level: 1,
267+
},
268+
{
269+
title: "PHP / Laravel",
270+
filePath: "quick-start-php-laravel",
271+
type: "inner",
272+
level: 1,
273+
},
274+
{ title: "Gin", filePath: "quick-start-gin", type: "inner", level: 1 },
275+
{ title: "Knex.js", filePath: "quick-start-knex", type: "inner", level: 1 },
70276

71277
// ### PLATFORM ###
72278
{ title: "Platform", type: "secondary", icon: "docs-plat" },
73-
{ title: "Edge Functions", filePath: "edge-functions", type: "inner", level: 0 },
74-
{ title: "Webhooks", filePath: "webhooks", type: "inner", level: 0 },
75-
{ title: "Pub/Sub", filePath: "pub-sub", type: "inner", level: 0 },
76-
//{ title: "Vector", filePath: "vector", type: "inner", level: 0 },
77-
{ title: "Users and Roles", filePath: "security", type: "inner", level: 0 },
78-
{ title: "API Keys", filePath: "apikey", type: "inner", level: 0 },
79-
{ title: "Row-Level Security", filePath: "rls", type: "inner", level: 0},
80-
{ title: "OffSync", filePath: "offsync", type: "inner", level: 0 },
81-
{ title: "Access Tokens", filePath: "access-tokens", type: "inner", level: 0 },
82-
{ title: "Backups", filePath: "backups", type: "inner", level: 0 },
83-
{ title: "Query Analyzer", filePath: "analyzer", type: "inner", level: 0 },
84-
{ title: "Extensions", filePath: "extensions", type: "inner", level: 0 },
85-
{ title: "Weblite (REST API)", filePath: "weblite", type: "inner", level: 0 },
279+
{
280+
title: "Edge Functions",
281+
filePath: "edge-functions",
282+
type: "inner",
283+
level: 0,
284+
},
285+
{ title: "Webhooks", filePath: "webhooks", type: "inner", level: 0 },
286+
{ title: "Pub/Sub", filePath: "pub-sub", type: "inner", level: 0 },
287+
//{ title: "Vector", filePath: "vector", type: "inner", level: 0 },
288+
{ title: "Users and Roles", filePath: "security", type: "inner", level: 0 },
289+
{ title: "API Keys", filePath: "apikey", type: "inner", level: 0 },
290+
{ title: "Row-Level Security", filePath: "rls", type: "inner", level: 0 },
291+
{ title: "OffSync", filePath: "offsync", type: "inner", level: 0 },
292+
{
293+
title: "Access Tokens",
294+
filePath: "access-tokens",
295+
type: "inner",
296+
level: 0,
297+
},
298+
{ title: "Backups", filePath: "backups", type: "inner", level: 0 },
299+
{ title: "Query Analyzer", filePath: "analyzer", type: "inner", level: 0 },
300+
{ title: "Extensions", filePath: "extensions", type: "inner", level: 0 },
301+
{ title: "Weblite (REST API)", filePath: "weblite", type: "inner", level: 0 },
86302

87303
// ### CLOUD SDK ###
88304
{ title: "Cloud SDK", type: "secondary", icon: "docs-sdk" },

0 commit comments

Comments
 (0)