Add public roadmap, VitePress documentation site, and GitHub Pages deployment by Copilot · Pull Request #3 · objectstack-ai/objectui

Copilot · 2026-01-13T12:33:21Z

Created a user-facing public roadmap document (docs/ROADMAP.md) in English showing what features are coming and when users can expect them. Written sincerely for end users to help them evaluate Object UI and plan adoption.

Additionally, initialized a complete VitePress documentation site with protocol specifications in the root docs/ directory and set up automated GitHub Pages deployment.

Roadmap Document

Vision: Clear explanation of what Object UI is and who it's for ("JSON to world-class UI in minutes")
What Makes Us Different: User benefits explained simply (3x faster, 6x smaller bundles, easy to learn, full control)
Release Timeline: Quarterly feature releases (Q1-Q4 2026):
- Q1 2026 (March): Foundation - 20+ components, schema rendering, playground
- Q2 2026 (June): Power Features - data management, advanced components, themes
- Q3 2026 (September): Visual Designer - drag-and-drop, AI assistance, collaboration
- Q4 2026 (December): Enterprise - security, scale, internationalization
Feature Examples: Practical code snippets showing how to use each feature
What You Can Do Today: Available actions (try preview, star on GitHub, provide feedback)
Beyond 2026: Future vision (multi-framework, cross-platform, AI, 3D)
FAQ: 7 common questions answered (production-ready date, pricing, compatibility, migration)
Stay Updated: How to follow progress (GitHub, email)

296-line English markdown document focused entirely on user value. Each quarterly release includes practical examples and "What this means for you" benefit statements. Written in conversational, approachable language without internal planning details.

VitePress Documentation Site

Created a complete documentation site in the root docs/ directory with:

Structure:

Homepage with hero section, features, and quick examples
Guide section (Introduction, Quick Start, Installation)
Protocol specifications (8 protocol docs: Object, View, Page, Form, Menu, App, Report, Overview)
API documentation (Core, React, Components, Designer)
Public roadmap integrated

Features:

VitePress 1.6.4 configuration with navigation and sidebar
Local search functionality
Dark/light theme support
Mobile responsive design
GitHub integration

Commands:

pnpm docs:dev - Start development server
pnpm docs:build - Build for production
pnpm docs:preview - Preview production build

Integration:

Documentation at root docs/ directory
Workspace configuration for object-ui-docs package
All protocol specifications from docs/objectql/ integrated

GitHub Pages Deployment

Automated Workflow (.github/workflows/deploy-docs.yml):

Triggers automatically on push to main branch when docs change
Manual deployment option via workflow_dispatch
Uses Node 20, pnpm 8 with caching for fast builds
Builds documentation and deploys to GitHub Pages
Will be available at: https://objectql.github.io/object-ui/

Configuration:

VitePress base path set to /object-ui/ for GitHub Pages
Build output directory: docs/.vitepress/dist/
Ignores dead links for legacy documentation
Build output added to .gitignore

Requirements:

GitHub Pages must be enabled in repository settings
Source should be set to "GitHub Actions"
Workflow permissions should allow writing to Pages

The documentation site is now at the root level and will automatically deploy to GitHub Pages on every push to main! 🚀

Original prompt

我要做全球最顶级的界面构建工具，帮我写开发计划文档

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

huangyiirene · 2026-01-13T12:44:47Z

用英文编写，诚恳地给最终用户看 @copilot

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot · 2026-01-13T12:48:56Z

用英文编写，诚恳地给最终用户看 @copilot

Replaced the Chinese document with a comprehensive English version (docs/DEVELOPMENT_PLAN.md) written sincerely for end users. The document explains our vision, technical advantages, and roadmap in an accessible way while maintaining professional depth.

Commit: 20b50be

huangyiirene · 2026-01-13T12:51:44Z

@copilot 注意，这个文档是要给最终用户看的，不是内部文件

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

huangyiirene · 2026-01-13T12:56:54Z

@copilot 现在初始化文档库，订立协议规范，基于这个文档库搭建vitepress

Copilot · 2026-01-13T12:56:57Z

@copilot 注意，这个文档是要给最终用户看的，不是内部文件

Understood! I've completely rewritten it as a public roadmap for end users. Removed all internal details (team structure, budget, risk management) and focused on what users will get and when. The new docs/ROADMAP.md shows quarterly features with examples, benefits, and an FAQ section.

Commit: 409bc37

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot · 2026-01-13T13:05:17Z

@copilot 现在初始化文档库，订立协议规范，基于这个文档库搭建vitepress

Completed! Initialized VitePress documentation site with full protocol specifications:

✅ Created apps/docs/ with VitePress
✅ 20+ pages: guides, protocol specs, API docs, roadmap
✅ Configured navigation and sidebar structure
✅ Integrated with pnpm workspace
✅ Added docs scripts: pnpm docs:dev, docs:build, docs:preview

VitePress is running successfully. Start with: pnpm docs:dev

Commit: 49cc7ec

huangyiirene · 2026-01-13T13:07:25Z

@copilot docs在根目录就可以，然后编写自动化工作流把它发布成GitHub的网站

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot · 2026-01-13T13:12:43Z

@copilot docs在根目录就可以，然后编写自动化工作流把它发布成GitHub的网站

Done! Moved docs to root directory and added automated GitHub Pages deployment:

✅ Documentation now in docs/ at root level
✅ Created .github/workflows/deploy-docs.yml for automatic deployment
✅ Configured VitePress with base path /object-ui/
✅ Tested build successfully

The workflow will automatically deploy to GitHub Pages when changes are pushed to main. Site will be at: https://objectql.github.io/object-ui/

Commit: 9f1735e

Copilot

Pull request overview

This PR establishes a comprehensive documentation infrastructure by creating a public roadmap document, initializing a VitePress documentation site with protocol specifications, and configuring automated GitHub Pages deployment for the Object UI project.

Changes:

Created user-facing public roadmap (docs/ROADMAP.md) outlining quarterly 2026 feature releases with practical examples and user-benefit focus
Initialized VitePress documentation site with homepage, guides, protocol specifications, and API references
Set up automated GitHub Pages deployment workflow with pnpm caching and build optimization

Reviewed changes

