Skip to content

Commit 7e2da72

Browse files
authored
Merge pull request #475 from objectstack-ai/copilot/complete-roadmap-development-tasks-again
2 parents 5b82fed + eb2c541 commit 7e2da72

File tree

36 files changed

+3639
-38
lines changed

36 files changed

+3639
-38
lines changed

ROADMAP.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -136,16 +136,16 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
136136

137137
#### P1.1 Zero-Friction Onboarding
138138
- [x] Create MIGRATION_GUIDE.md at repo root (currently referenced in README but missing)
139-
- [ ] Streamline `npx create-objectui-app` scaffolding with working Vite + Tailwind templates
140-
- [ ] Ensure `pnpm install && pnpm dev` starts the console with zero additional configuration
139+
- [x] Streamline `npx create-objectui-app` scaffolding with working Vite + Tailwind templates
140+
- [x] Ensure `pnpm install && pnpm dev` starts the console with zero additional configuration
141141
- [x] Add a standalone "Hello World" example (5-file, <50 lines total) demonstrating JSON → UI flow
142142
- [x] Provide copy-paste-ready schema examples in the root README for instant gratification
143143

144144
#### P1.2 API Discoverability & JSDoc
145145
- [x] Add JSDoc comments to all 20+ exported React hooks (`useExpression`, `useActionRunner`, `useViewData`, `useDynamicApp`, `usePerformance`, `useCrudShortcuts`, etc.)
146146
- [x] Add JSDoc with usage examples to key types in `@object-ui/types` (`SchemaNode`, `FieldMetadata`, `ViewSchema`, `ActionSchema`, etc.)
147147
- [x] Document all context providers (`ThemeContext`, `AuthContext`, `I18nContext`, `NotificationContext`, `DndContext`) with usage examples
148-
- [ ] Ensure TypeScript autocompletion works smoothly for all schema types via strict discriminated unions
148+
- [x] Ensure TypeScript autocompletion works smoothly for all schema types via strict discriminated unions
149149

150150
#### P1.3 Error Messages & Debugging
151151
- [x] Create error code system (`OBJUI-001`, `OBJUI-002`, etc.) with documentation links
@@ -155,9 +155,9 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
155155
- [x] Ensure console warnings for deprecated APIs include migration code snippets
156156

157157
#### P1.4 CLI Tooling Polish
158-
- [ ] Verify `objectui init` produces a buildable project with all dependencies resolved
158+
- [x] Verify `objectui init` produces a buildable project with all dependencies resolved
159159
- [x] Enhance `objectui doctor` to check TypeScript version, Tailwind config, and peer dependencies
160-
- [ ] Verify `create-plugin` template produces a plugin with working tests and Storybook story
160+
- [x] Verify `create-plugin` template produces a plugin with working tests and Storybook story
161161
- [x] Add `objectui validate <schema.json>` command for schema linting with actionable error messages
162162
- [x] Resolve TODO/FIXME items in CLI code (`doctor.ts`, `dev.ts`, `check.ts`)
163163

@@ -187,24 +187,24 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
187187
- [x] Add locale switcher to Console settings panel
188188

189189
#### P2.2 Console Architecture Cleanup
190-
- [ ] Consolidate hand-wired ObjectView into plugin-based ObjectView (eliminate duplication)
191-
- [ ] Replace lightweight local data adapter with official `@object-ui/data-objectstack`
190+
- [x] Consolidate hand-wired ObjectView into plugin-based ObjectView (eliminate duplication)
191+
- [x] Replace lightweight local data adapter with official `@object-ui/data-objectstack`
192192
- [x] Replace custom `defineConfig()` with standard `defineStack()` configuration
193-
- [ ] Register all missing plugins properly in the plugin registry
194-
- [ ] Convert hardcoded view tabs to schema-driven configuration
193+
- [x] Register all missing plugins properly in the plugin registry
194+
- [x] Convert hardcoded view tabs to schema-driven configuration
195195

196196
#### P2.3 Accessibility & Inclusive Design
197197
- [ ] Run axe-core audit on Console pages (currently 30 tests on primitives, not on assembled pages)
198-
- [ ] Ensure focus management across all Console navigation flows (sidebar → content → modal → back)
198+
- [x] Ensure focus management across all Console navigation flows (sidebar → content → modal → back)
199199
- [ ] Verify screen reader experience for complex views (Grid, Kanban, Calendar)
200200
- [ ] Test all color combinations against WCAG 2.1 AA contrast ratios in both light and dark themes
201-
- [ ] Add `prefers-reduced-motion` respect to all animations (page transitions, DnD, skeleton loading)
201+
- [x] Add `prefers-reduced-motion` respect to all animations (page transitions, DnD, skeleton loading)
202202

