Skip to content

Commit ff64337

Browse files
Copilothotlong
andcommitted
Add comprehensive components and plugins documentation
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 42f8a02 commit ff64337

4 files changed

Lines changed: 1523 additions & 12 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@ export default defineConfig({
4343
text: 'Core Concepts',
4444
items: [
4545
{ text: 'Schema Rendering', link: '/guide/schema-rendering' },
46+
{ text: 'Components', link: '/guide/components' },
4647
{ text: 'Component Registry', link: '/guide/component-registry' },
48+
{ text: 'Plugins', link: '/guide/plugins' },
4749
{ text: 'Expression System', link: '/guide/expressions' }
4850
]
4951
},

docs/DOCUMENTATION_INDEX.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ Complete guide to Object UI documentation. Find what you need quickly.
1616
**Understanding how Object UI works:**
1717

1818
- [Schema Rendering](./guide/schema-rendering.md) - The core rendering system
19+
- [Components](./guide/components.md) - Complete component reference guide
1920
- [Component Registry](./guide/component-registry.md) - How components are registered and used
21+
- [Plugins](./guide/plugins.md) - Extending Object UI with plugins
2022
- [Expression System](./guide/expressions.md) - Dynamic data binding and logic
2123

2224
## 📋 Protocol Specifications
@@ -76,18 +78,26 @@ Complete guide to Object UI documentation. Find what you need quickly.
7678
### I want to...
7779

7880
**Build a form**
79-
1. [Form Protocol](./protocol/form.md) - Schema reference
80-
2. [Quick Start](./guide/quick-start.md#your-first-component) - Form example
81-
3. [Form Component](./components/form.md) - Detailed guide
81+
1. [Components Guide](./guide/components.md#form-components) - Form components overview
82+
2. [Form Protocol](./protocol/form.md) - Schema reference
83+
3. [Quick Start](./guide/quick-start.md#your-first-component) - Form example
84+
4. [Form Component](./components/form.md) - Detailed guide
8285

8386
**Display data in a table**
84-
1. [View Protocol](./protocol/view.md) - Table schema
85-
2. [Components API](./api/components.md) - Table component API
87+
1. [Components Guide](./guide/components.md#data-display) - Data display components
88+
2. [View Protocol](./protocol/view.md) - Table schema
89+
3. [Components API](./api/components.md) - Table component API
90+
91+
**Extend with plugins**
92+
1. [Plugins Guide](./guide/plugins.md) - Overview and official plugins
93+
2. [Lazy-Loaded Plugins](./lazy-loaded-plugins.md) - Plugin architecture
94+
3. [Component Packages](./spec/component-package.md) - Creating custom plugins
8695

8796
**Create custom components**
88-
1. [Component Registry](./guide/component-registry.md) - Registration guide
89-
2. [Component Packages](./spec/component-package.md) - Creation guide
90-
3. [Architecture](./spec/architecture.md) - Understanding the system
97+
1. [Components Guide](./guide/components.md#customization) - Customization overview
98+
2. [Component Registry](./guide/component-registry.md) - Registration guide
99+
3. [Component Packages](./spec/component-package.md) - Creation guide
100+
4. [Architecture](./spec/architecture.md) - Understanding the system
91101

92102
**Use the visual designer**
93103
1. [Visual Studio](./guide/studio.md) - Designer guide
@@ -116,10 +126,12 @@ Just getting started:
116126

117127
Building real applications:
118128
1. [Schema Rendering](./guide/schema-rendering.md)
119-
2. [Component Registry](./guide/component-registry.md)
120-
3. [Expression System](./guide/expressions.md)
121-
4. [View Protocol](./protocol/view.md)
122-
5. [Page Protocol](./protocol/page.md)
129+
2. [Components](./guide/components.md)
130+
3. [Component Registry](./guide/component-registry.md)
131+
4. [Plugins](./guide/plugins.md)
132+
5. [Expression System](./guide/expressions.md)
133+
6. [View Protocol](./protocol/view.md)
134+
7. [Page Protocol](./protocol/page.md)
123135

124136
### Advanced
125137

@@ -160,7 +172,9 @@ Want to improve the docs?
160172
- [Installation](./guide/installation.md)
161173
- [Visual Studio](./guide/studio.md)
162174
- [Schema Rendering](./guide/schema-rendering.md)
175+
- [Components](./guide/components.md)
163176
- [Component Registry](./guide/component-registry.md)
177+
- [Plugins](./guide/plugins.md)
164178
- [Expression System](./guide/expressions.md)
165179

166180
### All Protocols

0 commit comments

Comments
 (0)