docs: add DX Roadmap for post-v3.0 developer experience improvements#641
docs: add DX Roadmap for post-v3.0 developer experience improvements#641
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…plan Based on full codebase scan of 171 schemas, 191 test files, 40+ doc pages, 4 examples, and 19 packages. Covers 6 phases: Onboarding, Schema DX Helpers, Documentation, CLI & Tooling, Studio, and Ecosystem. Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Adds a dedicated post-v3.0 Developer Experience roadmap to capture gaps found in the repo audit and outline phased DX improvements across onboarding, schema helpers, documentation, CLI/tooling, Studio, and ecosystem efforts.
Changes:
- Introduces
DX_ROADMAP.mdwith a 6-phase DX plan, prioritization matrix, and success metrics. - Documents concrete DX tasks such as an interactive playground,
create-objectstack, schema helper factories, improved error messaging, and CLI tooling enhancements.
|
|
||
| | Task | Details | Priority | | ||
| |------|---------|----------| | ||
| | Visual field type reference | Interactive page showing all 46+ field types with live previews | 🔴 High | |
There was a problem hiding this comment.
This claims there are "46+" field types, but packages/spec/src/data/field.zod.ts currently defines 44 values in the FieldType enum. Consider updating the count (or referencing the enum directly so the roadmap doesn’t go stale).
| | Visual field type reference | Interactive page showing all 46+ field types with live previews | 🔴 High | | |
| | Visual field type reference | Interactive page showing all field types defined in the FieldType enum, with live previews | 🔴 High | |
|
|
||
| | Task | Details | Priority | | ||
| |------|---------|----------| | ||
| | Error code catalog | All 46 error codes with descriptions, causes, and fixes | 🔴 High | |
There was a problem hiding this comment.
This references "46 error codes", but StandardErrorCode in packages/spec/src/api/errors.zod.ts currently contains 51 codes. Please update the number (or phrase it as "all StandardErrorCode values") to keep the roadmap accurate.
| | Error code catalog | All 46 error codes with descriptions, causes, and fixes | 🔴 High | | |
| | Error code catalog | Catalog of all StandardErrorCode values with descriptions, causes, and fixes | 🔴 High | |
|
|
||
| ### Phase 3 Checklist | ||
|
|
||
| - [ ] Create field type gallery page with all 46+ types |
There was a problem hiding this comment.
Checklist item says "46+ types", but the current FieldType enum has 44 values. Suggest updating this to the actual count or wording it to avoid hardcoding a number.
| - [ ] Create field type gallery page with all 46+ types | |
| - [ ] Create field type gallery page with all defined field types |
|
|
||
| - [ ] Create field type gallery page with all 46+ types | ||
| - [ ] Create per-field-type configuration reference tables | ||
| - [ ] Create error code catalog with 46 error codes |
There was a problem hiding this comment.
Checklist item says "46 error codes", but StandardErrorCode currently contains 51 entries. Please update the count or wording so it matches the spec.
| - [ ] Create error code catalog with 46 error codes | |
| - [ ] Create error code catalog for all standard error codes |
Full codebase + docs audit (171 schemas, 191 test files, 40+ doc pages, 4 examples, 19 packages) to identify DX gaps and prioritize next improvements.
Key Findings
create-objectstackscaffolder, examples missing "How to Run" sectionsField.*helpers are excellent butObjectSchema.create()is a pass-through identity function; nodefineView()/defineApp()/defineFlow()helpersobjectstack diffand enhancedobjectstack doctormarked as future in v3.0 roadmap but not implementedDX_ROADMAP.md— 6 Phasescreate-objectstackwizard, quick-start improvementsdiff,doctor,lint,explaincommands; VSCode extensionIncludes priority matrix (impact × effort), success metrics table, and relationship mapping to existing
ROADMAP.mdandapps/studio/ROADMAP.md.💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.