跳到主要内容

开发者文档总览

面向接手 ReelChair（产品名 Termina）代码库的工程师。本板块把仓库内的 docs/ 目录与 CLAUDE.md 做面向读者的重组呈现；权威源仍是仓库里的 CLAUDE.md + docs/，本站做导览与快速上手。

接手必读三条铁律
  1. 从 dev 出发：统一基于 dev 分支开发，不要基于 main（已事实废弃，落后 dev 近 200 个 commit）。详见分支与部署。
  2. 命名分裂：Sequence === Episode、Scene === Frame，是同一实体的两套命名——User-facing 用 Sequence/Scene，Data layer 用 Episode/Frame。不要试图统一。详见命名约定。
  3. 前端 API-only：Firestore 是私有数据库，Fastify / Cloud Functions 才是公共 API。前端不得直接读写 Firestore。详见架构总览。

快速导航​

  • 架构总览 —— 仓库结构、API-only 约束、领域语义链、Agent 运行时
  • 命名约定 —— Sequence/Scene vs Episode/Frame 完整规范
  • 分支与部署 —— dev/pro 流程与 CI

本地起步​

pnpm install
pnpm dev:local      # demo 模式（切勿直接跑 pnpm dev，已被刻意设为报错）

后端本地监听 3001，前端 Vite 监听 5173。更多模式（dev:dev / dev:emulator）见 CLAUDE.md §2。

📝 本板块将从现有 docs/（400+ 篇）中分批迁移架构细节、REST API、Agent skills、AI Gateway 等主题，详见仓库内 website/帮助文档计划.md。