Skip to content

Reorganize schema documentation as standard platform features#287

Merged
hotlong merged 4 commits intomainfrom
copilot/organize-phase-2-schema-docs
Jan 30, 2026
Merged

Reorganize schema documentation as standard platform features#287
hotlong merged 4 commits intomainfrom
copilot/organize-phase-2-schema-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Jan 30, 2026

The schema reference documentation (phase2-schemas.md) was an internal summary document that emphasized version-specific language. It needed transformation into customer-facing documentation presenting schemas as standard platform features, with content properly distributed to individual schema files.

Changes

Individual schema documentation - Added use case sections to schema reference files:

  • app-schema.mdx - Multi-page apps, admin dashboards, CRM systems, SaaS products
  • theme-schema.mdx - Brand consistency, white-labeling, accessibility, design systems
  • enhanced-actions.mdx - API integration, multi-step workflows, form submissions, batch operations
  • report-schema.mdx - Analytics dashboards, business intelligence, automated reporting, compliance

Schema overview - Restructured and renamed phase2-schemas.md to schema-overview.md:

  • Updated title to "Schema Overview"
  • Removed version-specific language and "Phase 2" emphasis
  • Presented features as standard platform capabilities
  • Changed "What's New in Phase 2?" to "Key Capabilities"
  • Transformed "Upgrading from Phase 1" to "Advanced Features" and "Getting Started"
  • Expanded installation instructions (npm/pnpm/yarn)
  • Added complete CRM quick start example
  • Reorganized learning resources by type (documentation, API reference, examples)

Navigation - Added block-schema to blocks/meta.json (was inaccessible in sidebar) and updated guide navigation to reference schema-overview

Example

Before, users saw only generic descriptions. Now each schema includes practical context:

## Use Cases

AppSchema is ideal for:
- **Multi-page applications** - Configure complex application structures with multiple routes
- **Admin dashboards** - Create comprehensive admin panels with role-based navigation
- **CRM systems** - Build customer relationship management interfaces

The overview now provides a complete quick start instead of just API references:

const app: AppSchema = {
  type: 'app',
  name: 'enterprise-crm',
  title: 'Enterprise CRM',
  layout: 'sidebar',
  menu: [/* ... */],
  actions: [/* ... */]
};
Original prompt

整理文档,Phase 2 Schema Reference
Complete reference for ObjectUI Phase 2 schemas including App, Theme, Reports, Blocks, and Enhanced Actions,这个只是总结文档不像是面向客户的文档,其中的内容放到的fumadocs文档合适的段落中。


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@vercel
Copy link
Copy Markdown

vercel Bot commented Jan 30, 2026

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

Project Deployment Actions Updated (UTC)
objectui Ready Ready Preview, Comment Jan 30, 2026 4:45pm
objectui-components Ready Ready Preview, Comment Jan 30, 2026 4:45pm
objectui-crm-app Error Error Jan 30, 2026 4:45pm

Request Review

Copilot AI and others added 2 commits January 30, 2026 16:24
…view

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copilot AI changed the title [WIP] 整理文档 Phase 2 Schema Reference Restructure Phase 2 Schema documentation for customer-facing use Jan 30, 2026
Copilot AI requested a review from hotlong January 30, 2026 16:30
@hotlong
Copy link
Copy Markdown
Collaborator

hotlong commented Jan 30, 2026

@copilot 不需要强调 phase 2,就按照平台的标准功能来介绍

Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Jan 30, 2026

@copilot 不需要强调 phase 2,就按照平台的标准功能来介绍

已更新文档,移除了 Phase 2 的强调:

  • phase2-schemas.md 重命名为 schema-overview.md
  • 更新标题为 "Schema Overview"
  • 移除文档中所有 Phase 2 版本强调
  • 将功能作为平台标准能力介绍

Commit: da7e730

Copilot AI changed the title Restructure Phase 2 Schema documentation for customer-facing use Reorganize schema documentation as standard platform features Jan 30, 2026
@hotlong hotlong marked this pull request as ready for review January 30, 2026 16:48
Copilot AI review requested due to automatic review settings January 30, 2026 16:49
@hotlong hotlong merged commit b4c361d into main Jan 30, 2026
15 of 16 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

✅ All checks passed!

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

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR reorganizes the schema documentation to present features as standard platform capabilities rather than version-specific additions. The main file phase2-schemas.md is renamed to schema-overview.md, with version-specific language ("Phase 2") removed throughout. Individual schema files receive new "Use Cases" sections, and navigation is updated to make previously inaccessible content available.

Changes:

  • Renamed and restructured phase2-schemas.md to schema-overview.md with updated title, description, and section headings
  • Added "Use Cases" sections to four schema documentation files (app-schema, theme-schema, enhanced-actions, report-schema)
  • Updated navigation metadata in guide/meta.json and blocks/meta.json to reflect the new filename and add block-schema

Reviewed changes

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

Show a summary per file
File Description
content/docs/guide/schema-overview.md Major restructuring: renamed from phase2-schemas.md, removed version-specific language, expanded installation instructions, added complete CRM quick start example, reorganized sections
content/docs/guide/meta.json Updated navigation reference from "phase2-schemas" to "schema-overview"
content/docs/core/app-schema.mdx Added use cases section describing multi-page apps, admin dashboards, CRM systems, internal tools, and SaaS products
content/docs/core/theme-schema.mdx Added use cases section covering brand consistency, white-labeling, accessibility, design systems, and A/B testing
content/docs/core/enhanced-actions.mdx Added use cases section for API integration, multi-step processes, form submissions, confirmation dialogs, event tracking, and batch operations
content/docs/core/report-schema.mdx Added use cases section for analytics dashboards, business intelligence, automated reporting, data exports, compliance reporting, and executive summaries
content/docs/blocks/meta.json Added "block-schema" to navigation, making it accessible in the sidebar
Comments suppressed due to low confidence (4)

content/docs/guide/schema-overview.md:353

  • The documentation still references files with "PHASE2" in their names (PHASE2_IMPLEMENTATION.md and PHASE2_QUICK_START.md). This contradicts the PR's goal of removing version-specific language and presenting features as standard platform capabilities. Consider either renaming these files to version-neutral names or noting that these are legacy file names that will be updated.
    content/docs/guide/schema-overview.md:360
  • The test file reference still contains "phase2-schemas.test.ts" which includes version-specific naming. This is inconsistent with the goal of presenting schemas as standard platform features. Consider referencing this as "schemas.test.ts" or noting this is a legacy filename, or verify if the file should be renamed.
    content/docs/guide/schema-overview.md:348
  • The document has two "Getting Started" sections - "Installation & Setup" at line 185 and "Getting Started" at line 332. This creates confusion about the document structure and duplicates some content. Consider consolidating these sections or renaming one to clarify the distinction (e.g., "Installation & Setup" for initial setup and "Getting Started" for step-by-step workflow).
    content/docs/guide/schema-overview.md:330
  • The "Advanced Features" section (lines 299-330) duplicates content that already appears earlier in the document. The "Core Schemas" subsection repeats information from line 20-158, the "Enhanced ActionSchema" subsection repeats information from lines 71-99, and the "View Components" subsection repeats information from lines 169-183. This entire section should be removed or restructured to avoid redundancy and improve document flow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants