Sync documentation with current Zod schema state#99
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
…nt field type count Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
…rent field count Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
…de format descriptions Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Aligns manual documentation with the current Zod schema state (protocol inventory + field type docs), updating counts and adding coverage for newly documented types.
Changes:
- Updated documentation references for field type counts and categories, and added docs for
sliderandqrcode. - Refreshed protocol structure listings (notably in
ARCHITECTURE.md) to reflect implemented schemas across Data/UI/System/AI. - Updated internal prompts/roadmap/release notes to match the current schema descriptions.
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 18 comments.
Show a summary per file
| File | Description |
|---|---|
| internal/planning/DEVELOPMENT_ROADMAP.md | Updates roadmap field type count reference |
| content/docs/tutorials.mdx | Updates tutorial card description field type count |
| content/docs/specifications/architecture/index.mdx | Updates architecture overview field type count |
| content/docs/specifications/architecture/data-layer.mdx | Updates data layer field type count + category list |
| content/docs/quick-start/backend-developers.mdx | Updates quick-start references to field type count |
| content/docs/index.mdx | Updates homepage quick link field type count |
| content/docs/index.cn.mdx | Updates CN homepage field type count |
| content/docs/guides/getting-started.mdx | Updates getting-started field type count reference |
| content/docs/guides/getting-started.cn.mdx | Updates CN getting-started field type count reference |
| content/docs/guides/field-types.mdx | Updates field types guide count; adds geolocation note + slider/qrcode sections |
| content/docs/guides/field-types.cn.mdx | Updates CN field types guide count |
| RELEASE_NOTES.md | Updates release notes field type count reference |
| README.md | Updates README protocol summaries (field type count + protocol bullets) |
| ARCHITECTURE.md | Updates protocol file tree (adds/removes “missing/planned” markers; adds schemas) |
| .github/prompts/documentation-writer.prompt.md | Updates prompt field type count reference |
| .github/prompts/data-protocol.prompt.md | Updates prompt field type count reference |
| # 字段类型参考 | ||
|
|
||
| ObjectStack 支持 **30+ 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。 | ||
| ObjectStack 支持 **35 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。 |
There was a problem hiding this comment.
这里的说明改成了 35 种字段类型,但 FieldType 枚举目前只有 34 个值。请把数量改为与 schema 一致。
| ObjectStack 支持 **35 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。 | |
| ObjectStack 支持 **34 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。 |
| ### 1. Data Protocol (ObjectQL) | ||
| Defines the "Shape of Data" and business logic. | ||
| - **Schema:** Objects, Fields (23+ types including text, number, select, lookup, formula, autonumber, etc.) | ||
| - **Schema:** Objects, Fields (35 types including text, number, select, lookup, formula, autonumber, slider, qrcode, etc.) |
There was a problem hiding this comment.
README says there are 35 field types, but packages/spec/src/data/field.zod.ts currently defines 34 FieldType values. Please update this count to match the schema (or update the schema if 35 is intended).
| - **Schema:** Objects, Fields (35 types including text, number, select, lookup, formula, autonumber, slider, qrcode, etc.) | |
| - **Schema:** Objects, Fields (34 types including text, number, select, lookup, formula, autonumber, slider, qrcode, etc.) |
| ## Field Types | ||
|
|
||
| ObjectStack supports 23+ field types, organized into categories: | ||
| ObjectStack supports 35 field types, organized into categories: |
There was a problem hiding this comment.
This prompt says ObjectStack supports 35 field types, but FieldType in packages/spec/src/data/field.zod.ts currently enumerates 34 values. Please update the number so the prompt stays consistent with the schema.
| ObjectStack supports 35 field types, organized into categories: | |
| ObjectStack supports 34 field types, organized into categories: |
|
|
||
| When user says: | ||
| - **"Create Field Protocol"** → Implement complete `field.zod.ts` with all 23+ field types | ||
| - **"Create Field Protocol"** → Implement complete `field.zod.ts` with all 35 field types |
There was a problem hiding this comment.
This prompt references “all 35 field types”, but the current FieldType enum has 34 values. Please update the count to match packages/spec/src/data/field.zod.ts.
| - **"Create Field Protocol"** → Implement complete `field.zod.ts` with all 35 field types | |
| - **"Create Field Protocol"** → Implement complete `field.zod.ts` with all 34 field types |
|
|
||
| #### Field Schema | ||
| Defines data properties with 25+ types: | ||
| Defines data properties with 35 types: |
There was a problem hiding this comment.
This section says there are 35 field types, but FieldType in packages/spec/src/data/field.zod.ts currently enumerates 34 values. Please update the count (or the enum) to keep this spec accurate.
| Defines data properties with 35 types: | |
| Defines data properties across multiple field types: |
|
|
||
| ### Essential Guides | ||
| - **[Field Types](/docs/guides/field-types)** - 30+ field types with examples (text, number, select, lookup, formula, etc.) | ||
| - **[Field Types](/docs/guides/field-types)** - 35 field types with examples (text, number, select, lookup, formula, etc.) |
There was a problem hiding this comment.
This link description states there are 35 field types, but the FieldType enum currently contains 34 values. Please update the count to match the schema.
| - **[Field Types](/docs/guides/field-types)** - 35 field types with examples (text, number, select, lookup, formula, etc.) | |
| - **[Field Types](/docs/guides/field-types)** - 34 field types with examples (text, number, select, lookup, formula, etc.) |
|
|
||
| 1. **Explore Examples**: Check out the [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) for a full-featured implementation | ||
| 2. **Learn Field Types**: See the [Field Types Guide](/docs/guides/field-types) for all 30+ field types | ||
| 2. **Learn Field Types**: See the [Field Types Guide](/docs/guides/field-types) for all 35 field types |
There was a problem hiding this comment.
This guide references 35 field types, but the FieldType enum in packages/spec/src/data/field.zod.ts currently has 34 values. Please update this count to match the schema.
| 2. **Learn Field Types**: See the [Field Types Guide](/docs/guides/field-types) for all 35 field types | |
| 2. **Learn Field Types**: See the [Field Types Guide](/docs/guides/field-types) for all 34 field types |
|
|
||
| 1. **探索示例**:查看 [CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm) 了解完整功能实现 | ||
| 2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 30+ 种字段类型 | ||
| 2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 35 种字段类型 |
There was a problem hiding this comment.
这里写的是 35 种字段类型,但 FieldType 枚举目前只有 34 个值。请把数量改为与 schema 一致。
| 2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 35 种字段类型 | |
| 2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 34 种字段类型 |
| # Field Types Reference | ||
|
|
||
| ObjectStack supports **30+ field types** covering text, numbers, dates, selections, relationships, media, calculations, and enhanced types. This guide provides practical examples for each type. | ||
| ObjectStack supports **35 field types** covering text, numbers, dates, selections, relationships, media, calculations, and enhanced types. This guide provides practical examples for each type. |
There was a problem hiding this comment.
This page says ObjectStack supports 35 field types, but FieldType currently contains 34 values in packages/spec/src/data/field.zod.ts. Please update the count to match the schema.
| ObjectStack supports **35 field types** covering text, numbers, dates, selections, relationships, media, calculations, and enhanced types. This guide provides practical examples for each type. | |
| ObjectStack supports **34 field types** covering text, numbers, dates, selections, relationships, media, calculations, and enhanced types. This guide provides practical examples for each type. |
| title="Field Types Reference" | ||
| href="/docs/guides/field-types" | ||
| description="Complete guide to all 23+ field types" | ||
| description="Complete guide to all 35 field types" |
There was a problem hiding this comment.
This card description says there are 35 field types, but FieldType currently enumerates 34 values. Please adjust the number to keep the docs consistent with the schema.
| description="Complete guide to all 35 field types" | |
| description="Complete guide to all 34 field types" |
Documentation referenced outdated field type counts and protocol structures. Manual docs now reflect the actual 49 Zod schemas across 5 protocol categories.
Changes
Field Type Documentation
slider,qrcodegeolocationaslocationalias with detailed barcode format descriptionsProtocol Structure (ARCHITECTURE.md)
[MISSING]/[PLANNED]markers for implemented schemasfilter,organization,audit,jobto System ProtocolScope
content/docs/references/(unchanged)Field Type Categories
All references now aligned with
src/data/field.zod.tsFieldType enum (35 types).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.