Skip to content

Commit 0e998af

Browse files
committed
更新文档:重命名“Menus & Navigation”为“Applications & Navigation”,并删除冗余的README.md文件
1 parent c0a3e6b commit 0e998af

3 files changed

Lines changed: 42 additions & 306 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ export default defineConfig({
116116
{ text: 'Views & Layouts', link: '/spec/view' },
117117
{ text: 'Forms', link: '/spec/form' },
118118
{ text: 'Reports & Dashboards', link: '/spec/report' },
119-
{ text: 'Menus & Navigation', link: '/spec/menu' },
119+
{ text: 'Applications & Navigation', link: '/spec/application' },
120120
]
121121
},
122122
{

docs/spec/README.md

Lines changed: 0 additions & 292 deletions
This file was deleted.

docs/spec/index.md

Lines changed: 41 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,59 @@
1-
# Metadata Specifications
1+
# ObjectQL Metadata Specifications
22

33
This section contains the complete metadata specifications for the ObjectQL platform. ObjectQL is a metadata-driven standard for enterprise applications - every aspect of your application is defined through structured metadata.
44

55
📖 **[Read the Complete Metadata Standard Guide](./metadata-standard.md)** - A comprehensive overview of the entire metadata system and how all pieces fit together.
66

7-
## Core Data Layer
7+
## 🤖 AI-Native Metadata Design
8+
9+
ObjectQL metadata is designed from the ground up to be **AI-friendly**, enabling:
10+
11+
- **Better Code Generation**: AI tools understand business intent, not just syntax
12+
- **Natural Language Queries**: Convert user questions to structured queries
13+
- **Auto-Documentation**: Generate comprehensive docs from metadata
14+
- **Smart Validation**: AI suggests improvements and catches errors
15+
- **Realistic Test Data**: Generate test data following proper patterns
16+
17+
### AI Context Blocks
18+
19+
All metadata types support optional `ai_context` blocks that provide semantic information:
20+
21+
```yaml
22+
# Example: Object with AI context
23+
name: project
24+
fields:
25+
status:
26+
type: select
27+
options: [planning, active, completed]
28+
29+
ai_context:
30+
intent: "Track project through its lifecycle"
31+
is_state_machine: true
32+
transitions:
33+
planning: [active, cancelled]
34+
active: [completed, cancelled]
35+
```
36+
37+
## 🗂️ Specification Categories
838
9-
* [**Objects & Fields**](./object.md) - Data model definitions, field types, relationships, and validation rules
39+
### Core Data Layer
40+
* [**Objects & Fields**](./object.md) - Data model definitions, field types, relationships, and validation
1041
* [**Query Language (JSON-DSL)**](./query-language.md) - Unified query protocol for database-agnostic data access
1142
* [**Validation Rules**](./validation.md) - Data quality and business rule enforcement
1243
13-
## Business Logic Layer
14-
44+
### Business Logic Layer
1545
* [**Hooks (Triggers)**](./hook.md) - Event-driven logic attached to data operations
1646
* [**Actions (RPC)**](./action.md) - Custom server-side functions and APIs
1747
* [**Workflows & Processes**](./workflow.md) - Automated business processes and approval chains
1848
19-
## Presentation Layer
20-
21-
* [**Views & Layouts**](./view.md) - Data presentation configurations (list, grid, kanban, calendar)
49+
### Presentation Layer
50+
* [**Views & Layouts**](./view.md) - Data presentation configurations
2251
* [**Forms**](./form.md) - Data entry and editing interfaces
23-
* [**Reports & Dashboards**](./report.md) - Analytics, visualizations, and business intelligence
24-
* [**Applications & Navigation**](./application.md) - Application structure and menu hierarchy
25-
26-
## Security & Access Control
52+
* [**Reports & Dashboards**](./report.md) - Analytics and BI
53+
* [**Applications & Navigation**](./application.md) - App identity, navigation structure, and context
2754
28-
* [**Permissions**](./permission.md) - Role-based access control, field-level security, and record-level rules
55+
### Security & Access Control
56+
* [**Permissions**](./permission.md) - Role-based access control and security rules
2957
3058
## Design Philosophy
3159

0 commit comments

Comments
 (0)