docs: 完整使用手冊 USER_MANUAL + README 中英文件導覽 + 規劃文件更新#100
Merged
Conversation
- docs/USER_MANUAL.md(新增,522 行):完整操作參考,補在 onboarding 0→1 之上。 涵蓋安裝與啟動(含 server.main:app vs main:app 常見雷)、設定(env 完整表 + 文字/圖片模型三階)、核心概念(工作空間 · Job 狀態機 mermaid · 審查關卡 · 成本)、 三大工作站逐一、YouTube 發布、CLI、疑難排解、REST API 速查、Job 狀態機、FAQ + 英文速查段。 - README.md(中英雙語):各加「文件 / Documentation」導覽段(手冊 / onboarding / deployment / contributing / roadmap / code review);快速開始補 server.main:app 啟動路徑警告(避免 uvicorn main:app 的 "Could not import module main")。 - ROADMAP.md / TODO.md:反映手冊已完成;截圖補齊列為待辦。 - docs/CHANGELOG.md:新增 2026-07-14 使用手冊條目。 Co-Authored-By: Claude Opus 4.8 <[email protected]> Claude-Session: https://claude.ai/code/session_017YfSHitPvSuuzVdVkhspWR
dofliu
marked this pull request as ready for review
July 24, 2026 10:06
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
做什麼 / What
新增完整使用手冊並更新中英雙語 README 與規劃文件。純文件。
docs/USER_MANUAL.md(新增,522 行)onboarding.md(0→1)之上。目錄 → 安裝與啟動(含server.main:appvsmain:app常見雷)→ 設定(env 完整表 + 文字/圖片模型三階)→ 核心概念(工作空間 · Job 狀態機 mermaid · 審查關卡 · 成本)→ 🎬🎨🌐 三大工作站逐一 → YouTube 發布 → CLI → 疑難排解 → REST API 速查 → Job 狀態機 → FAQ → 英文速查段README.md(中英雙語)server.main:app啟動路徑警告ROADMAP.md/TODO.mddocs/screenshots/四張截圖列為待辦docs/CHANGELOG.md為什麼 / Why
使用者要求製作詳細使用手冊、更新多語 README、更新規劃文件。手冊特別把「怎麼跑」寫清楚——
直接回應近期踩到的
uvicorn main:app→ "Could not import module 'main'"(正解是server.main:app,專案無根目錄main.py)。所有 model id 皆標「待 live 實測」。怎麼測 / How tested
.py/ server / schema →pytest不適用npm run build不適用##章節 / 1 個 Job 狀態機 mermaid;啟動指令與.env對照表對齊現行server/main.py與.env.example自我檢查 / Checklist
🤖 Generated with Claude Code
https://claude.ai/code/session_017YfSHitPvSuuzVdVkhspWR
Generated by Claude Code