Skip to content

Commit d530d35

Browse files
committed
Update docs navigation and guide structure
Renamed navigation items and reorganized sidebar sections in VitePress config for clarity. Removed references to Security Guide, SDK Reference, Hooks Examples, and Reporting from the guide index. Updated package.json to rename the docs development script.
1 parent 3ea29c9 commit d530d35

3 files changed

Lines changed: 3 additions & 19 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,30 +15,26 @@ export default defineConfig({
1515
// Top Navigation
1616
nav: [
1717
{ text: 'Guide', link: '/guide/' },
18-
{ text: 'Specifications', link: '/spec/' },
19-
{ text: 'AI Context', link: '/AI_CONTEXT' }
18+
{ text: 'Protocol', link: '/spec/' },
2019
],
2120

2221
// Sidebar Configuration
2322
sidebar: {
2423
// Sidebar for Guide section
2524
'/guide/': [
2625
{
27-
text: 'Essentials',
26+
text: 'Developer Guide',
2827
items: [
2928
{ text: 'Introduction', link: '/guide/' },
3029
{ text: 'Quick Start', link: '/guide/getting-started' },
3130
{ text: 'Data Modeling', link: '/guide/data-modeling' },
32-
{ text: 'Security Guide', link: '/guide/security-guide' },
3331
{ text: 'Building AI Apps', link: '/guide/ai' }
3432
]
3533
},
3634
{
3735
text: 'Server-Side Logic',
3836
items: [
39-
{ text: 'SDK Reference', link: '/guide/sdk-reference' },
4037
{ text: 'Writing Hooks', link: '/guide/logic-hooks' },
41-
{ text: 'Hooks Examples', link: '/guide/logic-hooks-examples' },
4238
{ text: 'Custom Actions', link: '/guide/logic-actions' }
4339
]
4440
}

docs/guide/index.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,10 @@ Welcome to the ObjectQL User Guide. This documentation is designed to help you b
88
* [**Data Modeling Guide**](./data-modeling.md)
99
* Learn how to define Objects, Fields, and Relationships.
1010
* Guide to using rich field types: Email, URL, Files, Images, and Formulas.
11-
* [**Security Guide**](./security-guide.md)
12-
* Understanding authentication and permissions.
1311

1412
## 2. Server-Side Logic
15-
* [**SDK Reference**](./sdk-reference.md)
16-
* Using the Node.js API to query and manipulate data.
1713
* [**Hooks**](./logic-hooks.md)
1814
* Writing triggers (before/after create, update, delete).
19-
* [**Hooks Examples**](./logic-hooks-examples.md)
20-
* Real-world code snippets for automation.
2115
* [**Custom Actions**](./logic-actions.md)
2216
* Defining custom RPC endpoints.
2317

24-
## 3. Reporting & Analytics
25-
* [**Visual Reporting Guide**](./visual-reporting.md)
26-
* Creating multi-table reports with visual builder
27-
* Report types: Tabular, Summary, and Matrix
28-
* Advanced features: Grouping, aggregations, and charts
29-

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
"changeset": "changeset",
1111
"version": "changeset version",
1212
"release": "npm run build && changeset publish",
13-
"docs:dev": "vitepress dev docs",
13+
"docs": "vitepress dev docs",
1414
"docs:build": "vitepress build docs",
1515
"docs:preview": "vitepress preview docs"
1616
},

0 commit comments

Comments
 (0)