Skip to content

Commit 28c08d3

Browse files
committed
添加 AI 集成文档,重构导航和侧边栏,删除过时的 AI 相关指南
1 parent aed2d71 commit 28c08d3

5 files changed

Lines changed: 40 additions & 4 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,24 @@ export default defineConfig({
1515
// Top Navigation
1616
nav: [
1717
{ text: 'Guide', link: '/guide/' },
18+
{ text: 'AI', link: '/ai/' },
1819
{ text: 'Protocol', link: '/spec/' },
1920
],
2021

2122
// Sidebar Configuration
2223
sidebar: {
24+
// Sidebar for AI section
25+
'/ai/': [
26+
{
27+
text: 'AI Integration',
28+
items: [
29+
{ text: 'Overview', link: '/ai/' },
30+
{ text: 'Building AI Apps', link: '/ai/building-apps' },
31+
{ text: 'AI Coding Assistant', link: '/ai/coding-assistant' },
32+
]
33+
}
34+
],
35+
2336
// Sidebar for Guide section
2437
'/guide/': [
2538
{
@@ -46,8 +59,6 @@ export default defineConfig({
4659
{ text: 'Writing Hooks', link: '/guide/logic-hooks' },
4760
{ text: 'Custom Actions', link: '/guide/logic-actions' },
4861
{ text: 'Plugin System', link: '/guide/plugins' },
49-
{ text: 'Building AI Apps', link: '/guide/ai' },
50-
{ text: 'AI Coding Assistant', link: '/guide/ai-coding' },
5162
{ text: 'CLI Tools', link: '/guide/cli' }
5263
]
5364
}
File renamed without changes.
File renamed without changes.

docs/ai/index.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# AI Integration
2+
3+
ObjectQL resides at the intersection of Data and Artificial Intelligence. It is designed to be "AI-Native" in two distinct ways:
4+
5+
1. **For AI Agents**: It serves as the perfect structured memory system (Long-term Memory) and tool interface for AI agents.
6+
2. **By AI Agents**: Its metadata-driven, protocol-first architecture makes it incredibly easy for LLMs to write valid code for it.
7+
8+
## Overview
9+
10+
### 🏗️ Building AI Apps
11+
Learn how to use ObjectQL as the data engine for your RAG (Retrieval-Augmented Generation) applications, semantic search, and AI agents.
12+
13+
* [Semantic Search & RAG](/ai/building-apps#semantic-search-rag)
14+
* [Vector Database Features](/ai/building-apps#configuration)
15+
* [Agent Tooling](/ai/building-apps)
16+
17+
[Read Guide →](/ai/building-apps)
18+
19+
### 🤖 AI Coding Assistant
20+
Learn how to configure GitHub Copilot, Cursor, or Windsurf to become an expert ObjectQL developer. We provide specialized System Prompts that teach the LLM our protocol.
21+
22+
* [Standard System Prompt](/ai/coding-assistant#standard-system-prompt-system-prompt)
23+
* [IDE Configuration](/ai/coding-assistant#如何在工具中使用)
24+
25+
[Get Prompts →](/ai/coding-assistant)

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ hero:
1414
link: /guide/getting-started
1515
- theme: alt
1616
text: AI Integration
17-
link: /guide/ai-coding
17+
link: /ai/
1818

1919
features:
2020
- icon: 🤖
@@ -51,5 +51,5 @@ Traditional ORMs (Sequelize, TypeORM, Prisma) were designed for humans to write
5151
## Get Started
5252

5353
* **[Installation & Hello World](/guide/getting-started)**: Build your first API in 5 minutes.
54-
* **[Building AI Apps](/guide/ai)**: Learn how to connect GPT-4 to your database safely.
54+
* **[Building AI Apps](/ai/building-apps)**: Learn how to connect GPT-4 to your database safely.
5555
* **[Core Concepts](/guide/data-modeling)**: Define Objects, Fields, and Relationships.

0 commit comments

Comments
 (0)