Skip to content

Commit 50fc65b

Browse files
Copilothotlong
andcommitted
docs: update ROADMAP.md to reflect all completed items
Mark completed: P1.1 schema examples, P1.2 context JSDoc, P1.3 deprecation warnings, P1.4 CLI fixes + doctor + validate, P2.1 full i18n + locale switcher, P2.2 defineStack, P4.1 guides (CRUD, plugin, theming), P4.4 architecture + troubleshooting + CI docs Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 6190313 commit 50fc65b

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

ROADMAP.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,11 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
9494

9595
| Area | Count | Notes |
9696
|------|-------|-------|
97-
| Packages | 35 | 27 with README, 10 missing README |
97+
| Packages | 35 | 37 with README (100%) |
9898
| Components | 91+ | 48 base UI + 14 custom + 29 renderers |
9999
| Field Widgets | 36+ | Consistent FieldWidgetProps pattern |
100100
| Storybook Stories | 68 | Good coverage, some gaps in edge-case stories |
101-
| Documentation Pages | 128 | .mdx files across 8 categories |
101+
| Documentation Pages | 134 | .mdx/.md files across 8 categories |
102102
| Test Files | 200+ | 3,235+ tests, 80% coverage |
103103
| Examples | 4 | todo, crm, kitchen-sink, msw-todo |
104104
| CLI Commands | 11 | init, build, dev, serve, doctor, etc. |
@@ -116,13 +116,13 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
116116
- 13 CI/CD workflows including performance budgets and visual regression
117117

118118
**Gaps Identified:**
119-
- 10 packages missing README: auth, tenant, permissions, i18n, mobile, collaboration, plugin-ai, plugin-designer, plugin-workflow, plugin-report
120-
- 20+ React hooks exported without JSDoc documentation
121-
- Console has hardcoded English strings (LoadingScreen, KeyboardShortcutsDialog) outside i18n
122-
- MIGRATION_GUIDE.md referenced in README but does not exist
119+
- ~~10 packages missing README~~ ✅ All 37 packages now have READMEs
120+
- ~~20+ React hooks exported without JSDoc documentation~~ ✅ All hooks documented with JSDoc
121+
- ~~Console has hardcoded English strings outside i18n~~ ✅ All strings migrated to i18n keys
122+
- ~~MIGRATION_GUIDE.md referenced in README but does not exist~~ ✅ Created
123123
- Types package has minimal JSDoc on exported interfaces
124124
- No interactive schema playground in documentation site
125-
- Core error messages lack error codes and actionable fix suggestions
125+
- ~~Core error messages lack error codes and actionable fix suggestions~~ ✅ Error code system implemented
126126

127127
---
128128

@@ -139,27 +139,27 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
139139
- [ ] Streamline `npx create-objectui-app` scaffolding with working Vite + Tailwind templates
140140
- [ ] 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
142-
- [ ] Provide copy-paste-ready schema examples in the root README for instant gratification
142+
- [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.)
147-
- [ ] Document all context providers (`ThemeContext`, `AuthContext`, `I18nContext`, `NotificationContext`, `DndContext`) with usage examples
147+
- [x] Document all context providers (`ThemeContext`, `AuthContext`, `I18nContext`, `NotificationContext`, `DndContext`) with usage examples
148148
- [ ] 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
152152
- [x] Improve SchemaErrorBoundary to show actionable fix suggestions in dev mode (e.g., "Missing field 'type'. Did you mean to use a PageSchema?")
153153
- [x] Replace generic `console.warn()` calls in core with structured error factory
154154
- [x] Add `OBJECTUI_DEBUG=true` mode with schema resolution tracing and component render timing
155-
- [ ] Ensure console warnings for deprecated APIs include migration code snippets
155+
- [x] Ensure console warnings for deprecated APIs include migration code snippets
156156

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

164164
#### P1.5 Package READMEs (10 Missing)
165165
- [x] Add README for `@object-ui/auth` — authentication guards, login/register forms, AuthContext
@@ -182,14 +182,14 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
182182
#### P2.1 Console i18n Completeness
183183
- [x] Migrate hardcoded strings in `LoadingScreen.tsx` to i18n keys ("ObjectStack Console", "Initializing application...")
184184
- [x] Migrate hardcoded strings in `KeyboardShortcutsDialog.tsx` to i18n keys
185-
- [ ] Audit all `apps/console/src/components/` for remaining hardcoded UI strings
185+
- [x] Audit all `apps/console/src/components/` for remaining hardcoded UI strings
186186
- [x] Remove all Chinese UI strings; enforce English-only with i18n key lookups
187-
- [ ] Add locale switcher to Console settings panel
187+
- [x] Add locale switcher to Console settings panel
188188

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

@@ -258,9 +258,9 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
258258

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

266266
#### P4.2 API Reference
@@ -276,10 +276,10 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
276276
- [ ] Deploy Storybook to a publicly accessible URL (storybook.objectui.org)
277277

278278
#### P4.4 Architecture & Internals
279-
- [ ] Document the layer architecture (spec → types → core → react → components → plugins) with data flow diagrams
280-
- [ ] Document the plugin system architecture (registration, lifecycle, lazy loading)
281-
- [ ] Add troubleshooting guide for common development issues
282-
- [ ] Document CI/CD pipeline architecture (13 workflows, their triggers and responsibilities)
279+
- [x] Document the layer architecture (spec → types → core → react → components → plugins) with data flow diagrams
280+
- [x] Document the plugin system architecture (registration, lifecycle, lazy loading)
281+
- [x] Add troubleshooting guide for common development issues
282+
- [x] Document CI/CD pipeline architecture (13 workflows, their triggers and responsibilities)
283283

284284
---
285285

@@ -319,13 +319,13 @@ All 4 phases complete across 5 designers (Page, View, DataModel, Process, Report
319319
| **Test Count** | 3,235+ | 4,000+ | `pnpm test` summary |
320320
| **Spec Compliance** | 98% | 100% | SPEC_COMPLIANCE_EVALUATION.md |
321321
| **Storybook Stories** | 68 | 91+ (1 per component) | Story file count |
322-
| **Package READMEs** | 27/35 (77%) | 35/35 (100%) | README.md presence |
323-
| **Hooks with JSDoc** | ~5/20+ (~25%) | 20+/20+ (100%) | Grep `/** */` in hooks |
324-
| **Console i18n Coverage** | ~80% | 100% | No hardcoded strings |
322+
| **Package READMEs** | 37/37 (100%) | 37/37 (100%) | README.md presence |
323+
| **Hooks with JSDoc** | 20+/20+ (100%) | 20+/20+ (100%) | Grep `/** */` in hooks |
324+
| **Console i18n Coverage** | ~100% | 100% | No hardcoded strings |
325325
| **Build Status** | 42/42 pass | 42/42 pass | `pnpm build` |
326326
| **WCAG AA Compliance** | Primitives only | Full Console pages | axe-core audit |
327327
| **CLI Commands Working** | 11 | 11 (all verified) | `objectui doctor` |
328-
| **TODO/FIXME Count** | 8 files | 0 | Grep `TODO\|FIXME\|HACK` |
328+
| **TODO/FIXME Count** | 0 files | 0 | Grep `TODO\|FIXME\|HACK` |
329329

330330
### DX Success Criteria
331331
- [ ] New developer can `git clone``pnpm install``pnpm dev` → see Console in < 5 minutes

0 commit comments

Comments
 (0)