Skip to content

Commit c7e0c51

Browse files
authored
Merge pull request #99 from objectstack-ai/copilot/update-docs-excluding-generated
2 parents bc393be + 2891135 commit c7e0c51

File tree

16 files changed

+112
-36
lines changed

16 files changed

+112
-36
lines changed

.github/prompts/data-protocol.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -345,7 +345,7 @@ export type Main = z.infer<typeof MainSchema>;
345345
## Interaction Commands
346346

347347
When user says:
348-
- **"Create Field Protocol"** → Implement complete `field.zod.ts` with all 23+ field types
348+
- **"Create Field Protocol"** → Implement complete `field.zod.ts` with all 35 field types
349349
- **"Create Object Protocol"** → Implement `object.zod.ts` with fields, capabilities, indexes
350350
- **"Create Validation Rules"** → Implement `validation.zod.ts` with rule engine
351351
- **"Create Permission System"** → Implement `permission.zod.ts` with CRUD + field-level security

.github/prompts/documentation-writer.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ a single property or column in an Object (table).
8080

8181
## Field Types
8282

83-
ObjectStack supports 23+ field types, organized into categories:
83+
ObjectStack supports 35 field types, organized into categories:
8484

8585
### Text Fields
8686
- **text**: Single-line text (max 255 characters)

ARCHITECTURE.md

Lines changed: 20 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,10 @@
6969
│ ├── workflow.zod.ts → State machine, transitions
7070
│ ├── flow.zod.ts → Visual flow automation
7171
│ ├── query.zod.ts → AST for queries (filter, sort, join)
72+
│ ├── filter.zod.ts → Query filter conditions
7273
│ ├── dataset.zod.ts → Virtual datasets
7374
│ ├── mapping.zod.ts → ETL transformations
74-
│ └── trigger.zod.ts → [MISSING] Trigger context
75+
│ └── trigger.zod.ts → Trigger context
7576
7677
├── UI Protocol (ObjectUI)
7778
│ ├── app.zod.ts → App structure, navigation tree
@@ -80,8 +81,8 @@
8081
│ ├── report.zod.ts → Report types, grouping
8182
│ ├── action.zod.ts → Button actions, navigation
8283
│ ├── page.zod.ts → FlexiPage regions, components
83-
│ ├── theme.zod.ts → [MISSING] Color, typography, spacing
84-
│ └── widget.zod.ts → [MISSING] Custom field components
84+
│ ├── theme.zod.ts → Color, typography, spacing
85+
│ └── widget.zod.ts → Custom field components
8586
8687
├── System Protocol (ObjectOS)
8788
│ ├── manifest.zod.ts → Package definition (objectstack.config.ts)
@@ -95,18 +96,24 @@
9596
│ ├── webhook.zod.ts → HTTP callbacks
9697
│ ├── translation.zod.ts → i18n definitions
9798
│ ├── discovery.zod.ts → Metadata introspection
98-
│ ├── plugin.zod.ts → [MISSING] Plugin lifecycle
99-
│ ├── driver.zod.ts → [MISSING] Database driver interface
100-
│ ├── marketplace.zod.ts → [PLANNED] App store metadata
101-
│ ├── tenant.zod.ts → [PLANNED] Multi-tenancy
102-
│ ├── events.zod.ts → [PLANNED] Event bus
103-
│ └── realtime.zod.ts → [PLANNED] WebSocket sync
99+
│ ├── plugin.zod.ts → Plugin lifecycle
100+
│ ├── driver.zod.ts → Database driver interface
101+
│ ├── tenant.zod.ts → Multi-tenancy
102+
│ ├── events.zod.ts → Event bus
103+
│ ├── realtime.zod.ts → WebSocket sync
104+
│ ├── organization.zod.ts → Organization management
105+
│ ├── audit.zod.ts → Audit logging
106+
│ └── job.zod.ts → Background jobs
104107
105108
├── AI Protocol
106-
│ ├── agent.zod.ts → AI agent configuration
107-
│ ├── model.zod.ts → [PLANNED] LLM registry
108-
│ ├── rag.zod.ts → [PLANNED] RAG pipeline
109-
│ └── nlq.zod.ts → [PLANNED] Natural language query
109+
│ ├── agent.zod.ts → AI agent configuration
110+
│ ├── model-registry.zod.ts → LLM registry
111+
│ ├── rag-pipeline.zod.ts → RAG pipeline
112+
│ ├── nlq.zod.ts → Natural language query
113+
│ ├── conversation.zod.ts → Conversation management
114+
│ ├── cost.zod.ts → AI cost tracking
115+
│ ├── predictive.zod.ts → Predictive analytics
116+
│ └── workflow-automation.zod.ts → AI workflow automation
110117
111118
└── API Protocol
112119
└── contract.zod.ts → Request/response envelopes

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The ObjectStack Protocol (`@objectstack/spec`) is divided into five core modules
5959

