Skip to content

Commit da7e730

Browse files
Copilothotlong
andcommitted
Remove Phase 2 emphasis and rename to schema-overview
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent ed08243 commit da7e730

File tree

2 files changed

+34
-40
lines changed

2 files changed

+34
-40
lines changed

content/docs/guide/meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@
99
"fields",
1010
"component-registry",
1111
"plugins",
12-
"phase2-schemas"
12+
"schema-overview"
1313
]
1414
}
Lines changed: 33 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
---
2-
title: "Phase 2 Schemas Overview"
3-
description: "Comprehensive overview of ObjectUI Phase 2 schemas for building enterprise applications"
2+
title: "Schema Overview"
3+
description: "Comprehensive overview of ObjectUI schemas for building enterprise applications"
44
---
55

6-
# Phase 2 Schemas Overview
6+
# Schema Overview
77

8-
ObjectUI Phase 2 introduces powerful new schemas that enable you to build sophisticated enterprise applications with advanced features like theming, reporting, reusable components, and complex workflows. This guide provides an overview of all Phase 2 schemas and helps you get started quickly.
8+
ObjectUI provides powerful schemas that enable you to build sophisticated enterprise applications with advanced features like theming, reporting, reusable components, and complex workflows. This guide provides an overview of all available schemas and helps you get started quickly.
99

10-
## What's New in Phase 2?
10+
## Key Capabilities
1111

12-
Phase 2 brings enterprise-grade capabilities to ObjectUI, making it easier to build production-ready applications:
12+
ObjectUI includes enterprise-grade capabilities to build production-ready applications:
1313