Copilot reviewed 23 out of 25 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
docs/ROADMAP.md	295-line English roadmap with Q1-Q4 2026 release timeline, feature examples, FAQ, and user-focused benefit statements
docs/.vitepress/config.mts	VitePress configuration with navigation, sidebar structure, search, and GitHub Pages base path
.github/workflows/deploy-docs.yml	GitHub Actions workflow for automated documentation deployment with Node 20 and pnpm 8
docs/protocol/*.md	Eight protocol specification files (object, view, page, form, menu, app, report, overview) defining metadata schemas
docs/guide/*.md	Three guide files (introduction, quick-start, installation) for getting started documentation
docs/api/*.md	Four API reference files (core, react, components, designer) documenting package APIs
docs/index.md	VitePress homepage with hero section, features grid, and quick examples
docs/package.json	Workspace package configuration with VitePress 1.0.0 and dev/build/preview scripts
pnpm-workspace.yaml	Added docs directory to workspace packages
package.json	Added workspace entry and npm scripts for docs:dev, docs:build, docs:preview

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Introduces a new SVG logo in docs/public/logo.svg featuring a gradient background and UI layout symbols. This asset can be used for branding or documentation visuals.

- Fix handleExportCSV to guard on gridRef.current?.api (issue #1) - Add dedicated onContextMenuAction callback instead of overloading onCellClicked (issue #2) - Remove icon property from customItems to prevent HTML injection (issue #3) - Remove validation claim from README - only basic AG Grid editing (issue #4) - Add test assertions for all new inputs (editable, exportConfig, etc.) (issue #5) - Fix onExport type to only support 'csv' format (issue #6) - Remove unused ColumnConfig properties (autoSize, groupable) (issue #9) - Type schema props with proper interfaces instead of 'any' (issue #10) - Update export description to only mention CSV (issue #11) - Add AG Grid Community vs Enterprise section to docs (issue #8) - Update README and docs with new callback and clarifications All tests pass (8/8), lint clean (0 errors) Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

…warning, i18n fallback - Issue #1: Normalize `in`/`not in` operators to backend-compatible `or`/`and` of `=`/`!=` - Issue #2: Filter merging now validates and filters empty conditions - Issue #3: CSV export safely serializes arrays (semicolon-separated) and objects (JSON) - Issue #5: Request counter prevents stale data from overwriting latest results - Issue #6: PullToRefresh resets pull distance immediately to prevent UI lock - Issue #7: $top configurable via schema.pagination, data limit warning shown - Issue #8: Extended i18n fallback translations for all ListView labels - Issue #9: Defensive null checks in effectiveFields for mismatched objectDef - Issue #10: Added FilterNormalization, Export, and DataFetch test suites Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>

Initial plan

450908f

Copilot AI assigned Copilot and huangyiirene Jan 13, 2026

Copilot started work on behalf of huangyiirene January 13, 2026 12:34 View session

Add comprehensive development plan document (开发计划.md)

25897ad

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add development plan document for UI building tool~~ Add comprehensive development plan document for world-class interface builder Jan 13, 2026

Copilot AI requested a review from huangyiirene January 13, 2026 12:40

Copilot finished work on behalf of huangyiirene January 13, 2026 12:40

Copilot started work on behalf of huangyiirene January 13, 2026 12:45 View session

Replace Chinese development plan with English version for end users

20b50be

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot finished work on behalf of huangyiirene January 13, 2026 12:49

Copilot started work on behalf of huangyiirene January 13, 2026 12:52 View session

Copilot AI and others added 4 commits January 13, 2026 12:53

Replace internal dev plan with user-facing roadmap

7c41633

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Fix URL inconsistency in roadmap (use objectui.org)

a354d82

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Remove 'coming soon' placeholders and improve user engagement

5378992

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Remove unverified production usage claim from FAQ

409bc37

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot AI changed the title ~~Add comprehensive development plan document for world-class interface builder~~ Add public roadmap for end users Jan 13, 2026

Copilot finished work on behalf of huangyiirene January 13, 2026 12:57

Copilot started work on behalf of huangyiirene January 13, 2026 12:58 View session

Initialize VitePress documentation site with protocol specifications

49cc7ec

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot AI changed the title ~~Add public roadmap for end users~~ Add public roadmap and initialize VitePress documentation site Jan 13, 2026

Copilot finished work on behalf of huangyiirene January 13, 2026 13:06

Copilot started work on behalf of huangyiirene January 13, 2026 13:07 View session

Move docs to root directory and add GitHub Pages deployment workflow

9f1735e

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>

Copilot AI changed the title ~~Add public roadmap and initialize VitePress documentation site~~ Add public roadmap, VitePress documentation site, and GitHub Pages deployment Jan 13, 2026

Copilot finished work on behalf of huangyiirene January 13, 2026 13:13

huangyiirene requested review from Copilot and removed request for huangyiirene January 13, 2026 13:14

Copilot AI reviewed Jan 13, 2026

View reviewed changes

huangyiirene marked this pull request as ready for review January 13, 2026 13:38

hotlong added 3 commits January 13, 2026 21:41

Merge branch 'main' into copilot/create-development-plan-document

9aacfed

更新文档链接，调整基础路径，添加 CNAME 文件以支持自定义域名

b3ba994

Add new logo SVG to documentation assets

b9c90c6

Introduces a new SVG logo in docs/public/logo.svg featuring a gradient background and UI layout symbols. This asset can be used for branding or documentation visuals.

huangyiirene merged commit e8a8338 into main Jan 13, 2026
1 of 5 checks passed

This was referenced Jan 13, 2026

feat: Add enterprise data table component with Airtable-like features including column resizing and reordering #13

Merged

Add Airtable-style calendar view component #16

Merged

Add Markdown component with GFM support and XSS protection #19

Merged

Copilot AI mentioned this pull request Jan 24, 2026

Add AG Grid plugin with lazy loading and peer dependency architecture #172

Merged

Copilot AI mentioned this pull request Jan 25, 2026

Add Zod runtime validation schemas for all UI components #193

Merged

Copilot AI mentioned this pull request Feb 2, 2026

Implement ObjectStack Spec v0.8.2 compliance for Console plugin integration #325

Merged

Copilot AI mentioned this pull request Feb 20, 2026

fix(ListView): normalize filter AST, safe export, request debounce, data limit warning #659

Merged

Copilot AI mentioned this pull request Feb 22, 2026

docs: ROADMAP P1.8.1 — view config live preview sync gap analysis #714

Merged

hotlong mentioned this pull request Feb 22, 2026

通用 Schema-Driven 配置面板框架建设及全平台接入 #731

Closed

21 tasks

Copilot AI mentioned this pull request Feb 23, 2026

feat: ConfigPanel disabledWhen, expandedSections, description spec alignment, navigation hints #805

Merged

Copilot AI mentioned this pull request Feb 24, 2026

ObjectGrid cell type rendering: select/status Badge colors, date Overdue format, boolean semantic indicators #823

Merged

Copilot AI mentioned this pull request Mar 31, 2026

Fix dashboard to not display hardcoded data on server errors #1152

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add public roadmap, VitePress documentation site, and GitHub Pages deployment#3

Add public roadmap, VitePress documentation site, and GitHub Pages deployment#3
huangyiirene merged 12 commits intomainfrom
copilot/create-development-plan-document

Copilot AI commented Jan 13, 2026 •

edited

Loading

Uh oh!

huangyiirene commented Jan 13, 2026

Uh oh!

Copilot AI commented Jan 13, 2026

Uh oh!

huangyiirene commented Jan 13, 2026

Uh oh!

huangyiirene commented Jan 13, 2026

Uh oh!

Copilot AI commented Jan 13, 2026

Uh oh!

Copilot AI commented Jan 13, 2026

Uh oh!

huangyiirene commented Jan 13, 2026

Uh oh!

Copilot AI commented Jan 13, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

Copilot AI commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Roadmap Document

VitePress Documentation Site

GitHub Pages Deployment

Uh oh!

huangyiirene commented Jan 13, 2026

Uh oh!

Copilot AI commented Jan 13, 2026

Uh oh!

huangyiirene commented Jan 13, 2026

Uh oh!

huangyiirene commented Jan 13, 2026

Uh oh!

Copilot AI commented Jan 13, 2026

Uh oh!

Copilot AI commented Jan 13, 2026

Uh oh!

huangyiirene commented Jan 13, 2026

Uh oh!

Copilot AI commented Jan 13, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Copilot AI commented Jan 13, 2026 •

edited

Loading