Reorganize schema documentation as standard platform features#287
Merged
Reorganize schema documentation as standard platform features#287
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…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
Collaborator
|
@copilot 不需要强调 phase 2,就按照平台的标准功能来介绍 |
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Contributor
Author
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
approved these changes
Jan 30, 2026
Contributor
|
✅ All checks passed!
|
Contributor
There was a problem hiding this comment.
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.mdtoschema-overview.mdwith 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.jsonandblocks/meta.jsonto 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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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 productstheme-schema.mdx- Brand consistency, white-labeling, accessibility, design systemsenhanced-actions.mdx- API integration, multi-step workflows, form submissions, batch operationsreport-schema.mdx- Analytics dashboards, business intelligence, automated reporting, complianceSchema overview - Restructured and renamed
phase2-schemas.mdtoschema-overview.md:Navigation - Added
block-schematoblocks/meta.json(was inaccessible in sidebar) and updated guide navigation to referenceschema-overviewExample
Before, users saw only generic descriptions. Now each schema includes practical context:
The overview now provides a complete quick start instead of just API references:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.