1414
- **Application Structure** - Define complete multi-page applications with navigation
1515
- **Dynamic Theming** - Brand your applications with custom themes and light/dark modes
@@ -90,7 +90,7 @@ const action: ActionSchema = {
9090
- **`confirm`** - Confirmation dialogs
9191
- **`dialog`** - Modal/dialog actions
9292

93-
**Advanced Features:**
93+
**Key Features:**
9494
- Action chaining (sequential/parallel)
9595
- Conditional execution (if/then/else)
9696
- Success/failure callbacks
@@ -168,7 +168,7 @@ const block: BlockSchema = {
168168

169169
## View Components
170170

171-
Phase 2 also includes enhanced view components:
171+
ObjectUI also includes enhanced view components:
172172

173173
### [Detail View](/docs/components/detail-view)
174174
Rich detail pages with sections, tabs, and related records.
@@ -186,7 +186,7 @@ Sort configuration with multiple fields.
186186

187187
### Package Installation
188188

189-
All Phase 2 schemas are included in `@object-ui/types`. Install it in your project:
189+
All schemas are included in `@object-ui/types`. Install it in your project:
190190

191191
```bash
192192
npm install @object-ui/types
@@ -235,7 +235,7 @@ if (result.success) {
235235

236236
## Quick Start Example
237237

238-
Here's a complete example showing how to build a simple CRM application using Phase 2 schemas:
238+
Here's a complete example showing how to build a simple CRM application using ObjectUI schemas:
239239

240240
```typescript
241241
import type { AppSchema, ThemeSchema } from '@object-ui/types';
@@ -296,74 +296,68 @@ This creates a professional-looking CRM application with:
296296
- User menu with profile and logout options
297297
- Professional theme with light/dark mode support
298298

299-
## Upgrading from Phase 1
299+
## Advanced Features
300300

301-
If you're currently using ObjectUI Phase 1, here's what's new and how to upgrade:
301+
ObjectUI provides advanced schemas and capabilities for enterprise applications:
302302

303-
### New Top-Level Schemas
303+
### Core Schemas
304304

305-
Phase 2 introduces four new top-level schemas:
305+
ObjectUI includes these top-level schemas:
306306

307-
- **`AppSchema`** - Define your entire application structure (new in Phase 2)
308-
- **`ThemeSchema`** - Configure themes and color palettes (new in Phase 2)
309-
- **`ReportSchema`** - Create data reports with aggregation (new in Phase 2)
310-
- **`BlockSchema`** - Build reusable component blocks (new in Phase 2)
307+
- **`AppSchema`** - Define your entire application structure
308+
- **`ThemeSchema`** - Configure themes and color palettes
309+
- **`ReportSchema`** - Create data reports with aggregation
310+
- **`BlockSchema`** - Build reusable component blocks
311311

312312
### Enhanced ActionSchema
313313

314-
The `ActionSchema` has been significantly enhanced with:
314+
The `ActionSchema` provides comprehensive action handling:
315315

316-
-New action types: `ajax`, `confirm`, `dialog`
316+
-Action types: `ajax`, `confirm`, `dialog`
317317
- ✅ Action chaining via the `chain` array (sequential or parallel)
318318
- ✅ Conditional execution with the `condition` property
319319
- ✅ Success/failure callbacks: `onSuccess` and `onFailure`
320320
- ✅ Event tracking with the `tracking` configuration
321321
- ✅ Automatic retry logic
322322

323-
### New View Components
323+
### View Components
324324

325-
Phase 2 includes enhanced view components:
325+
ObjectUI includes enhanced view components:
326326

327327
- **`DetailViewSchema`** - Rich detail pages with sections and tabs
328328
- **`ViewSwitcherSchema`** - Toggle between list, grid, kanban, calendar views
329329
- **`FilterUISchema`** - Advanced filtering interface
330330
- **`SortUISchema`** - Multi-field sort configuration
331331

332-
### Backward Compatibility
332+
## Getting Started
333333

334-
Phase 2 is fully backward compatible with Phase 1 schemas. You can:
334+
### Installation Steps
335335

336-
- Continue using existing Phase 1 schemas
337-
- Gradually adopt Phase 2 features
338-
- Mix Phase 1 and Phase 2 schemas in the same application
339-
340-
### Migration Steps
341-
342-
1. **Update package** - Install latest `@object-ui/types`
336+
1. **Install package** - Add `@object-ui/types` to your project
343337
```bash
344338
npm install @object-ui/types@latest
345339
```
346340

347-
2. **Add AppSchema** - Wrap your pages in an application structure (optional)
341+
2. **Configure application** - Define your app structure with AppSchema (optional)
348342

349-
3. **Configure theme** - Add a ThemeSchema for consistent styling (optional)
343+
3. **Set up theming** - Add a ThemeSchema for consistent styling (optional)
350344

351-
4. **Enhance actions** - Update critical actions to use new features like `confirm` and callbacks
345+
4. **Implement actions** - Use advanced action features like `confirm` and callbacks
352346

353-
5. **Test thoroughly** - Verify all existing functionality works as expected
347+
5. **Test your application** - Verify all functionality works as expected
354348

355349
## Learning Resources
356350

357351
### Documentation
358352
- **[Implementation Guide](https://github.com/objectstack-ai/objectui/blob/main/packages/types/PHASE2_IMPLEMENTATION.md)** - Complete implementation details and technical specifications
359-
- **[Quick Start Guide](https://github.com/objectstack-ai/objectui/blob/main/PHASE2_QUICK_START.md)** - Step-by-step tutorial for getting started with Phase 2
353+
- **[Quick Start Guide](https://github.com/objectstack-ai/objectui/blob/main/PHASE2_QUICK_START.md)** - Step-by-step tutorial for getting started
360354

361355
### API Reference
362356
- **[TypeScript Types](https://github.com/objectstack-ai/objectui/tree/main/packages/types/src)** - Browse all type definitions
363357
- **[Zod Validation Schemas](https://github.com/objectstack-ai/objectui/tree/main/packages/types/src/zod)** - Runtime validation schemas
364358

365359
### Code Examples
366-
- **[Test Suite](https://github.com/objectstack-ai/objectui/blob/main/packages/types/src/__tests__/phase2-schemas.test.ts)** - 40+ working examples demonstrating all Phase 2 features
360+
- **[Test Suite](https://github.com/objectstack-ai/objectui/blob/main/packages/types/src/__tests__/phase2-schemas.test.ts)** - 40+ working examples demonstrating all features
367361

368362
## Getting Help
369363

@@ -377,9 +371,9 @@ Phase 2 is fully backward compatible with Phase 1 schemas. You can:
377371

378372
## Next Steps
379373

380-
Ready to build with Phase 2? Here's what to do next:
374+
Ready to build with ObjectUI? Here's what to do next:
381375

382376
1. **[Review schema documentation](/docs/core)** - Learn about each schema in detail
383-
2. **[Try the Quick Start](https://github.com/objectstack-ai/objectui/blob/main/PHASE2_QUICK_START.md)** - Build your first Phase 2 application
377+
2. **[Try the Quick Start](https://github.com/objectstack-ai/objectui/blob/main/PHASE2_QUICK_START.md)** - Build your first ObjectUI application
384378
3. **[Explore examples](https://github.com/objectstack-ai/objectui/blob/main/packages/types/src/__tests__/phase2-schemas.test.ts)** - See real-world usage patterns
385379
4. **[Join the community](https://github.com/objectstack-ai/objectui/discussions)** - Connect with other developers

0 commit comments

Comments
 (0)