开发文档
本目录面向维护 web-presentation 的开发者。先根据任务找到当前生效的模块边界、契约和操作指南;阶段计划、工作包与历史验收有独立入口,不作为现行实现的唯一依据。
从哪里开始
| 要做的事 | 入口 |
|---|---|
| 准备本地环境 | 本地开发指南、测试文档;服务通常已运行,先按 dev-start-test 探测 |
| 理解系统边界 | 架构总览、模块边界 |
| 修改 Backend | Backend 开发文档、API 契约索引 |
| 修改 Editor | Editor 开发文档、项目级设计规范 |
| 修改 Runtime 或页面 | Runtime 开发文档、Runtime 接入契约 |
| 修改 Renderer | Renderer 开发说明、远程渲染契约 |
| 修改 CLI 依赖的服务端接口 | External API v1、CLI 主仓边界 |
| 部署或发布 | 部署文档、发布检查清单 |
按功能查现行文档
| 功能 | 入口 |
|---|---|
| 放映配置、媒体和演讲者模式 | 放映接入、字段契约 |
| 音频资源、旁白与 cue | 音频接入、字段契约 |
| 页面源码、Runtime Kit 和预览 | Runtime 接入、预览源站与 artifact、Runtime Kit 契约 |
| 页面与组件校验 | 组件源码校验、页面可视化编辑契约 |
| 工作空间资源与三维模型 | 资源 API、Runtime 资源引用 |
专题工作与历史证据
维护规则
- 开发者需要据以修改代码的字段、边界和操作步骤,保留在模块文档或契约中;实施过程写入
projects/。 - 阶段完成时,将仍有效的结论写回现行文档,过程记录移至
docs/archive/,并更新所有仓内链接。 - 用户理解路径写入
docs/user/,部署事项写入docs/deployment/,测试选择和环境排障优先维护.agents/skills/dev-start-test/。 - MCP 整体不在当前交付范围;本仓只维护它依赖的 External API 契约和边界说明。