You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Revise and expand AI coding assistant documentation
Updated the AI coding assistant guide to use English, expanded protocol and usage instructions, clarified ObjectQL best practices, and added detailed examples for app and object definitions, CRUD operations, and business logic. Also updated links and section titles in the index for consistency with the new documentation structure.
One of the core design goals of ObjectQL is to be the **most LLM-friendly backend protocol**.
4
4
5
-
如果你使用 **Cursor**、**GitHub Copilot Chat**、**Windsurf** 或**ChatGPT**进行开发,请将以下 **System Prompt**复制到你的 AI 配置或项目规则(如 `.cursorrules`)中。这能让 AI 准确理解 ObjectQL 的语法和最佳实践。
5
+
If you are using **Cursor**, **GitHub Copilot Chat**, **Windsurf**, or**ChatGPT**for development, please copy the following **System Prompt**into your AI configuration or project rules (e.g., `.cursorrules`). This allows the AI to accurately understand ObjectQL's syntax and best practices.
6
6
7
-
## 标准系统提示词 (System Prompt)
7
+
## Standard System Prompt
8
8
9
-
点击右上角的复制按钮即可获取完整的提示词:
9
+
Click the copy button in the top right to get the full prompt:
10
10
11
11
````text
12
12
You are an expert developer specializing in **ObjectQL**, a metadata-driven, low-code backend engine.
13
13
14
14
### Core Principles
15
-
1. **Metadata First**: Data models are defined in YAML/JSON, not classes.
15
+
1. **Metadata First**: Data models and application structure are defined in YAML/JSON, not classes.
16
16
2. **Protocol First**: Queries are strict JSON ASTs, not SQL strings.
17
17
3. **Instance Naming**: Always name the ObjectQL instance `app`, NEVER `db` (e.g., `const app = new ObjectQL(...)`).
18
+
4. **Context-Driven**: All data operations require an execution context (e.g., `const ctx = app.createContext({})`).
18
19
19
-
### 1. Object Definition (Schema)
20
-
When asked to define an object, use the YAML format (`name.object.yml`).
Copy file name to clipboardExpand all lines: docs/ai/index.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,6 @@ Learn how to use ObjectQL as the data engine for your RAG (Retrieval-Augmented G
20
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
21
22
22
*[Standard System Prompt](/ai/coding-assistant#standard-system-prompt-system-prompt)
0 commit comments