Skip to content

Commit 0ebc6bb

Browse files
committed
feat: update documentation and reorganize content for improved clarity and structure
1 parent 886333d commit 0ebc6bb

File tree

6 files changed

+222
-571
lines changed

6 files changed

+222
-571
lines changed

docs/.vitepress/config.mts

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ import { defineConfig } from 'vitepress'
33
// https://vitepress.dev/reference/site-config
44
export default defineConfig({
55
title: "Object UI",
6-
description: "The Modular Interface Engine for the Enterprise",
6+
// Updated to match System Prompt identity
7+
description: "A Universal, Schema-Driven UI Engine built on React, Tailwind, and Shadcn UI.",
78
base: '/',
89
ignoreDeadLinks: true,
910

@@ -12,19 +13,17 @@ export default defineConfig({
1213
logo: '/logo.svg',
1314

1415
nav: [
15-
{ text: 'Home', link: '/' },
1616
{ text: 'Guide', link: '/guide/introduction' },
17+
{ text: 'Components', link: '/components/form' },
1718
{
18-
text: 'Documentation',
19+
text: 'Reference',
1920
items: [
20-
{ text: '📚 Documentation Index', link: '/DOCUMENTATION_INDEX' },
21-
{ text: 'Protocol Specs', link: '/protocol/overview' },
21+
{ text: 'Protocol Specs (@object-ui/types)', link: '/protocol/overview' },
2222
{ text: 'API Reference', link: '/api/core' },
23-
{ text: 'Technical Specs', link: '/spec/architecture' },
24-
{ text: 'Components', link: '/components/form' }
23+
{ text: 'Architecture', link: '/spec/architecture' }
2524
]
2625
},
27-
{ text: 'Roadmap', link: '/ROADMAP' }
26+
{ text: 'GitHub', link: 'https://github.com/objectql/objectui' }
2827
],
2928

3029
sidebar: {
@@ -42,14 +41,14 @@ export default defineConfig({
4241
text: 'Core Concepts',
4342
items: [
4443
{ text: 'Schema Rendering', link: '/guide/schema-rendering' },
45-
{ text: 'Components', link: '/guide/components' },
4644
{ text: 'Component Registry', link: '/guide/component-registry' },
47-
{ text: 'Plugins', link: '/guide/plugins' },
48-
{ text: 'Expression System', link: '/guide/expressions' }
45+
{ text: 'Data Connectivity', link: '/guide/data-source' },
46+
{ text: 'Plugin System', link: '/guide/plugins' },
47+
{ text: 'Expression Engine', link: '/guide/expressions' }
4948
]
5049
},
5150
{
52-
text: 'Architecture',
51+
text: 'Architecture & Performance',
5352
items: [
5453
{ text: 'Architecture Overview', link: '/spec/architecture' },
5554
{ text: 'Project Structure', link: '/spec/project-structure' },
@@ -63,7 +62,7 @@ export default defineConfig({
6362
text: 'Protocol Specifications',
6463
items: [
6564
{ text: 'Overview', link: '/protocol/overview' },
66-
{ text: '📊 Implementation Status', link: '/protocol/implementation-status' }
65+
{ text: 'Implementation Status', link: '/protocol/implementation-status' }
6766
]
6867
},
6968
{
@@ -101,10 +100,15 @@ export default defineConfig({
101100
{
102101
text: 'Technical Specifications',
103102
items: [
104-
{ text: 'Architecture', link: '/spec/architecture' },
103+
{ text: 'Architecture Overview', link: '/spec/architecture' },
105104
{ text: 'Project Structure', link: '/spec/project-structure' },
106-
{ text: 'Schema Rendering', link: '/spec/schema-rendering' },
107-
{ text: 'Component System', link: '/spec/component' },
105+
{ text: 'Schema Rendering Flow', link: '/spec/schema-rendering' },
106+
{ text: 'Component System', link: '/spec/component' }
107+
]
108+
},
109+
{
110+
text: 'Component Implementation',
111+
items: [
108112
{ text: 'Base Components', link: '/spec/base-components' },
109113
{ text: 'Component Library', link: '/spec/component-library' },
110114
{ text: 'Component Packages', link: '/spec/component-package' }
@@ -126,10 +130,10 @@ export default defineConfig({
126130
{
127131
text: 'Official Plugins',
128132
items: [
129-
{ text: 'Plugin Editor', link: '/plugins/plugin-editor' },
130-
{ text: 'Plugin Charts', link: '/plugins/plugin-charts' },
131-
{ text: 'Plugin Kanban', link: '/plugins/plugin-kanban' },
132-
{ text: 'Plugin Markdown', link: '/plugins/plugin-markdown' }
133+
{ text: 'Plugin: Editor', link: '/plugins/plugin-editor' },
134+
{ text: 'Plugin: Charts', link: '/plugins/plugin-charts' },
135+
{ text: 'Plugin: Kanban', link: '/plugins/plugin-kanban' },
136+
{ text: 'Plugin: Markdown', link: '/plugins/plugin-markdown' }
133137
]
134138
}
135139
]

docs/DOCUMENTATION_REORGANIZATION.md

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

0 commit comments

Comments
 (0)