Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 21, 2026

Restructures component documentation from category-based pages (e.g., form.md containing all form components) to individual pages per component (e.g., form/button.mdx, form/input.mdx) with live interactive demonstrations.

Changes

Demo Infrastructure

  • ComponentDemo: Renders ObjectUI schema as live component with title/description
  • DemoGrid: 2-column responsive grid for multiple demos
  • CodeDemo: Side-by-side schema + rendered output
  • ObjectUIProvider: Client component that imports @object-ui/components to trigger registry auto-registration

Documentation Structure

  • 32 individual .mdx files across 8 categories: basic/, form/, layout/, data-display/, feedback/, overlay/, disclosure/, complex/
  • Each page includes: description, interactive examples, TypeScript schema definition
  • Category-level meta.json files for sidebar navigation
  • Updated components/index.md with category overview

Example Component Page

---
title: "Button"
description: "Trigger actions with customizable styles"
---

import { ComponentDemo } from '@/app/components/ComponentDemo';

<ComponentDemo
  schema={{
    type: 'button',
    label: 'Click Me',
    variant: 'default'
  }}
  title="Basic Button"
/>

Dependencies

  • Added @object-ui/{components,core,react,types} as workspace dependencies to site package
  • Updated pnpm-lock.yaml

Screenshot

Component overview page showing new category-based navigation:

Component Overview

Known Issue

ComponentDemo shows "Unknown component type" errors. Component registry population in Next.js SSR context needs investigation - likely a timing issue with side-effect imports during SSR vs client hydration.

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.

@vercel
Copy link

vercel bot commented Jan 21, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
objectui-docs Error Error Jan 21, 2026 3:42pm
objectui-site Error Error Jan 21, 2026 3:42pm

Request Review

@huangyiirene
Copy link
Contributor

@copilot 请按照fumadocs 规范,在文档中嵌入组件演示效果

Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Co-authored-by: huangyiirene <7665279+huangyiirene@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for each component with demos Add individual component documentation pages with live demo infrastructure Jan 21, 2026
Copilot AI requested a review from huangyiirene January 21, 2026 15:45
@github-actions github-actions bot added documentation Improvements or additions to documentation dependencies apps labels Jan 21, 2026
@github-actions
Copy link

📦 Bundle Size Report

Package Size Gzipped
components (index.js) 1553.12KB 365.90KB
core (index.js) 0.53KB 0.28KB
data-objectql (ObjectQLDataSource.js) 11.05KB 2.64KB
data-objectql (hooks.js) 5.62KB 1.43KB
data-objectql (index.js) 0.62KB 0.36KB
designer (index.js) 1.46KB 0.51KB
plugin-charts (AdvancedChartImpl-DazADGz5.js) 74.89KB 15.82KB
plugin-charts (BarChart-CRc8MAtI.js) 551.60KB 127.51KB
plugin-charts (ChartImpl-DVw_7KEd.js) 3.17KB 1.10KB
plugin-charts (index-CdgY2AuM.js) 12.39KB 3.83KB
plugin-charts (index.js) 0.21KB 0.16KB
plugin-editor (MonacoImpl-B7ZgZJJG.js) 18.15KB 5.59KB
plugin-editor (index-Dl3HAAqu.js) 10.07KB 3.31KB
plugin-editor (index.js) 0.19KB 0.15KB
plugin-kanban (KanbanImpl-CUWM-JC-.js) 76.50KB 20.46KB
plugin-kanban (index-BV3FWhCb.js) 11.86KB 3.67KB
plugin-kanban (index.js) 0.18KB 0.15KB
plugin-markdown (MarkdownImpl-BRkYjVWf.js) 256.79KB 64.50KB
plugin-markdown (index-D_CdfEXQ.js) 9.59KB 3.16KB
plugin-markdown (index.js) 0.19KB 0.15KB
react (SchemaRenderer.js) 1.44KB 0.73KB
react (index.js) 0.32KB 0.23KB
react (index.test.js) 0.34KB 0.26KB
types (api-types.js) 0.20KB 0.18KB
types (app.js) 0.20KB 0.18KB
types (base.js) 0.20KB 0.18KB
types (complex.js) 0.20KB 0.18KB
types (crud.js) 0.20KB 0.18KB
types (data-display.js) 0.20KB 0.18KB
types (data.js) 0.20KB 0.18KB
types (disclosure.js) 0.20KB 0.18KB
types (feedback.js) 0.20KB 0.18KB
types (form.js) 0.20KB 0.18KB
types (index.js) 0.34KB 0.25KB
types (layout.js) 0.20KB 0.18KB
types (navigation.js) 0.20KB 0.18KB
types (objectql.js) 0.20KB 0.18KB
types (overlay.js) 0.20KB 0.18KB
types (registry.js) 0.20KB 0.18KB

Size Limits

  • ✅ Core packages should be < 50KB gzipped
  • ✅ Component packages should be < 100KB gzipped
  • ⚠️ Plugin packages should be < 150KB gzipped

@github-actions
Copy link

✅ All checks passed!

  • ✅ Type check passed
  • ✅ Tests passed
  • ✅ Lint check completed

@huangyiirene huangyiirene marked this pull request as ready for review January 21, 2026 15:53
@huangyiirene huangyiirene merged commit 8f6fa7a into main Jan 21, 2026
11 of 14 checks passed
Copilot AI requested a review from huangyiirene January 21, 2026 15:54
Copilot stopped work on behalf of huangyiirene due to an error January 21, 2026 15:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

apps dependencies documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants