Skip to content

Commit 7b8576e

Browse files
Copilothotlong
andcommitted
Update documentation index pages with new guides and architecture
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent a4ba6fc commit 7b8576e

File tree

2 files changed

+50
-20
lines changed

2 files changed

+50
-20
lines changed

content/docs/index.cn.mdx

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
2-
title: 欢迎来到 ObjectStack
3-
description: 后 SaaS 时代的元数据驱动协议
2+
title: 欢迎使用 ObjectStack
3+
description: 后 SaaS 时代的元数据驱动协议
44
---
55

66
import { Book, Compass, FileText, Layers } from 'lucide-react';
77

8-
**ObjectStack** 不仅仅是一个框架;它是构建企业软件的**协议**
8+
**ObjectStack** 不仅仅是一个框架;它是一个用于构建企业软件的**协议**
99
它将*业务意图*(用 JSON/YAML 定义)与*技术执行*(由内核处理)解耦。
1010

1111
本文档是 ObjectStack 协议的权威参考。
@@ -17,13 +17,13 @@ import { Book, Compass, FileText, Layers } from 'lucide-react';
1717
icon={<FileText />}
1818
title="快速开始"
1919
href="/docs/guides/getting-started"
20-
description="5 分钟内构建你的第一个对象。学习 SDK 的基础知识"
20+
description="5 分钟内构建你的第一个对象。通过实际示例学习基础知识"
2121
/>
2222
<Card
2323
icon={<Compass />}
2424
title="概念"
2525
href="/docs/concepts/manifesto"
26-
description="理解意图优于实现」的理念和「本地优先」架构"
26+
description="理解"意图优于实现"和"本地优先"架构的理念。"
2727
/>
2828
<Card
2929
icon={<Layers />}
@@ -35,22 +35,37 @@ import { Book, Compass, FileText, Layers } from 'lucide-react';
3535
icon={<Book />}
3636
title="协议参考"
3737
href="/docs/references/data/core/Object"
38-
description="字典。每个 Schema、字段类型和配置选项的全面参考。"
38+
description="字典。每个模式、字段类型和配置选项的全面参考。"
3939
/>
4040
</Cards>
4141

42-
## "三位一体"架构
42+
## 快速链接
4343

44-
ObjectStack 建立在三个协同工作的支柱之上:
44+
### 基础指南
45+
- **[字段类型](/docs/guides/field-types)** - 30+ 种字段类型及示例(文本、数字、选择、查找、公式等)
46+
- **[视图配置](/docs/guides/view-configuration)** - 网格、看板、日历、甘特图和表单布局
47+
- **[工作流与验证](/docs/guides/workflows-validation)** - 业务规则和自动化
48+
- **[项目结构](/docs/guides/project-structure)** - 组织代码的最佳实践
4549

46-
| 支柱 | 协议 | 职责 |
50+
### 示例
51+
- **[CRM 示例](/examples/crm)** - 全功能应用,包含 6 个对象、工作流、视图、仪表板
52+
- **[Todo 示例](/examples/todo)** - 快速入门最小化示例
53+
54+
## "五位一体"架构
55+
56+
ObjectStack 建立在五个协同工作的核心模块之上:
57+
58+
| 模块 | 协议 | 职责 |
4759
| :--- | :--- | :--- |
48-
| **数据层** | **[ObjectQL](/docs/specifications/data/architecture)** | 定义数据的形状(`Object`)以及如何访问它(`AST`)。不依赖于 SQL/NoSQL。 |
60+
| **数据层** | **[ObjectQL](/docs/specifications/data/architecture)** | 定义数据的形状(`Object``Field`)以及如何访问它(`Query AST`)。与 SQL/NoSQL 无关。 |
61+
| **UI 层** | **[ObjectUI](/docs/specifications/ui/sdui-protocol)** | 投影层。将用户界面定义为抽象的 JSON 布局(视图、仪表板、操作)。 |
4962
| **控制层** | **[ObjectOS](/docs/specifications/server/kernel-architecture)** | 内核。处理身份、安全、同步和自动化。 |
50-
| **视图层** | **[ObjectUI](/docs/specifications/ui/sdui-protocol)** | 投影。将用户界面定义为抽象的 JSON 布局,实现服务器驱动 UI。 |
63+
| **AI 层** | **AI 协议** | AI 代理定义、工具、知识库和模型配置。 |
64+
| **API 层** | **API 协议** | 标准化的 REST/GraphQL 契约,带请求/响应封装。 |
5165

