Skip to content

Commit bcaec12

Browse files
committed
Update navigation and reorganize spec index
Renamed 'Applications & Navigation' to 'Menus & Navigation' in the VitePress sidebar and updated corresponding links. The spec index was reorganized for clarity, with improved sectioning and descriptions, and removed the AI-Native Metadata Design section for conciseness.
1 parent 7ed2f28 commit bcaec12

2 files changed

Lines changed: 14 additions & 38 deletions

File tree

docs/.vitepress/config.mts

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

docs/spec/index.md

Lines changed: 13 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,17 @@
1-
# ObjectQL Metadata Specifications
1+
# 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-
## 🤖 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
7+
## Core Data Layer
388

39-
### Core Data Layer
40-
* [**Objects & Fields**](./object.md) - Data model definitions, field types, relationships, and validation
9+
* [**Objects & Fields**](./object.md) - Data model definitions, field types, relationships, and validation rules
4110
* [**Query Language (JSON-DSL)**](./query-language.md) - Unified query protocol for database-agnostic data access
4211
* [**Validation Rules**](./validation.md) - Data quality and business rule enforcement
4312

44-
### Business Logic Layer
13+
## Business Logic Layer
14+
4515
* [**Hooks (Triggers)**](./hook.md) - Event-driven logic attached to data operations
4616
* [**Actions (RPC)**](./action.md) - Custom server-side functions and APIs
4717
* [**Workflows & Processes**](./workflow.md) - Automated business processes and approval chains
@@ -53,8 +23,14 @@ fields:
5323
* [**Reports & Dashboards**](./report.md) - Analytics and BI
5424
* [**Menus & Navigation**](./menu.md) - Application structure and navigation hierarchy
5525

56-
### Security & Access Control
57-
* [**Permissions**](./permission.md) - Role-based access control and security rules
26+
* [**Views & Layouts**](./view.md) - Data presentation configurations (list, grid, kanban, calendar)
27+
* [**Forms**](./form.md) - Data entry and editing interfaces
28+
* [**Reports & Dashboards**](./report.md) - Analytics, visualizations, and business intelligence
29+
* [**Applications & Navigation**](./application.md) - Application structure and menu hierarchy
30+
31+
## Security & Access Control
32+
33+
* [**Permissions**](./permission.md) - Role-based access control, field-level security, and record-level rules
5834

5935
## Design Philosophy
6036

0 commit comments

Comments
 (0)