mirror of
https://github.com/nexu-io/open-design.git
synced 2026-05-31 19:04:39 +07:00
docs: add Traditional Chinese QUICKSTART and fix Chinese doc links (#753)
- Add QUICKSTART.zh-TW.md (Traditional Chinese) based on the latest QUICKSTART.zh-CN.md, with regional terminology for zh-TW locale. - Update the language nav in all 6 existing QUICKSTART translations to include the 繁體中文 entry. - Fix CONTRIBUTING.zh-CN.md: point QUICKSTART references to the Chinese translation (QUICKSTART.zh-CN.md) instead of the English original, closing the follow-up promised in PR #578.
This commit is contained in:
parent
b03a504da6
commit
5dbe7795aa
9 changed files with 242 additions and 12 deletions
|
|
@ -16,7 +16,7 @@
|
|||
| 让 OD 说一种新品牌的视觉语言 | 一套 **Design System** | [`design-systems/<brand>/DESIGN.md`](design-systems/) | 一个 Markdown 文件 |
|
||||
| 接入一个新的 coding-agent CLI | 一个 **Agent adapter** | [`apps/daemon/src/agents.ts`](apps/daemon/src/agents.ts) | 一个数组里 ~10 行 |
|
||||
| 加功能、修 bug、从 [`open-codesign`][ocod] 移植一个 UX 模式 | 代码 | `apps/web/src/`、`apps/daemon/` | 普通 PR |
|
||||
| 改文档、补法语 / 德语 / 中文翻译、修错别字 | 文档 | `README.md`、`README.fr.md`、`README.de.md`、`README.zh-CN.md`、`docs/`、`QUICKSTART.md` | 一个 PR |
|
||||
| 改文档、补法语 / 德语 / 中文翻译、修错别字 | 文档 | `README.md`、`README.fr.md`、`README.de.md`、`README.zh-CN.md`、`docs/`、`QUICKSTART.zh-CN.md` | 一个 PR |
|
||||
|
||||
不确定自己想做的属于哪一桶?[先开 issue / discussion](https://github.com/nexu-io/open-design/issues/new),我们告诉你该改哪个面。
|
||||
|
||||
|
|
@ -24,7 +24,7 @@
|
|||
|
||||
## 本地起跑
|
||||
|
||||
完整的一页式 setup 在 [`QUICKSTART.md`](QUICKSTART.md)。给贡献者的 TL;DR:
|
||||
完整的一页式 setup 在 [`QUICKSTART.zh-CN.md`](QUICKSTART.zh-CN.md)。给贡献者的 TL;DR:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/nexu-io/open-design.git
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Schnellstart
|
||||
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <b>Deutsch</b> · <a href="QUICKSTART.fr.md">Français</a> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <a href="QUICKSTART.zh-CN.md">简体中文</a></p>
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <b>Deutsch</b> · <a href="QUICKSTART.fr.md">Français</a> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <a href="QUICKSTART.zh-CN.md">简体中文</a> · <a href="QUICKSTART.zh-TW.md">繁體中文</a></p>
|
||||
|
||||
Führen Sie das vollständige Produkt lokal aus.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Quickstart
|
||||
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <a href="QUICKSTART.de.md">Deutsch</a> · <b>Français</b> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <a href="QUICKSTART.zh-CN.md">简体中文</a></p>
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <a href="QUICKSTART.de.md">Deutsch</a> · <b>Français</b> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <a href="QUICKSTART.zh-CN.md">简体中文</a> · <a href="QUICKSTART.zh-TW.md">繁體中文</a></p>
|
||||
|
||||
Exécutez le produit complet localement.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# クイックスタート
|
||||
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <a href="QUICKSTART.de.md">Deutsch</a> · <a href="QUICKSTART.fr.md">Français</a> · <b>日本語</b> · <a href="QUICKSTART.zh-CN.md">简体中文</a></p>
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <a href="QUICKSTART.de.md">Deutsch</a> · <a href="QUICKSTART.fr.md">Français</a> · <b>日本語</b> · <a href="QUICKSTART.zh-CN.md">简体中文</a> · <a href="QUICKSTART.zh-TW.md">繁體中文</a></p>
|
||||
|
||||
製品全体をローカルで実行します。
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Quickstart
|
||||
|
||||
<p align="center"><b>English</b> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <a href="QUICKSTART.de.md">Deutsch</a> · <a href="QUICKSTART.fr.md">Français</a> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <a href="QUICKSTART.zh-CN.md">简体中文</a></p>
|
||||
<p align="center"><b>English</b> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <a href="QUICKSTART.de.md">Deutsch</a> · <a href="QUICKSTART.fr.md">Français</a> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <a href="QUICKSTART.zh-CN.md">简体中文</a> · <a href="QUICKSTART.zh-TW.md">繁體中文</a></p>
|
||||
|
||||
Run the full product locally.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Início rápido
|
||||
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <b>Português (Brasil)</b> · <a href="QUICKSTART.de.md">Deutsch</a> · <a href="QUICKSTART.fr.md">Français</a> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <a href="QUICKSTART.zh-CN.md">简体中文</a></p>
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <b>Português (Brasil)</b> · <a href="QUICKSTART.de.md">Deutsch</a> · <a href="QUICKSTART.fr.md">Français</a> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <a href="QUICKSTART.zh-CN.md">简体中文</a> · <a href="QUICKSTART.zh-TW.md">繁體中文</a></p>
|
||||
|
||||
Rode o produto inteiro localmente.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# 快速上手 · Quickstart
|
||||
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <a href="QUICKSTART.de.md">Deutsch</a> · <a href="QUICKSTART.fr.md">Français</a> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <b>简体中文</b></p>
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <a href="QUICKSTART.de.md">Deutsch</a> · <a href="QUICKSTART.fr.md">Français</a> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <b>简体中文</b> · <a href="QUICKSTART.zh-TW.md">繁體中文</a></p>
|
||||
|
||||
在本地运行完整的产品。
|
||||
|
||||
|
|
|
|||
230
QUICKSTART.zh-TW.md
Normal file
230
QUICKSTART.zh-TW.md
Normal file
|
|
@ -0,0 +1,230 @@
|
|||
# 快速上手 · Quickstart
|
||||
|
||||
<p align="center"><a href="QUICKSTART.md">English</a> · <a href="QUICKSTART.pt-BR.md">Português (Brasil)</a> · <a href="QUICKSTART.de.md">Deutsch</a> · <a href="QUICKSTART.fr.md">Français</a> · <a href="QUICKSTART.ja-JP.md">日本語</a> · <a href="QUICKSTART.zh-CN.md">简体中文</a> · <b>繁體中文</b></p>
|
||||
|
||||
在本地執行完整的產品。
|
||||
|
||||
## 環境要求
|
||||
|
||||
- **Node.js:** `~24`(Node 24.x)。程式碼庫在 `package.json#engines` 中強制要求該版本。
|
||||
- **pnpm:** `10.33.x`。程式碼庫透過 `packageManager` 固定為 `pnpm@10.33.2`;若使用 Corepack,該固定版本將被自動選中。
|
||||
- **作業系統:** 主要支援 macOS、Linux、WSL2。Windows 原生環境大部分流程也可執行,但 WSL2 是更穩定的基準。
|
||||
- **可選的本地 agent CLI:** Claude Code、Codex、Devin for Terminal、Gemini CLI、OpenCode、Cursor Agent、Qwen、Qoder CLI、GitHub Copilot CLI 等。即使未安裝任何 CLI,也可在 Settings 中切換至 BYOK API 模式。
|
||||
|
||||
`nvm` / `fnm` 為可選的便捷工具,並非專案必要依賴。如需使用,請在執行 pnpm 之前安裝並切換到 Node 24:
|
||||
|
||||
```bash
|
||||
# nvm
|
||||
nvm install 24
|
||||
nvm use 24
|
||||
|
||||
# fnm
|
||||
fnm install 24
|
||||
fnm use 24
|
||||
```
|
||||
|
||||
隨後啟用 Corepack,由程式碼庫自動選擇 pnpm:
|
||||
|
||||
```bash
|
||||
corepack enable
|
||||
corepack pnpm --version # 應輸出 10.33.2
|
||||
```
|
||||
|
||||
## 一條指令(dev 模式)
|
||||
|
||||
```bash
|
||||
corepack enable
|
||||
pnpm install
|
||||
pnpm tools-dev run web # 在前景啟動 daemon + web
|
||||
# 開啟 tools-dev 輸出的 web URL
|
||||
```
|
||||
|
||||
如需將 desktop shell 和所有受管 sidecar 置於背景執行:
|
||||
|
||||
```bash
|
||||
pnpm tools-dev # 在背景啟動 daemon + web + desktop
|
||||
```
|
||||
|
||||
首次載入時,應用程式會掃描已安裝的 code-agent CLI(Claude Code / Codex / Devin for Terminal / Gemini / OpenCode / Cursor Agent / Qwen / Qoder CLI),並自動選擇其中之一;預設使用 `web-prototype` skill 與 `Neutral Modern` design system。輸入 prompt,點擊 **Send**。Agent 將以串流方式輸出至左側面板;`<artifact>` 標籤會被解析,HTML 在右側即時渲染。執行完成後,點擊 **Save to disk**,artifact 將被寫入磁碟 `./.od/artifacts/<timestamp>-<slug>/index.html`。
|
||||
|
||||
**Design system** 下拉選單內建 **129 套 design system** —— 包含 2 套手工編寫的 starter(Neutral Modern、Warm Editorial)、70 套打包的產品級系統,以及來自 [`awesome-design-skills`](https://github.com/bergside/awesome-design-skills) 的 57 個 design skill。選擇任意一套,所有原型都會應用該品牌的視覺風格。
|
||||
|
||||
**Skill** 下拉選單按 mode 分組(Prototype / Deck / Template / Design system),每個 mode 的預設 skill 帶有 `· default` 後綴。內建 skill 如下:
|
||||
|
||||
- **Prototype** —— `web-prototype`(通用)、`saas-landing`、`dashboard`、`pricing-page`、`docs-page`、`blog-post`、`mobile-app`。
|
||||
- **Deck / PPT** —— `simple-deck`(單檔案橫向翻頁)與 `magazine-web-ppt`(`guizang-ppt` 捆綁包,來自 [`op7418/guizang-ppt-skill`](https://github.com/op7418/guizang-ppt-skill) —— deck mode 的預設 skill,自帶 assets/template 與 4 份 reference)。附帶 sidefile 的 skill 會自動添加一段 "Skill root (absolute)" frontmatter,使 agent 能夠基於真實的磁碟路徑解析 `assets/template.html` 與 `references/*.md`,而非在自身 CWD 中猜測。
|
||||
|
||||
將 skill 與 design system 組合使用,僅需一句 prompt 即可產出符合版面配置規範、並採用所選視覺語言的原型或 deck。
|
||||
|
||||
## 其他腳本
|
||||
|
||||
```bash
|
||||
pnpm tools-dev # 在背景啟動 daemon + web + desktop
|
||||
pnpm tools-dev start web # 在背景啟動 daemon + web
|
||||
pnpm tools-dev run web # 在前景啟動 daemon + web(e2e / dev server)
|
||||
pnpm tools-dev restart # 重新啟動 daemon + web + desktop
|
||||
pnpm tools-dev restart --daemon-port 7457 --web-port 5175
|
||||
pnpm tools-dev status # 檢查受管理的 runtime 狀態
|
||||
pnpm tools-dev logs # 查看 daemon / web / desktop 日誌
|
||||
pnpm tools-dev check # 查看 status + 最近日誌 + 常見診斷
|
||||
pnpm tools-dev stop # 停止受管理的 runtime
|
||||
pnpm --filter @open-design/daemon build # 建置 apps/daemon/dist/cli.js,供 `od` 使用
|
||||
pnpm --filter @open-design/web build # 在需要時建置 web package
|
||||
pnpm typecheck # 對整個 workspace 執行 typecheck
|
||||
```
|
||||
|
||||
`pnpm tools-dev` 是本地生命週期的唯一入口。請勿再使用已被移除的頂層歷史別名(`pnpm dev`、`pnpm dev:all`、`pnpm daemon`、`pnpm preview`、`pnpm start`)。
|
||||
|
||||
本地開發時,`tools-dev` 會先啟動 daemon,並將其連接埠傳遞給 `apps/web`,`apps/web/next.config.ts` 會將 `/api/*`、`/artifacts/*`、`/frames/*` 重寫到該 daemon 連接埠,從而使 App Router 能夠與相鄰的 Express 行程通訊,無需設定 CORS。
|
||||
|
||||
## 媒體生成 / agent dispatcher 問題排除
|
||||
|
||||
Image、video、audio、HyperFrames 等 skill 在透過 daemon 啟動 agent 時,會注入環境變數以呼叫本地 `od` CLI:
|
||||
|
||||
- `OD_BIN` —— `apps/daemon/dist/cli.js` 的絕對路徑。
|
||||
- `OD_DAEMON_URL` —— 目前執行的 daemon URL。
|
||||
- `OD_PROJECT_ID` —— 目前啟用的專案 id。
|
||||
- `OD_PROJECT_DIR` —— 目前啟用專案的檔案目錄。
|
||||
|
||||
若媒體生成發生錯誤 `OD_BIN: parameter not set`、提示找不到 `apps/daemon/dist/cli.js`、或出現 `failed to reach daemon at http://127.0.0.1:0`,請重新建置 daemon CLI 並重新啟動受管理的 runtime:
|
||||
|
||||
```bash
|
||||
pnpm --filter @open-design/daemon build
|
||||
pnpm tools-dev restart --daemon-port 7457 --web-port 5175
|
||||
ls -la apps/daemon/dist/cli.js
|
||||
curl -s http://127.0.0.1:7457/api/health
|
||||
```
|
||||
|
||||
隨後,在 Open Design 應用程式中**重新開啟**該專案,請勿重複使用先前 terminal 中的 agent 會話。由 daemon 啟動的 agent 應當能夠看到類似如下的值:
|
||||
|
||||
```bash
|
||||
echo "OD_BIN=$OD_BIN"
|
||||
echo "OD_PROJECT_ID=$OD_PROJECT_ID"
|
||||
echo "OD_PROJECT_DIR=$OD_PROJECT_DIR"
|
||||
echo "OD_DAEMON_URL=$OD_DAEMON_URL"
|
||||
ls -la "$OD_BIN"
|
||||
```
|
||||
|
||||
`OD_DAEMON_URL` 必須為真實的 daemon 連接埠,例如 `http://127.0.0.1:7457`,而非 `http://127.0.0.1:0`。`:0` 僅是內部用於「自動選擇可用連接埠」的啟動佔位值,不應洩漏到 agent 會話中。
|
||||
|
||||
僅執行 daemon 的生產模式下,daemon 會自行在 `http://localhost:7456` 提供 Next.js 的靜態匯出產物,不經過反向代理。
|
||||
|
||||
若在 daemon 前部署了 nginx,請關閉 SSE 路由的 buffering 與壓縮。常見問題:瀏覽器控制台在 80-90 秒後顯示錯誤 `net::ERR_INCOMPLETE_CHUNKED_ENCODING 200 (OK)`——原因是 nginx 的 `gzip on` 會緩衝分塊的 SSE 回應,即使 daemon 已傳送 `X-Accel-Buffering: no`。
|
||||
|
||||
```nginx
|
||||
location /api/ {
|
||||
proxy_pass http://127.0.0.1:7456;
|
||||
|
||||
proxy_buffering off;
|
||||
gzip off;
|
||||
|
||||
proxy_read_timeout 86400s;
|
||||
proxy_send_timeout 86400s;
|
||||
proxy_http_version 1.1;
|
||||
proxy_set_header Connection "";
|
||||
|
||||
proxy_set_header Host $host;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
}
|
||||
```
|
||||
|
||||
## 兩種執行模式
|
||||
|
||||
| 模式 | picker 中的值 | 請求流轉路徑 |
|
||||
|---|---|---|
|
||||
| **Local CLI**(daemon 偵測到 agent 時的預設模式) | "Local CLI" | 前端 → daemon `/api/chat` → `spawn(<agent>, ...)` → stdout → SSE → artifact 解析器 → 預覽 |
|
||||
| **API 模式**(fallback / 未安裝 CLI) | "Anthropic API" / "OpenAI API" / "Azure OpenAI" / "Google Gemini" | 前端 → daemon `/api/proxy/{provider}/stream` → provider SSE 歸一化為 `delta/end/error` → artifact 解析器 → 預覽 |
|
||||
|
||||
兩種模式都會傳入**同一個** `<artifact>` 解析器與**同一個**沙箱 iframe。區別僅在於傳輸層和 system prompt 的投遞方式(本地 CLI 沒有獨立的 system 通道,因此組合好的 prompt 會被摺疊進 user message)。
|
||||
|
||||
## Prompt 組合
|
||||
|
||||
每次 send 時,應用程式都會從三層建構 system prompt,然後傳送至 provider:
|
||||
|
||||
```
|
||||
BASE_SYSTEM_PROMPT (輸出契約:用 <artifact> 包裹,不使用 code fence)
|
||||
+ 目前啟用的 design system 正文 (DESIGN.md —— 色板 / 字型 / 版面配置)
|
||||
+ 目前啟用的 skill 正文 (SKILL.md —— 工作流與輸出規則)
|
||||
```
|
||||
|
||||
在頂部 bar 切換 skill 或 design system 後,下一次 send 將使用新的組合。正文會按 session 在記憶體中快取,每次切換僅需從 daemon 獲取一次。
|
||||
|
||||
## 檔案結構
|
||||
|
||||
```
|
||||
open-design/
|
||||
├── apps/
|
||||
│ ├── daemon/ # Node/Express —— 啟動本地 agent + 提供 API
|
||||
│ │ └── src/
|
||||
│ │ ├── cli.ts # `od` bin 入口
|
||||
│ │ ├── server.ts # /api/* + 靜態資源
|
||||
│ │ ├── agents.ts # 掃描 PATH 中的 claude/codex/devin/gemini/opencode/cursor-agent/qwen/qoder/copilot
|
||||
│ │ ├── skills.ts # SKILL.md loader(frontmatter 解析器)
|
||||
│ │ └── design-systems.ts # DESIGN.md loader
|
||||
│ │ ├── sidecar/ # tools-dev daemon sidecar 包裝層
|
||||
│ │ └── tests/ # daemon 包的測試
|
||||
│ ├── web/ # Next.js 16 App Router + React 客戶端
|
||||
│ ├── app/ # App Router 入口
|
||||
│ ├── src/ # React + TypeScript 客戶端 / runtime 模組
|
||||
│ │ ├── App.tsx # 調度 mode / skill / DS picker + send
|
||||
│ │ ├── providers/ # daemon + BYOK API transport
|
||||
│ │ ├── prompts/ # system、discovery、directions、deck framework
|
||||
│ │ ├── artifacts/ # 串流 <artifact> 解析器 + manifest
|
||||
│ │ ├── runtime/ # iframe srcdoc、markdown、export 輔助函數
|
||||
│ │ └── state/ # localStorage + 由 daemon 持久化的專案狀態
|
||||
│ ├── sidecar/ # tools-dev web sidecar 包裝層
|
||||
│ └── next.config.ts # tools-dev rewrites + 生產環境 apps/web/out 匯出配置
|
||||
│ └── desktop/ # Electron runtime,由 tools-dev 啟動 / 檢查
|
||||
├── packages/
|
||||
│ ├── contracts/ # 共享的 web/daemon 應用程式契約
|
||||
│ ├── sidecar-proto/ # Open Design sidecar 協定契約
|
||||
│ ├── sidecar/ # 通用 sidecar runtime 原語
|
||||
│ └── platform/ # 通用 process/platform 原語
|
||||
├── tools/dev/ # `pnpm tools-dev` 生命週期與 inspect CLI
|
||||
├── e2e/ # Playwright UI + 外部整合 / Vitest 測試場
|
||||
├── skills/ # SKILL.md —— 任何 Claude Code skill 程式碼庫均可直接放入
|
||||
│ ├── web-prototype/ # 通用單螢幕原型(prototype mode 的預設)
|
||||
│ ├── saas-landing/ # 行銷頁(hero / features / pricing / CTA)
|
||||
│ ├── dashboard/ # 後台 / 分析 dashboard
|
||||
│ ├── pricing-page/ # 獨立的定價 + 對比頁
|
||||
│ ├── docs-page/ # 三欄文件版面配置
|
||||
│ ├── blog-post/ # 長文編輯風格
|
||||
│ ├── mobile-app/ # 手機邊框單螢幕
|
||||
│ ├── simple-deck/ # 最小化橫向翻頁 deck
|
||||
│ └── guizang-ppt/ # magazine-web-ppt —— deck/PPT 預設捆綁包
|
||||
│ ├── SKILL.md
|
||||
│ ├── assets/template.html
|
||||
│ └── references/{themes,layouts,components,checklist}.md
|
||||
├── design-systems/ # DESIGN.md —— 9 段式 schema(awesome-claude-design)
|
||||
│ ├── default/ # Neutral Modern(starter)
|
||||
│ ├── warm-editorial/ # Warm Editorial(starter)
|
||||
│ ├── README.md # 目錄概覽
|
||||
│ └── …129 systems # 2 套 starter · 70 套產品系統 · 57 個 design skill
|
||||
├── scripts/sync-design-systems.ts # 從上游 getdesign tarball 重新匯入
|
||||
├── docs/ # 產品願景 + spec
|
||||
├── .od/ # runtime 資料(gitignore,自動建立)
|
||||
│ ├── app.sqlite # 專案 / 對話 / 訊息 / 分頁
|
||||
│ ├── artifacts/ # 一次性 "Save to disk" 產物
|
||||
│ └── projects/<id>/ # 按專案劃分的工作目錄 + agent cwd
|
||||
├── pnpm-workspace.yaml # apps/* + packages/* + tools/* + e2e
|
||||
└── package.json # 頂層品質腳本 + `od` bin
|
||||
```
|
||||
|
||||
## 排障
|
||||
|
||||
- **"no agents found on PATH"** —— 安裝以下 CLI 之一:`claude`、`codex`、`devin`、`gemini`、`opencode`、`cursor-agent`、`qwen`、`qodercli`、`copilot`。或者在 Settings 中切換至 API mode,填入 provider key。
|
||||
- **daemon 在 /api/chat 上返回 500** —— 查看 daemon 終端機的 stderr 尾部;通常是 CLI 拒絕了傳入的參數。不同 CLI 的 argv 結構各異;如需調整,請參閱 `apps/daemon/src/agents.ts` 中的 `buildArgs`。
|
||||
- **媒體生成發生錯誤,`OD_BIN` 缺失、或 daemon URL 為 `:0`** —— 執行上述媒體 dispatcher 問題排除步驟。請勿重複使用既有的 CLI 會話;從 Open Design 應用程式中重新開啟專案,daemon 才會注入新的 `OD_*` 變數。
|
||||
- **Codex 載入的插件上下文過多** —— 使用 `OD_CODEX_DISABLE_PLUGINS=1 pnpm tools-dev` 啟動 Open Design,daemon 啟動 Codex 時會傳入 `--disable plugins`。
|
||||
- **artifact 始終不渲染** —— 模型輸出了文字但未使用 `<artifact>` 包裹。請確認 system prompt 已正確傳遞(查看 daemon 日誌),然後考慮更換能力更強的模型或更嚴格的 skill。
|
||||
|
||||
## 回到產品願景
|
||||
|
||||
本 Quickstart 對應 [`docs/`](docs/) 中 spec 的可執行起點;spec 描述了其演進方向(見 [`docs/roadmap.md`](docs/roadmap.md))。要點如下:
|
||||
|
||||
- `docs/architecture.md` 描述了目前這套已交付的 stack:前端為 Next.js 16 App Router,後端為本地 daemon;`apps/web/next.config.ts` 在 dev 模式下進行 rewrite,使瀏覽器始終透過同一套 `/api` 入口通訊。
|
||||
- `docs/skills-protocol.md` 描述了完整的 `od:` frontmatter(型別化輸入、slider、能力 gating)。目前 MVP 僅讀取 `name` / `description` / `triggers` / `od.mode` / `od.design_system.requires` —— 如需支援更多欄位,請擴展 `apps/daemon/src/skills.ts`。
|
||||
- `docs/agent-adapters.md` 展望了更豐富的 dispatch(能力偵測、串流 tool call)。我們的 `apps/daemon/src/agents.ts` 是最小化的 dispatcher —— 剛好足夠驗證鏈路通暢。
|
||||
- `docs/modes.md` 列出了四種 mode:prototype / deck / template / design-system。前兩種已提供對應的 skill;picker 已按 `mode` 過濾。
|
||||
|
|
@ -23,7 +23,7 @@
|
|||
<a href="#design-system"><img alt="Design systems" src="https://img.shields.io/badge/design%20systems-72-orange?style=flat-square" /></a>
|
||||
<a href="#內建-skills"><img alt="Skills" src="https://img.shields.io/badge/skills-31-teal?style=flat-square" /></a>
|
||||
<a href="https://discord.gg/qhbcCH8Am4"><img alt="Discord" src="https://img.shields.io/badge/discord-加入-5865F2?style=flat-square&logo=discord&logoColor=white" /></a>
|
||||
<a href="QUICKSTART.md"><img alt="Quickstart" src="https://img.shields.io/badge/quickstart-3%20commands-green?style=flat-square" /></a>
|
||||
<a href="QUICKSTART.zh-TW.md"><img alt="Quickstart" src="https://img.shields.io/badge/quickstart-3%20commands-green?style=flat-square" /></a>
|
||||
</p>
|
||||
|
||||
<p align="center"><a href="README.md">English</a> · <a href="README.es.md">Español</a> · <a href="README.pt-BR.md">Português (Brasil)</a> · <a href="README.de.md">Deutsch</a> · <a href="README.fr.md">Français</a> · <a href="README.zh-CN.md">简体中文</a> · <b>繁體中文</b> · <a href="README.ko.md">한국어</a> · <a href="README.ja-JP.md">日本語</a> · <a href="README.ar.md">العربية</a> · <a href="README.ru.md">Русский</a> · <a href="README.uk.md">Українська</a> · <a href="README.tr.md">Türkçe</a></p>
|
||||
|
|
@ -319,7 +319,7 @@ pnpm tools-dev run web
|
|||
|
||||
環境要求:Node `~24`,pnpm `10.33.x`。`nvm` / `fnm` 只是可選輔助工具,不是專案必需步驟;如果使用它們,先執行 `nvm install 24 && nvm use 24` 或 `fnm install 24 && fnm use 24`,再執行 `pnpm install`。
|
||||
|
||||
桌面版/後臺啟動、固定埠重啟,以及 media 生成派發器檢查(`OD_BIN`、`OD_DAEMON_URL`、`apps/daemon/dist/cli.js`)見 [`QUICKSTART.md`](QUICKSTART.md)。
|
||||
桌面版/後臺啟動、固定埠重啟,以及 media 生成派發器檢查(`OD_BIN`、`OD_DAEMON_URL`、`apps/daemon/dist/cli.js`)見 [`QUICKSTART.zh-TW.md`](QUICKSTART.zh-TW.md)。
|
||||
|
||||
第一次載入會:
|
||||
|
||||
|
|
@ -347,7 +347,7 @@ Daemon 在倉庫根下維護一個隱藏目錄,裡面所有內容都已 gitign
|
|||
| 完全清空,從零再來 | `pnpm tools-dev stop`,再 `rm -rf .od`,然後重新 `pnpm tools-dev run web` |
|
||||
| 換到別的位置 | 暫不支援 —— 路徑是相對倉庫根寫死的 |
|
||||
|
||||
完整檔案地圖、指令碼、排錯 → [`QUICKSTART.md`](QUICKSTART.md)。
|
||||
完整檔案地圖、指令碼、排錯 → [`QUICKSTART.zh-TW.md`](QUICKSTART.zh-TW.md)。
|
||||
|
||||
## 跑專案
|
||||
|
||||
|
|
@ -403,7 +403,7 @@ pnpm tools-dev inspect desktop screenshot --path /tmp/open-design.png
|
|||
| `pnpm tools-dev restart` | 全部停掉再重啟 |
|
||||
| `pnpm tools-dev check` | 狀態 + 最近 log + 常見診斷 |
|
||||
|
||||
固定埠重啟、背景啟動、完整排錯 → [`QUICKSTART.md`](QUICKSTART.md)。
|
||||
固定埠重啟、背景啟動、完整排錯 → [`QUICKSTART.zh-TW.md`](QUICKSTART.zh-TW.md)。
|
||||
|
||||
## 從 coding agent 端使用 Open Design
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue