-
Notifications
You must be signed in to change notification settings - Fork 1
Sync documentation with current Zod schema state #99
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
1fa64f8
02fb21e
3841ffa
d6fde71
5145ae1
e6e70a9
2891135
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -80,7 +80,7 @@ a single property or column in an Object (table). | |||||
|
|
||||||
| ## Field Types | ||||||
|
|
||||||
| ObjectStack supports 23+ field types, organized into categories: | ||||||
| ObjectStack supports 35 field types, organized into categories: | ||||||
|
||||||
| ObjectStack supports 35 field types, organized into categories: | |
| ObjectStack supports 34 field types, organized into categories: |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -59,7 +59,7 @@ The ObjectStack Protocol (`@objectstack/spec`) is divided into five core modules | |||||
|
|
||||||
| ### 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.) | ||||||
|
||||||
| - **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.) |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -52,7 +52,7 @@ This is the first public release of the ObjectStack ecosystem, providing: | |||||
|
|
||||||
| ### Core Capabilities | ||||||
| - **Data Protocol (ObjectQL)**: Complete schema definitions for Objects and Fields | ||||||
| - 23+ field types (text, number, select, lookup, formula, autonumber, etc.) | ||||||
| - 35 field types (text, number, select, lookup, formula, autonumber, slider, qrcode, etc.) | ||||||
|
||||||
| - 35 field types (text, number, select, lookup, formula, autonumber, slider, qrcode, etc.) | |
| - 34 field types (text, number, select, lookup, formula, autonumber, slider, qrcode, etc.) |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,7 @@ description: ObjectStack 所有字段类型的完整指南,包含示例和配 | |||||
|
|
||||||
| # 字段类型参考 | ||||||
|
|
||||||
| ObjectStack 支持 **30+ 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。 | ||||||
| ObjectStack 支持 **35 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。 | ||||||
|
||||||
| ObjectStack 支持 **35 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。 | |
| ObjectStack 支持 **34 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。 |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -6,7 +6,7 @@ description: Complete guide to all ObjectStack field types with examples and con | |||||
|
|
||||||
| # 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. | ||||||
|
||||||
| 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. |
Copilot
AI
Jan 24, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The note says geolocation is an alternative name for location and “both refer to the same field type”, but in the spec they are two distinct FieldType string values ('location' and 'geolocation'). Consider rephrasing to clarify they are separate enum values that represent the same underlying coordinate concept (and explain when to use each).
| > **Note:** `geolocation` is an alternative name for the `location` field type. Both refer to the same GPS coordinate field. | |
| > **Note:** `location` and `geolocation` are separate `FieldType` enum values that both represent GPS coordinates with the same underlying data shape. Use `location` for new fields; `geolocation` is provided for compatibility with existing schemas and integrations that already use that enum value. |
Copilot
AI
Jan 24, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The QR code examples/config don’t match the current schema. FieldSchema uses barcodeFormat (enum: qr, ean13, ean8, code128, code39, upca, upce) plus qrErrorCorrection, displayValue, and allowScanning; there is no autoGenerate, and format: 'barcode' isn’t a supported value. Please align the docs with the actual field properties and supported formats in packages/spec/src/data/field.zod.ts.
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -276,7 +276,7 @@ views: { | |||||
| 现在你有了有效的元数据,你可以: | ||||||
|
|
||||||
| 1. **探索示例**:查看 [CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm) 了解完整功能实现 | ||||||
| 2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 30+ 种字段类型 | ||||||
| 2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 35 种字段类型 | ||||||
|
||||||
| 2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 35 种字段类型 | |
| 2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 34 种字段类型 |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -276,7 +276,7 @@ views: { | |||||
| Now that you have valid metadata, you can: | ||||||
|
|
||||||
| 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 | ||||||
|
||||||
| 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 |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -42,7 +42,7 @@ import { Book, Compass, FileText, Layers } from 'lucide-react'; | |||||
| ## 快速链接 | ||||||
|
|
||||||
| ### 基础指南 | ||||||
| - **[字段类型](/docs/guides/field-types)** - 30+ 种字段类型及示例(文本、数字、选择、查找、公式等) | ||||||
| - **[字段类型](/docs/guides/field-types)** - 35 种字段类型及示例(文本、数字、选择、查找、公式等) | ||||||
|
||||||
| - **[字段类型](/docs/guides/field-types)** - 35 种字段类型及示例(文本、数字、选择、查找、公式等) | |
| - **[字段类型](/docs/guides/field-types)** - 34 种字段类型及示例(文本、数字、选择、查找、公式等) |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -71,7 +71,7 @@ This documentation is the authoritative reference for the ObjectStack Protocol. | |||||
| ## Quick Links | ||||||
|
|
||||||
| ### 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.) | ||||||
|
||||||
| - **[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.) |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -77,7 +77,7 @@ export const Task = ObjectSchema.create({ | |||||
|
|
||||||
| ## Field Types You Know and Love | ||||||
|
|
||||||
| ObjectStack provides **23+ field types** with automatic validation: | ||||||
| ObjectStack provides **35 field types** with automatic validation: | ||||||
|
||||||
| ObjectStack provides **35 field types** with automatic validation: | |
| ObjectStack provides **34 field types** with automatic validation: |
Copilot
AI
Jan 24, 2026
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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" |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -29,12 +29,13 @@ const CustomerAccount = { | |||||
| ``` | ||||||
|
|
||||||
| #### Field Schema | ||||||
| Defines data properties with 25+ types: | ||||||
| Defines data properties with 35 types: | ||||||
|
||||||
| Defines data properties with 35 types: | |
| Defines data properties across multiple field types: |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -11,7 +11,7 @@ The ObjectStack Protocol is built on three core layers that work together to pro | |||||
|
|
||||||
| ### [Data Layer (ObjectQL)](/docs/specifications/architecture/data-layer) | ||||||
| The Data Layer defines the "Shape of Data" and business logic. It includes: | ||||||
| - **Schema**: Objects and Fields with 23+ field types | ||||||
| - **Schema**: Objects and Fields with 35 field types | ||||||
|
||||||
| - **Schema**: Objects and Fields with 35 field types | |
| - **Schema**: Objects and Fields with 34 field types |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -33,7 +33,7 @@ Learn ObjectStack through practical, hands-on tutorials. Each tutorial is design | |||||
| <Card | ||||||
| title="Master Field Types" | ||||||
| href="/docs/guides/field-types" | ||||||
| description="Deep dive into all 23+ field types with examples" | ||||||
| description="Deep dive into all 35 field types with examples" | ||||||
|
||||||
| description="Deep dive into all 35 field types with examples" | |
| description="Deep dive into all 34 field types with examples" |
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -36,7 +36,7 @@ This roadmap outlines the complete development plan for the ObjectStack Protocol | |||||
|
|
||||||
| #### Data Protocol (ObjectQL) | ||||||
| - ✅ **Field Schema** (`src/data/field.zod.ts`) | ||||||
| - 25+ field types (text, number, lookup, formula, etc.) | ||||||
| - 35 field types (text, number, lookup, formula, slider, qrcode, etc.) | ||||||
|
||||||
| - 35 field types (text, number, lookup, formula, slider, qrcode, etc.) | |
| - 34 field types (text, number, lookup, formula, slider, qrcode, etc.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This prompt references “all 35 field types”, but the current
FieldTypeenum has 34 values. Please update the count to matchpackages/spec/src/data/field.zod.ts.