Skip to content

Commit 2629493

Browse files
committed
Restructure and reorganize documentation
Moved and renamed documentation files to new topic-based directories (ai, data-access, logic, modeling, server, reference, getting-started). Added meta.json files for navigation. Removed outdated or redundant docs including contributing, development plan, and example/tutorial files. Updated frontmatter in AI and data-access docs for improved descriptions.
1 parent ee29788 commit 2629493

File tree

95 files changed

+909
-7978
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+909
-7978
lines changed

apps/site/content/docs/ai/building-apps.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Building AI-Native Apps
3+
description: Learn how to build AI-native applications with ObjectQL
34
---
45

5-
# Building AI-Native Apps
6-
76
ObjectQL is engineered to be the ideal data layer for AI Agents and LLMs. By providing a **Structure-First** protocol (JSON AST) instead of raw strings (SQL), it drastically reduces hallucinations and injection risks.
87

98
## 1. Why ObjectQL for AI?

apps/site/content/docs/ai/cli-usage.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: AI-Powered CLI
3+
description: Use AI commands in the ObjectQL CLI
34
---
45

5-
# AI-Powered CLI
6-
76
The ObjectQL CLI provides AI-powered commands to generate and validate applications using natural language.
87

98
## Overview

apps/site/content/docs/ai/coding-assistant.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: AI Coding Assistant Guide
3+
description: Configure your AI assistant for ObjectQL
34
---
45

5-
# AI Coding Assistant Guide
6-
76
One of the core design goals of ObjectQL is to be the **most LLM-friendly backend protocol**.
87

98
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`).

apps/site/content/docs/ai/generating-apps.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Generating Apps with AI
3+
description: Generate complete applications with LLMs
34
---
45

5-
# Generating Apps with AI
6-
76
Because ObjectQL applications are defined primarily by **Metadata** (YAML/JSON) rather than **Code** (Classes/Functions), LLMs can generate complete, working backends in a single pass.
87

98
This is "Zero-Shot Microservice Generation".

apps/site/content/docs/ai/index.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: AI-Native Development
3+
description: ObjectQL as the AI-Native data layer
34
---
45

5-
# AI-Native Development
6-
76
ObjectQL resides at the intersection of Data and Artificial Intelligence. It is designed to be "AI-Native" in two distinct ways:
87

98
1. **For AI Agents**: It serves as the perfect structured memory system (Long-term Memory) and tool interface for AI agents.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"title": "AI Integration",
3+
"pages": [
4+
"index",
5+
"building-apps",
6+
"generating-apps",
7+
"coding-assistant",
8+
"programmatic-api",
9+
"cli-usage"
10+
]
11+
}

apps/site/content/docs/ai/programmatic-api.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Programmatic AI API
3+
description: Generate applications programmatically
34
---
45

5-
# Programmatic AI API
6-
76
The ObjectQL AI Agent provides a programmatic API for generating and validating applications in your Node.js code.
87

98
## Overview

0 commit comments

Comments
 (0)