docs: overhaul ROADMAP with audit-driven DX/UX improvement plan #472
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…posals - Add Full-Repository Audit section with quantified findings - Re-prioritize: DX (P1) > UX (P2) > Component Excellence (P3) > Docs (P4) - P1: Zero-friction onboarding, JSDoc, error codes, CLI polish, 10 missing READMEs - P2: Console i18n, accessibility, performance at scale, architecture cleanup - P3: Component audit, field polish, test coverage 80→90%, Storybook 68→91+ - P4: Guides, API reference, Storybook as living docs, architecture docs - Update success metrics with DX/UX criteria and measurement methods - Update risk management with DX/UX-specific risks and mitigations Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR overhauls ROADMAP.md to reflect a Feb 2026 full-repository audit and re-prioritizes the project roadmap around Developer Experience (P1) and User Experience (P2), followed by Component Excellence and Documentation.
Changes:
- Added a new “Full-Repository Audit” section with scope, strengths, gaps, and quantified metrics.
- Re-ordered roadmap priorities (DX → UX → Components → Docs) and expanded each priority with more concrete, measurable tasks.
- Expanded Success Metrics and Risk Management with measurement methods, success criteria, and additional mitigations.
| - [ ] Enhance `objectui doctor` to check TypeScript version, Tailwind config, and peer dependencies | ||
| - [ ] Verify `create-plugin` template produces a plugin with working tests and Storybook story | ||
| - [ ] Add `objectui validate <schema.json>` command for schema linting with actionable error messages | ||
| - [ ] Resolve 8 TODO/FIXME items in CLI code (`doctor.ts`, `dev.ts`, `check.ts`) |
There was a problem hiding this comment.
This says there are "8 TODO/FIXME items" in CLI code (doctor.ts, dev.ts, check.ts), but those three files currently contain 3 TODOs total and no FIXMEs. Please correct the count and/or expand the referenced file list to match the actual TODO/FIXME occurrences.
| - [ ] Resolve 8 TODO/FIXME items in CLI code (`doctor.ts`, `dev.ts`, `check.ts`) | |
| - [ ] Resolve remaining TODO items in the CLI codebase (for example in `doctor.ts`, `dev.ts`, `check.ts`) |
| | **Test Count** | 3,235+ | 4,000+ | `pnpm test` summary | | ||
| | **Spec Compliance** | 98% | 100% | SPEC_COMPLIANCE_EVALUATION.md | | ||
| | **Storybook Stories** | 68 | 91+ (1 per component) | Story file count | | ||
| | **Package READMEs** | 27/35 (77%) | 35/35 (100%) | README.md presence | |
There was a problem hiding this comment.
This metric is inconsistent with the earlier statement that 10 packages are missing READMEs. If 35 packages is correct, 10 missing implies 25/35 have READMEs (not 27/35). If 27 packages do have READMEs, the denominator likely isn’t 35. Please make the numerator/denominator consistent with the audit scope numbers.
| | **Package READMEs** | 27/35 (77%) | 35/35 (100%) | README.md presence | | |
| | **Package READMEs** | 25/35 (71%) | 35/35 (100%) | README.md presence | |
| **Where We Are:** The foundation is solid — 35 packages, 91+ components, 200+ test files, 68 Storybook stories, 98% spec compliance, and all 42 builds passing. The @objectstack/spec v3.0.0 migration is complete, and the Console v1.0 production build is optimized and shipping. | ||
|
|
||
| **What's Next:** Before expanding to marketplace or cloud features, we are focusing on making what we have **excellent**. The immediate priority is: | ||
| **What's Next:** Before expanding to marketplace or cloud features, we are focusing on **developer experience** and **user experience**. A full-repository audit (Feb 2026) identified concrete improvement areas across all 35 packages, 4 examples, the Console app, 128 documentation pages, and 68 Storybook stories. The re-prioritized focus is: |
There was a problem hiding this comment.
The package counts here don’t reconcile: repo text says "35 packages", but the audit table later implies 27 with README + 10 missing README (= 37). Please align the total package count and the README counts (or clarify which workspaces are excluded from the package total).
|
|
||
| | Area | Count | Notes | | ||
| |------|-------|-------| | ||
| | Packages | 35 | 27 with README, 10 missing README | |
There was a problem hiding this comment.
Audit scope table math is inconsistent: "Packages | 35" plus "27 with README, 10 missing README" sums to 37. Update either the total package count or the README breakdown so the numbers match (or explain what’s being counted).
| | Packages | 35 | 27 with README, 10 missing README | | |
| | Packages | 35 | 27 with README, 8 missing README | |
| | Test Files | 200+ | 3,235+ tests, 80% coverage | | ||
| | Examples | 4 | todo, crm, kitchen-sink, msw-todo | | ||
| | CLI Commands | 11 | init, build, dev, serve, doctor, etc. | | ||
| | I18n Locales | 11 | ar, de, en, es, fr, ja, ko, pt, ru, zh + RTL | |
There was a problem hiding this comment.
Locale count appears incorrect. @object-ui/i18n currently ships 10 built-in locales (ar, de, en, es, fr, ja, ko, pt, ru, zh); RTL is a direction, not an additional locale. Please update the count/list to match what’s in packages/i18n/src/locales/*.
| | I18n Locales | 11 | ar, de, en, es, fr, ja, ko, pt, ru, zh + RTL | | |
| | I18n Locales | 10 | ar, de, en, es, fr, ja, ko, pt, ru, zh (RTL supported as a direction) | |
Full-repository audit across all 35 packages, 128 doc pages, 68 Storybook stories, and 200+ test files. Restructured roadmap priorities based on concrete findings from both developer experience and user experience perspectives.
Audit findings
ROADMAP changes
OBJUI-xxx), CLI polish, 10 package READMEs✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.