6060
### 1. Data Protocol (ObjectQL)
6161
Defines the "Shape of Data" and business logic.
62-
- **Schema:** Objects, Fields (23+ types including text, number, select, lookup, formula, autonumber, etc.)
62+
- **Schema:** Objects, Fields (35 types including text, number, select, lookup, formula, autonumber, slider, qrcode, etc.)
6363
- **Logic:** Workflows, Triggers, Validation Rules, Formulas
6464
- **Security:** Permissions, Sharing Rules
6565
- **Query:** Abstract Syntax Tree (AST) for unified data access across drivers
@@ -73,22 +73,28 @@ Defines the "Shape of Interaction" for rendering interfaces.
7373
- **Analytics:** Reports (Tabular, Summary, Matrix), Dashboards with widgets
7474
- **Actions:** Script, URL, Modal, Flow-triggered actions
7575
- **Theming:** Color palettes, typography, breakpoints, animations
76+
- **Widgets:** Custom field components
7677

7778
### 3. System Protocol (ObjectOS)
7879
Defines the "Runtime Environment" and platform capabilities.
7980
- **Manifest:** Application packaging (`objectstack.config.ts`)
80-
- **Identity:** Authentication, Roles, Territories, Licenses
81+
- **Identity:** Authentication, Roles, Territories, Licenses, Organizations
8182
- **Integration:** Webhooks, API contracts, ETL Mappings
8283
- **Datasource:** Driver definitions for SQL, NoSQL, SaaS connectors
8384
- **Discovery:** Plugin discovery and loading mechanisms
8485
- **I18n:** Translation and internationalization support
86+
- **Platform:** Events, Real-time sync, Audit logging, Background jobs, Multi-tenancy
8587

8688
### 4. AI Protocol
8789
Defines AI agent integration capabilities.
8890
- **Agent:** AI agent definitions and configurations
89-
- **Tools:** AI tool integrations
90-
- **Knowledge:** Knowledge base structures
91-
- **Models:** AI model configurations
91+
- **Model Registry:** LLM registry and selection
92+
- **RAG Pipeline:** Retrieval-augmented generation
93+
- **NLQ:** Natural language query processing
94+
- **Conversation:** Conversation management and memory
95+
- **Cost Tracking:** AI cost tracking and budget management
96+
- **Predictive:** Predictive analytics models
97+
- **Workflow Automation:** AI-powered workflow automation
9298

9399
### 5. API Protocol
94100
Defines standardized API contracts.

RELEASE_NOTES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ This is the first public release of the ObjectStack ecosystem, providing:
5252

5353
### Core Capabilities
5454
- **Data Protocol (ObjectQL)**: Complete schema definitions for Objects and Fields
55-
- 23+ field types (text, number, select, lookup, formula, autonumber, etc.)
55+
- 35 field types (text, number, select, lookup, formula, autonumber, slider, qrcode, etc.)
5656
- Validation rules, workflows, and triggers
5757
- Permission system and sharing rules
5858
- Abstract query language for unified data access

content/docs/guides/field-types.cn.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: ObjectStack 所有字段类型的完整指南,包含示例和配
66

77
# 字段类型参考
88

9-
ObjectStack 支持 **30+ 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。
9+
ObjectStack 支持 **35 种字段类型**,涵盖文本、数字、日期、选择、关联、媒体、计算和增强类型。本指南为每种类型提供实用示例。
1010

1111
## 核心文本字段
1212

content/docs/guides/field-types.mdx

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Complete guide to all ObjectStack field types with examples and con
66

77
# Field Types Reference
88

9-
ObjectStack supports **30+ field types** covering text, numbers, dates, selections, relationships, media, calculations, and enhanced types. This guide provides practical examples for each type.
9+
ObjectStack supports **35 field types** covering text, numbers, dates, selections, relationships, media, calculations, and enhanced types. This guide provides practical examples for each type.
1010

1111
## Core Text Fields
1212