52-
## 这是为谁准备的?
66+
## 适用对象
5367

54-
* **平台架构师:** 想要构建可扩展的内部开发者平台(IDP)的人。
55-
* **协议实现者:** 想要为 ObjectQL 编写新驱动程序(例如,用于 FoundationDB)或为 ObjectUI 编写新渲染器(例如,用于 Flutter)的人。
56-
* **AI 代理开发者:** 需要一种确定性的、结构化的通用语言来让 AI 生成软件的人。
68+
* **平台架构师:** 想要构建可扩展的内部开发者平台(IDP)。
69+
* **协议实现者:** 想要为 ObjectQL 编写新的驱动(例如,用于 FoundationDB)或为 ObjectUI 编写新的渲染器(例如,用于 Flutter)。
70+
* **AI 代理开发者:** 需要一种确定性、结构化的通用语言来让 AI 生成软件。
71+
* **低代码构建者:** 想要一个强大的元数据驱动平台来快速应用开发。

content/docs/index.mdx

Lines changed: 20 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This documentation is the authoritative reference for the ObjectStack Protocol.
1717
icon={<FileText />}
1818
title="Getting Started"
1919
href="/docs/guides/getting-started"
20-
description="Build your first Object in 5 minutes. Learn the basics of the SDK."
20+
description="Build your first Object in 5 minutes. Learn the basics with practical examples."
2121
/>
2222
<Card
2323
icon={<Compass />}
@@ -39,18 +39,33 @@ This documentation is the authoritative reference for the ObjectStack Protocol.
3939
/>
4040
</Cards>
4141

42+
## Quick Links
43+
44+
### Essential Guides
45+
- **[Field Types](/docs/guides/field-types)** - 30+ field types with examples (text, number, select, lookup, formula, etc.)
46+
- **[View Configuration](/docs/guides/view-configuration)** - Grid, Kanban, Calendar, Gantt, and Form layouts
47+
- **[Workflows & Validation](/docs/guides/workflows-validation)** - Business rules and automation
48+
- **[Project Structure](/docs/guides/project-structure)** - Best practices for organizing your code
49+
50+
### Examples
51+
- **[CRM Example](/examples/crm)** - Full-featured application with 6 objects, workflows, views, dashboards
52+
- **[Todo Example](/examples/todo)** - Quick-start minimal example
53+
4254
## The "Trinity" Architecture
4355

44-
ObjectStack is built on three pillars that work in unison:
56+
ObjectStack is built on five core modules that work in unison:
4557

46-
| Pillar | Protocol | Responsibility |
58+
| Module | Protocol | Responsibility |
4759
| :--- | :--- | :--- |
48-
| **Data Layer** | **[ObjectQL](/docs/specifications/data/architecture)** | Defines the shape of data (`Object`) and how to access it (`AST`). Agnostic to SQL/NoSQL. |
60+
| **Data Layer** | **[ObjectQL](/docs/specifications/data/architecture)** | Defines the shape of data (`Object`, `Field`) and how to access it (`Query AST`). Agnostic to SQL/NoSQL. |
61+
| **UI Layer** | **[ObjectUI](/docs/specifications/ui/sdui-protocol)** | The Projection. Defines User Interfaces as abstract JSON layouts (Views, Dashboards, Actions). |
4962
| **Control Layer** | **[ObjectOS](/docs/specifications/server/kernel-architecture)** | The Kernel. Handles Identity, Security, Sync, and Automation. |
50-
| **View Layer** | **[ObjectUI](/docs/specifications/ui/sdui-protocol)** | The Projection. Defines the User Interface as abstract JSON layouts, enabling Server-Driven UI. |
63+
| **AI Layer** | **AI Protocol** | AI agent definitions, tools, knowledge bases, and model configurations. |
64+
| **API Layer** | **API Protocol** | Standardized REST/GraphQL contracts with request/response envelopes. |
5165

5266
## For whom is this?
5367

5468
* **Platform Architects:** Who want to build internal developer platforms (IDP) that scale.
5569
* **Protocol Implementers:** Who want to write a new Driver for ObjectQL (e.g., for FoundationDB) or a new Renderer for ObjectUI (e.g., for Flutter).
5670
* **AI Agent Developers:** Who need a deterministic, structured generic language for AI to generate software.
71+
* **Low-Code Builders:** Who want a powerful metadata-driven platform for rapid application development.

0 commit comments

Comments
 (0)