Skip to content

Commit 37acbb4

Browse files
hotlonghotlong
committed
Revise documentation: update sidebar structure and enhance Getting Started guide with database driver links
1 parent 7c19ebe commit 37acbb4

2 files changed

Lines changed: 72 additions & 94 deletions

File tree

‎docs/.vitepress/config.mts‎

Lines changed: 71 additions & 84 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,79 @@
11
import { defineConfig } from 'vitepress'
22

3+
const guideSidebar = [
4+
{
5+
text: 'Getting Started',
6+
items: [
7+
{ text: 'Introduction', link: '/guide/' },
8+
{ text: 'Why ObjectQL?', link: '/guide/architecture/why-objectql' },
9+
{ text: 'Quick Start', link: '/guide/getting-started' },
10+
{ text: 'IDE Setup', link: '/guide/ide-setup' },
11+
]
12+
},
13+
{
14+
text: 'Tutorials',
15+
items: [
16+
{ text: 'Overview', link: '/tutorials/' },
17+
{ text: '1. Task Manager (Beginner)', link: '/tutorials/task-manager' },
18+
{ text: '2. Micro-CRM (Intermediate)', link: '/tutorials/crm-system' },
19+
{ text: '3. Federated Data (Advanced)', link: '/tutorials/federation' },
20+
{ text: '4. AI Data Agent (AI-Native)', link: '/tutorials/ai-agent' },
21+
]
22+
},
23+
{
24+
text: 'Data & Logic Layers',
25+
items: [
26+
{ text: 'Data Modeling', link: '/guide/data-modeling' },
27+
{ text: 'Unified ID Migration', link: '/guide/migration-id-field' },
28+
{ text: 'Querying Data', link: '/guide/querying' },
29+
{ text: 'Formulas & Rules Syntax', link: '/guide/formulas-and-rules' },
30+
{ text: '↳ Quick Reference', link: '/guide/formulas-and-rules-quick-ref' },
31+
{ text: 'Business Logic (Hooks)', link: '/guide/logic-hooks' },
32+
{ text: 'Custom Actions (RPC)', link: '/guide/logic-actions' },
33+
]
34+
},
35+
{
36+
text: 'System Architecture',
37+
items: [
38+
{ text: 'Architecture Overview', link: '/guide/architecture/overview' },
39+
{ text: 'File Organization', link: '/guide/metadata-organization' },
40+
{ text: 'Microservices & Federation', link: '/guide/microservices' },
41+
{ text: 'Plugin System', link: '/guide/plugins' },
42+
]
43+
},
44+
{
45+
text: 'Low-Code UI',
46+
items: [
47+
{ text: 'Page & Layouts', link: '/guide/page-metadata' },
48+
]
49+
},
50+
{
51+
text: 'Operations & Deployment',
52+
items: [
53+
{ text: 'Server Integration', link: '/guide/server-integration' },
54+
{ text: 'Database Drivers', link: '/guide/drivers/' },
55+
{ text: 'CLI Tools', link: '/guide/cli' },
56+
{ text: 'Configuration', link: '/guide/configuration' },
57+
]
58+
},
59+
{
60+
text: 'Legal',
61+
items: [
62+
{ text: 'License', link: '/guide/license' },
63+
]
64+
}
65+
];
66+
367
export default defineConfig({
468
title: "ObjectQL",
569
description: "A Unified Data Management Framework",
670

771
// Scans the docs directory
872
srcDir: '.',
973

74+
// Enable Clean URLs (e.g. /guide/getting-started instead of /guide/getting-started.html)
75+
cleanUrls: true,
76+
1077
// Ignore dead links from merged documentation
1178
ignoreDeadLinks: true,
1279

@@ -31,27 +98,7 @@ export default defineConfig({
3198
// Sidebar Configuration
3299
sidebar: {
33100
// Sidebar for Tutorials
34-
'/tutorials/': [
35-
{
36-
text: 'Getting Started',
37-
items: [
38-
{ text: 'Introduction', link: '/guide/' },
39-
{ text: 'Why ObjectQL?', link: '/guide/architecture/why-objectql' },
40-
{ text: 'Quick Start', link: '/guide/getting-started' },
41-
{ text: 'IDE Setup', link: '/guide/ide-setup' },
42-
]
43-
},
44-
{
45-
text: 'Tutorials',
46-
items: [
47-
{ text: 'Overview', link: '/tutorials/' },
48-
{ text: '1. Task Manager (Beginner)', link: '/tutorials/task-manager' },
49-
{ text: '2. Micro-CRM (Intermediate)', link: '/tutorials/crm-system' },
50-
{ text: '3. Federated Data (Advanced)', link: '/tutorials/federation' },
51-
{ text: '4. AI Data Agent (AI-Native)', link: '/tutorials/ai-agent' },
52-
]
53-
}
54-
],
101+
'/tutorials/': guideSidebar,
55102

56103
// Sidebar for API section
57104
'/api/': [
@@ -109,69 +156,7 @@ export default defineConfig({
109156
],
110157

111158
// Sidebar for Guide section
112-
'/guide/': [
113-
{
114-
text: 'Getting Started',
115-
items: [
116-
{ text: 'Introduction', link: '/guide/' },
117-
{ text: 'Why ObjectQL?', link: '/guide/architecture/why-objectql' },
118-
{ text: 'Quick Start', link: '/guide/getting-started' },
119-
{ text: 'IDE Setup', link: '/guide/ide-setup' },
120-
]
121-
},
122-
{
123-
text: 'Tutorials',
124-
items: [
125-
{ text: 'Overview', link: '/tutorials/' },
126-
{ text: '1. Task Manager (Beginner)', link: '/tutorials/task-manager' },
127-
{ text: '2. Micro-CRM (Intermediate)', link: '/tutorials/crm-system' },
128-
{ text: '3. Federated Data (Advanced)', link: '/tutorials/federation' },
129-
{ text: '4. AI Data Agent (AI-Native)', link: '/tutorials/ai-agent' },
130-
]
131-
},
132-
{
133-
text: 'Data & Logic Layers',
134-
items: [
135-
{ text: 'Data Modeling', link: '/guide/data-modeling' },
136-
{ text: 'Unified ID Migration', link: '/guide/migration-id-field' },
137-
{ text: 'Querying Data', link: '/guide/querying' },
138-
{ text: 'Formulas & Rules Syntax', link: '/guide/formulas-and-rules' },
139-
{ text: '↳ Quick Reference', link: '/guide/formulas-and-rules-quick-ref' },
140-
{ text: 'Business Logic (Hooks)', link: '/guide/logic-hooks' },
141-
{ text: 'Custom Actions (RPC)', link: '/guide/logic-actions' },
142-
]
143-
},
144-
{
145-
text: 'System Architecture',
146-
items: [
147-
{ text: 'Architecture Overview', link: '/guide/architecture/overview' },
148-
{ text: 'File Organization', link: '/guide/metadata-organization' },
149-
{ text: 'Microservices & Federation', link: '/guide/microservices' },
150-
{ text: 'Plugin System', link: '/guide/plugins' },
151-
]
152-
},
153-
{
154-
text: 'Low-Code UI',
155-
items: [
156-
{ text: 'Page & Layouts', link: '/guide/page-metadata' },
157-
]
158-
},
159-
{
160-
text: 'Operations & Deployment',
161-
items: [
162-
{ text: 'Server Integration', link: '/guide/server-integration' },
163-
{ text: 'Database Drivers', link: '/guide/drivers/' },
164-
{ text: 'CLI Tools', link: '/guide/cli' },
165-
{ text: 'Configuration', link: '/guide/configuration' },
166-
]
167-
},
168-
{
169-
text: 'Legal',
170-
items: [
171-
{ text: 'License', link: '/guide/license' },
172-
]
173-
}
174-
],
159+
'/guide/': guideSidebar,
175160

176161
// Sidebar for Spec section
177162
'/spec/': [
@@ -188,6 +173,7 @@ export default defineConfig({
188173
{ text: 'Objects & Fields', link: '/spec/object' },
189174
{ text: 'Query Language', link: '/spec/query-language' },
190175
{ text: 'Validation Rules', link: '/spec/validation' },
176+
{ text: 'Data Seeding', link: '/spec/data' },
191177
]
192178
},
193179
{
@@ -201,6 +187,7 @@ export default defineConfig({
201187
{
202188
text: 'Presentation Layer',
203189
items: [
190+
{ text: 'Applications', link: '/spec/app' },
204191
{ text: 'Pages', link: '/spec/page' },
205192
{ text: 'Views & Layouts', link: '/spec/view' },
206193
{ text: 'Forms', link: '/spec/form' },

‎docs/guide/getting-started.md‎

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,6 @@
88
2. **Universal Protocol**: The query language is a JSON AST, making it easy for frontends or AI agents to generate queries.
99
3. **Action & Hook System**: Built-in support for "Button Actions" (RPC) and "Triggers" (Hooks), allowing you to model **Behavior** alongside **Data**.
1010

11-
## Installation
12-
13-
Install the core package and a driver (e.g., PostgreSQL or MongoDB).
14-
15-
```bash
16-
npm install @objectql/core @objectql/driver-sql knex pg
17-
# or
18-
npm install @objectql/core @objectql/driver-mongo mongodb
19-
```
20-
2111
## Quick Start: The "Hello World"
2212

2313
You can experience ObjectQL with a single file. No YAML, no complex config.
@@ -162,6 +152,7 @@ await ctx.object('todo').execute('mark_done', 'id_123', {});
162152

163153
## Next Steps
164154

155+
* **[Database Drivers](./drivers/index.md)**: Connect to PostgreSQL, MongoDB, etc.
165156
* **[Data Modeling](./data-modeling.md)**: Learn about all field types (Select, Lookup, Date, etc.)
166157
* **[SDK Reference](./sdk-reference.md)**: Explore the full API.
167158
* **[Hooks](./logic-hooks.md)**: Deep dive into the event system.

0 commit comments

Comments
 (0)