@@ -524,6 +524,8 @@ coordinates: Field.location({
524524
})
525525
```
526526

527+
> **Note:** `geolocation` is an alternative name for the `location` field type. Both refer to the same GPS coordinate field.
528+
527529
**Data Structure:**
528530
```typescript
529531
{
@@ -638,6 +640,66 @@ customer_signature: Field.signature({
638640

639641
---
640642

643+
### Slider
644+
Numeric slider for visual value selection.
645+
646+
```typescript
647+
volume: Field.slider({
648+
label: 'Volume Level',
649+
min: 0,
650+
max: 100,
651+
step: 1,
652+
defaultValue: 50,
653+
})
654+
655+
price_range: Field.slider({
656+
label: 'Price Range',
657+
min: 0,
658+
max: 10000,
659+
step: 100,
660+
marks: { 0: '$0', 5000: '$5K', 10000: '$10K' },
661+
})
662+
```
663+
664+
**Configuration:**
665+
- `min` - Minimum value
666+
- `max` - Maximum value
667+
- `step` - Increment step size
668+
- `marks` - Optional labeled markers on the slider
669+
670+
---
671+
672+
### QR Code
673+
QR code / Barcode field for scanning and generation.
674+
675+
```typescript
676+
product_barcode: Field.qrcode({
677+
label: 'Product Barcode',
678+
format: 'qr', // 'qr', 'barcode', 'ean13', 'code128'
679+
readonly: false,
680+
})
681+
682+
ticket_code: Field.qrcode({
683+
label: 'Event Ticket',
684+
format: 'qr',
685+
autoGenerate: true, // Generate on record creation
686+
})
687+
```
688+
689+
**Supported Formats:**
690+
- `qr` - QR Code (2D matrix barcode, best for URLs, text, and complex data)
691+
- `barcode` - Standard 1D barcode (linear format for simple numeric/text data)
692+
- `ean13` - EAN-13 barcode (13-digit product identifier, commonly used in retail)
693+
- `code128` - Code 128 barcode (high-density 1D format supporting full ASCII character set)
694+
695+
**Use Cases:**
696+
- Product SKUs and inventory management (ean13, code128)
697+
- Event tickets and access control (qr)
698+
- Document tracking and verification (qr)
699+
- Shipping labels and logistics (code128)
700+
701+
---
702+
641703
## Field Configuration Reference
642704

643705
### Common Properties

content/docs/guides/getting-started.cn.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ views: {
276276
现在你有了有效的元数据,你可以:
277277

278278
1. **探索示例**:查看 [CRM 示例](https://github.com/objectstack-ai/spec/tree/main/examples/crm) 了解完整功能实现
279-
2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 30+ 种字段类型
279+
2. **学习字段类型**:参见 [字段类型指南](/docs/guides/field-types) 了解所有 35 种字段类型
280280
3. **构建 UI**:使用 ObjectStack 运行时的元数据来生成界面
281281
4. **部署**:推送到 ObjectStack 内核用于生产环境
282282

content/docs/guides/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,7 +276,7 @@ views: {
276276
Now that you have valid metadata, you can:
277277

278278
1. **Explore Examples**: Check out the [CRM Example](https://github.com/objectstack-ai/spec/tree/main/examples/crm) for a full-featured implementation
279-
2. **Learn Field Types**: See the [Field Types Guide](/docs/guides/field-types) for all 30+ field types
279+
2. **Learn Field Types**: See the [Field Types Guide](/docs/guides/field-types) for all 35 field types
280280
3. **Build UI**: Use the metadata with ObjectStack runtime to generate interfaces
281281
4. **Deploy**: Push to an ObjectStack kernel for production use
282282

content/docs/index.cn.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ import { Book, Compass, FileText, Layers } from 'lucide-react';
4242
## 快速链接
4343

4444
### 基础指南
45-
- **[字段类型](/docs/guides/field-types)** - 30+ 种字段类型及示例(文本、数字、选择、查找、公式等)
45+
- **[字段类型](/docs/guides/field-types)** - 35 种字段类型及示例(文本、数字、选择、查找、公式等)
4646
- **[视图配置](/docs/guides/view-configuration)** - 网格、看板、日历、甘特图和表单布局
4747
- **[工作流与验证](/docs/guides/workflows-validation)** - 业务规则和自动化
4848
- **[项目结构](/docs/guides/project-structure)** - 组织代码的最佳实践

0 commit comments

Comments
 (0)