Skip to content

Commit 0696ff9

Browse files
qingqing-uxplwhdclaude
authored
Update components (#2988)
* add iconfont * editor iconfont * your commit message * Add font icon Delete some unnecessary variables Apply icon to page * chore(spx): update community and stage editor pen pages * Correcting incorrect icon commands in the system; Adding a font mapping table. * docs(ui): streamline team workflow documentation - Optimize team-workflow.md with industry-standard structure - Simplify pencil design draft reproduction workflow - Update pr-template.md with clearer format and examples - Remove redundant pr-checklist.md (covered by design-review-checklist) - Remove pr_review.md (basic git tutorial, not project-specific) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs(ui): rename and optimize ai-design-workflow - Rename 'pencil design draft reproduction workflow.md' to 'ai-design-workflow.md' - Simplify title and structure - Use tables for input/output clarity - Add component library link Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(ui): rename Chinese image files to English Renamed files in ui/images/: - 用户头像.png → avatar.png - 项目运行.png → project-run.png - 项目全屏.png → project-fullscreen.png - 地图背景.png → map-bg.png - builder使用.png → builder-usage.png Updated all references in: - ui/components/spx/builder-component.lib.pen - ui/pages/spx/*.pen - ui/pages/spx/demos/*.html Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(ui): standardize image filenames to kebab-case Renamed files in ui/images/ to follow repository convention: - Notification-2.gif → notification-2.gif - Sprite-review.png → sprite-review.png - Union.png → union.png - XBuilder_icon1.jpg → xbuilder-icon1.jpg - XBuilder_Icons_02.ttf → xbuilder-icons-02.ttf - XBuilder_icon1.ttf → xbuilder-icon1.ttf - ai canvas logo.png → ai-canvas-logo.png - navbar bg.png → navbar-bg.png - tutorial entry-filled.png → tutorial-entry-filled.png - user bg.png → user-bg.png - pubilsh-colorful.png → publish-colorful.png (also fixed typo) Updated all references in components and pages. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * refactor(ui): unify custom font naming to kebab-case Standardized font naming for consistency: - File: xbuilder-icon1.ttf → xbuilder-icons-01.ttf - File: xbuilder-icon1.jpg → xbuilder-icons-01.jpg - name: XBuilder_Icons_01 → xbuilder-icons-01 - name: XBuilder_Icons_02 → xbuilder-icons-02 - fontFamily references updated accordingly This ensures font logical names match physical filenames, reducing confusion and maintenance errors. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * 修改文档、调整目录结构 * [UI] Update: Rename and reorganize spx design files ### Background Improve file naming consistency and organization in spx design directory. ### Changes - Rename editor files with editor- prefix (map-editor → editor-map, etc.) - Keep community .pen files in ui/pages/spx/ with community- prefix - Simplify internal node names (remove redundant prefixes like stage-editor-, sprite-editor-) - Move demo HTML files to _sources/ subdirectory ### Scope - ui/pages/spx/editor-map.pen - ui/pages/spx/editor-sprite.pen - ui/pages/spx/editor-stage.pen - ui/pages/spx/community-*.pen - ui/pages/spx/tutorial.pen - ui/pages/spx/demos/ ### Design System Impact - [ ] Yes - [x] No Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * [UI] Update: Compress xbuilder-icons-01 image ### Background Reduce image file size for better loading performance. ### Changes - Compressed xbuilder-icons-01.jpg from 1886KB to 474KB (~75% reduction) ### Scope - ui/images/xbuilder-icons-01.jpg ### Design System Impact - [ ] Yes - [x] No Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add icon font * Add xbuilder-icons-02 image * Component Specification Naming * XBuilder logo component adjustment * Adjust component name --------- Co-authored-by: plwhd <pl298567@gmail.com> Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 2f38473 commit 0696ff9

File tree

91 files changed

+29756
-131966
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

91 files changed

+29756
-131966
lines changed

ui/README.md

Lines changed: 42 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,62 @@
1-
# UI 设计工程系统
1+
# UI Design System
22

3-
本仓库是一个「设计工程系统」,而不仅仅是「存放设计稿」的地方。
3+
This repository stores design assets for the Builder project.
44

5-
我们通过引入 **设计左移(Shift Left in Design** 的理念,将设计纳入工程主流程,使设计资产具备:可版本化、可审查、可追溯、可复用、可自动校验。
5+
This is a "Design Engineering System", not just a place to store design files.
66

7-
目标是提升团队的 **端到端试错能力**,让问题在设计阶段暴露,而不是在开发或上线后修复。
7+
By adopting the **Shift Left in Design** philosophy, we integrate design into the engineering workflow, making design assets versionable, reviewable, traceable, reusable, and automatically verifiable.
88

9-
## 仓库结构
9+
The goal is to enhance the team's **end-to-end iteration capability**, exposing issues during the design phase rather than fixing them after development or release.
10+
11+
## Directory Structure
1012

1113
```text
12-
docs/ # 规范文档
13-
system/ # 设计系统
14-
templates/ # 设计模板
15-
features/ # 业务设计文件(给开发看)
16-
archive/ # 废弃设计
14+
ui/
15+
├── components/ # Reusable design components
16+
│ └── spx/
17+
│ └── builder-component.lib.pen
18+
├── pages/ # Page designs
19+
│ └── spx/
20+
│ ├── community-*.pen
21+
│ ├── *-editor.pen
22+
│ └── tutorial.pen
23+
├── docs/ # Documentation
24+
├── images/ # Image assets
25+
└── archive/ # Deprecated designs
1726
```
1827

19-
## 目录说明
20-
21-
`docs/` 包含:
22-
23-
- 设计原则
24-
- 命名规范
25-
- pr-checklist
26-
- pr-template
27-
- 工作流说明
28-
29-
`system/` 包含:
28+
## Quick Start
3029

31-
- Design Tokens
30+
### For Designers
3231

33-
`templates/` 包含:
32+
1. Component library: [`components/spx/builder-component.lib.pen`](components/spx/builder-component.lib.pen)
33+
2. Create page designs in `pages/spx/`
34+
3. Submit changes via PR
3435

35-
- 页面结构模板
36-
- 交互模板
36+
### For Developers
3737

38-
`features/`
38+
Page designs are in `pages/spx/`. Each `.pen` file corresponds to a feature or page.
3939

40-
每个功能一个目录,必须包含:
40+
## Documentation
4141

42-
- 设计文件(Pencil 文件 .json .pen)
43-
- 设计说明
44-
- 可交互的 Demo html
42+
| Document | Description |
43+
| -------- | ----------- |
44+
| [Team Workflow](docs/team-workflow.md) | Collaboration process |
45+
| [AI Design Workflow](docs/ai-design-workflow.md) | Using AI to reproduce Figma designs |
46+
| [PR Template](docs/pr-template.md) | PR title and description format |
47+
| [Design Review Checklist](docs/design-review-checklist.md) | Pre-submission checklist |
4548

46-
`archive/`
47-
48-
废弃或历史版本设计。
49-
50-
## 工作流及原则
49+
## Workflow
5150

5251
```text
53-
需求 → 设计 → Design PR → Review → 合并
54-
↓ 开发实现 → Code PR
52+
Issue → Design (.pen)
53+
54+
├─ Simple → AI generates code → PR → Dev review & merge
55+
56+
└─ Complex → Design commit → Dev implements → Code PR
5557
```
5658

57-
- 所有设计变更必须通过 PR
58-
- 所有代码 PR 必须关联对应设计
59-
- 未合并的设计,不允许开发实现
60-
61-
如果你要修改设计,请先阅读:
59+
## File Naming
6260

63-
- 📖 [docs/team-workflow.md](docs/team-workflow.md)
64-
- 📖 [docs/design-review-checklist.md](docs/design-review-checklist.md)
65-
- 📖 [docs/pr-template.md](docs/pr-template.md)
61+
- Use kebab-case: `community-home.pen`
62+
- Pages: `{feature-name}.pen`

ui/README.zh.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# UI 设计系统
2+
3+
本仓库存放 Builder 项目的设计资源。
4+
5+
这是一个「设计工程系统」,而不仅仅是「存放设计稿」的地方。
6+
7+
我们通过引入 **设计左移(Shift Left in Design)** 的理念,将设计纳入工程主流程,使设计资产具备可版本化、可审查、可追溯、可复用、可自动校验的特性。
8+
9+
目标是提升团队的 **端到端试错能力**,让问题在设计阶段暴露,而不是在开发或上线后修复。
10+
11+
## 目录结构
12+
13+
```text
14+
ui/
15+
├── components/ # 可复用设计组件
16+
│ └── spx/
17+
│ └── builder-component.lib.pen
18+
├── pages/ # 页面设计
19+
│ └── spx/
20+
│ ├── community-*.pen
21+
│ ├── *-editor.pen
22+
│ └── tutorial.pen
23+
├── docs/ # 文档
24+
├── images/ # 图片资源
25+
└── archive/ # 已废弃的设计
26+
```
27+
28+
## 快速开始
29+
30+
### 设计师
31+
32+
1. 组件库:[`components/spx/builder-component.lib.pen`](components/spx/builder-component.lib.pen)
33+
2.`pages/spx/` 中创建页面设计
34+
3. 通过 PR 提交更改
35+
36+
### 开发者
37+
38+
页面设计位于 `pages/spx/`。每个 `.pen` 文件对应一个功能或页面。
39+
40+
## 文档
41+
42+
| 文档 | 说明 |
43+
| ---- | ---- |
44+
| [团队工作流程](docs/team-workflow.md) | 协作流程 |
45+
| [AI 设计工作流程](docs/ai-design-workflow.md) | 使用 AI 还原 Figma 设计 |
46+
| [PR 模板](docs/pr-template.md) | PR 标题和描述格式 |
47+
| [设计审查清单](docs/design-review-checklist.md) | 提交前检查清单 |
48+
49+
## 工作流程
50+
51+
```text
52+
Issue → 设计 (.pen)
53+
54+
├─ 简单需求 → AI 生成代码 → PR → 开发审查并合并
55+
56+
└─ 复杂需求 → 设计提交 → 开发实现 → 代码 PR
57+
```
58+
59+
## 文件命名
60+
61+
- 使用 kebab-case:`community-home.pen`
62+
- 页面:`{feature-name}.pen`

0 commit comments

Comments
 (0)