203203
#### P2.4 Performance at Scale
204204
- [ ] Benchmark Grid/Kanban/Calendar with 1,000+ and 10,000+ records; set performance baselines
205205
- [ ] Implement virtual scrolling for large data grids (plugin-grid, plugin-aggrid)
206206
- [ ] Profile and optimize initial Console load (target: < 2s on 3G, currently ~3s estimated)
207-
- [ ] Add loading skeleton states for all async data views
207+
- [x] Add loading skeleton states for all async data views
208208
- [ ] Test view switching (grid ↔ kanban ↔ calendar) state preservation with large datasets
209209

210210
#### P2.5 Console Feature Completeness
@@ -223,7 +223,7 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
223223
#### P3.1 Component Quality Audit
224224
- [ ] Audit all 91+ components for API consistency (prop naming, default values, error states)
225225
- [ ] Ensure every component has complete TypeScript types with JSDoc descriptions
226-
- [ ] Standardize error/empty/loading states across all components using shared primitives
226+
- [x] Standardize error/empty/loading states across all components using shared primitives
227227
- [ ] Add missing edge-case handling (overflow, truncation, null data, large datasets)
228228

229229
#### P3.2 Field Widget Polish
@@ -245,7 +245,7 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
245245
- [ ] Add snapshot tests for critical UI output consistency
246246

247247
#### P3.5 Storybook Enhancement
248-
- [ ] Ensure every exported component has at least one Storybook story (target: 91+ stories from current 68)
248+
- [x] Ensure every exported component has at least one Storybook story (target: 91+ stories from current 68)
249249
- [ ] Add interactive controls (args) for all major props in each story
250250
- [ ] Add "edge case" stories per component (empty data, error state, loading, overflow, RTL)
251251
- [ ] Organize stories with consistent categorization (Components / Fields / Layout / Plugins)
@@ -257,17 +257,17 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
257257
**Goal:** Comprehensive, accurate, and easy-to-navigate documentation that is a developer's best friend.
258258

259259
#### P4.1 Guide Content
260-
- [ ] Verify "Getting Started" guide (`quick-start.md`) stays current with latest API
260+
- [x] Verify "Getting Started" guide (`quick-start.md`) stays current with latest API
261261
- [x] Write "Building a CRUD App" end-to-end tutorial (complete walkthrough: schema → data → deploy)
262262
- [x] Write "Custom Plugin Development" guide with best practices and template walkthrough
263263
- [x] Write "Theming & Customization" guide (Tailwind config, cva variants, dark mode, CSS custom properties)
264-
- [ ] Add deployment guides for examples (Docker, Vercel, Railway configurations)
264+
- [x] Add deployment guides for examples (Docker, Vercel, Railway configurations)
265265

266266
#### P4.2 API Reference
267267
- [ ] Generate API reference docs from TypeScript types (TSDoc → documentation site)
268-
- [ ] Document all schema types with annotated examples (ViewSchema, ActionSchema, FieldSchema, etc.)
268+
- [x] Document all schema types with annotated examples (ViewSchema, ActionSchema, FieldSchema, etc.)
269269
- [ ] Add interactive schema playground on documentation site (JSON editor → live preview)
270-
- [ ] Document expression engine syntax and all built-in functions with examples
270+
- [x] Document expression engine syntax and all built-in functions with examples
271271

272272
#### P4.3 Storybook as Living Documentation
273273
- [ ] Ensure Storybook serves as the primary component reference alongside docs site

content/docs/api/index.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: "API Reference"
3+
description: "Complete API reference for ObjectUI schema types, components, and utilities"
4+
---
5+
6+
# API Reference
7+
8+
Comprehensive reference documentation for all ObjectUI types, schemas, and APIs.
9+
10+
## Schema Types
11+
12+
### [Schema Type Reference](/docs/api/schema-reference)
13+
14+
Complete reference for every ObjectUI schema type with annotated JSON examples covering:
15+
16+
- **Base**`SchemaNode`, `BaseSchema`
17+
- **Layout**`PageSchema`, `DivSchema`, `CardSchema`, `GridSchema`, `TabsSchema`
18+
- **Forms**`FormSchema`, `InputSchema`, `SelectSchema`, `ButtonSchema`
19+
- **Data Display**`TableSchema`, `ChartSchema`, `TreeViewSchema`
20+
- **CRUD**`CRUDSchema`, `ActionSchema`, `DetailSchema`
21+
- **ObjectQL**`ObjectGridSchema`, `ObjectFormSchema`, `ObjectViewSchema`
22+
- **Complex**`KanbanSchema`, `DashboardSchema`, `CalendarViewSchema`
23+
- **Views**`DetailViewSchema`, `ViewSwitcherSchema`

content/docs/api/meta.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"title": "API Reference",
3+
"pages": [
4+
"schema-reference"
5+
]
6+
}

0 commit comments

Comments
 (0)