Skip to content

Commit dec0512

Browse files
Copilothotlong
andcommitted
docs: Add Chinese documentation for website protocol and update README
- Added Chinese meta files for all website protocol sections - Updated references meta files to include website protocol - Updated README to document the 6 core protocol modules - Added Website Protocol as module #3 with preview release date March 2026 Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent f71a7c8 commit dec0512

3 files changed

Lines changed: 25 additions & 4 deletions

File tree

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ The official documentation is built with Fumadocs and Next.js.
5555

5656
## 🛠️ The Protocol Architecture
5757

58-
The ObjectStack Protocol (`@objectstack/spec`) is divided into five core modules:
58+
The ObjectStack Protocol (`@objectstack/spec`) is divided into six core modules:
5959

6060
### 1. Data Protocol (ObjectQL)
6161
Defines the "Shape of Data" and business logic.
@@ -75,7 +75,16 @@ Defines the "Shape of Interaction" for rendering interfaces.
7575
- **Theming:** Color palettes, typography, breakpoints, animations
7676
- **Widgets:** Custom field components
7777

78-
### 3. System Protocol (ObjectOS)
78+
### 3. Website Protocol
79+
Defines the "Shape of Marketing Websites" for landing pages and official sites.
80+
- **Landing Pages:** Hero sections, features, testimonials, pricing, CTAs, FAQ
81+
- **Navigation:** Website menus, dropdowns, mega menus, footers
82+
- **SEO:** Meta tags, Open Graph, Twitter Cards, structured data
83+
- **Analytics:** Google Analytics, GTM, Facebook Pixel integration
84+
- **Theming:** Brand colors, typography, dark mode
85+
- **Preview Release:** March 2026
86+
87+
### 4. System Protocol (ObjectOS)
7988
Defines the "Runtime Environment" and platform capabilities.
8089
- **Manifest:** Application packaging (`objectstack.config.ts`)
8190
- **Identity:** Authentication, Roles, Territories, Licenses, Organizations
@@ -85,7 +94,7 @@ Defines the "Runtime Environment" and platform capabilities.
8594
- **I18n:** Translation and internationalization support
8695
- **Platform:** Events, Real-time sync, Audit logging, Background jobs, Multi-tenancy
8796

88-
### 4. AI Protocol
97+
### 5. AI Protocol
8998
Defines AI agent integration capabilities.
9099
- **Agent:** AI agent definitions and configurations
91100
- **Model Registry:** LLM registry and selection
@@ -96,7 +105,7 @@ Defines AI agent integration capabilities.
96105
- **Predictive:** Predictive analytics models
97106
- **Workflow Automation:** AI-powered workflow automation
98107

99-
### 5. API Protocol
108+
### 6. API Protocol
100109
Defines standardized API contracts.
101110
- **Envelopes:** Response structures (BaseResponse, ListRecordResponse, etc.)
102111
- **Requests:** Request payloads (CreateRequest, UpdateRequest, BulkRequest, etc.)

content/docs/references/meta.cn.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"pages": [
44
"data",
55
"ui",
6+
"website",
67
"auth",
78
"automation",
89
"system",
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"title": "网站表达协议",
3+
"root": true,
4+
"pages": [
5+
"content-block",
6+
"landing-page",
7+
"navigation",
8+
"seo",
9+
"website"
10+
]
11+
}

0 commit comments

Comments
 (0)