Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 6.55 KB

INDEX.md

File metadata and controls

91 lines (66 loc) · 6.55 KB

OpenTake 文档总目录

状态:canonical · 阶段:implementation-backed · 同步日期:2026-09-06 全项目文档的唯一索引入口(自动入口为根 AGENTS.md)。文档按「模块」组织成超链接树: 要开发某个模块,只需读该模块的 OVERVIEW.md(总览)+ INDEX.md(目录),目录里再链到该模块的各子系统文档与规格。


当前工作与状态

源码清单版本为 1.0.0-beta.6;公开版本与下载以 GitHub Releases 为准。源码、GUI 和平台安装包验收分别绑定实际证据。

🧭 如何使用本文档树

docs/
├── INDEX.md            ← 你在这里(总目录)
├── modules/            ← ★ 按 crate / 前端分的模块文档树
│   ├── INDEX.md        ← 模块总目录(含进程树支持模块)
│   └── <模块>/
│       ├── OVERVIEW.md ← 模块总览:职责 / 依赖 / 数据流 / 完成状态 / 对应上游
│       ├── INDEX.md    ← 模块目录:链到本模块所有子系统文档 + 规格 + 源码
│       └── *.md        ← 子系统文档(模块/子系统级,不逐函数)
├── architecture/       ← 跨切面:总体架构 / 路线图 / 移植图 / gap / bug / 编辑自动化 DOS
└── upstream-analysis/  ← 上游 Palmier Pro 拆解参考

典型路径:接到「改 X 模块」的活 → 打开 modules/INDEX.md 找到该模块 → 读它的 OVERVIEW.md 建立全貌 → 从它的 INDEX.md 进入需要的子系统文档 → 需要历史/规划背景时再回 architecture/。


📦 模块文档树 → modules/INDEX.md

层 模块 一句话 入口
领域 opentake-domain Timeline/Track/Clip/Keyframe 纯值语义(叶子 crate) 总览 · 目录
平台基础 opentake-process-tree 子进程树生命周期与取消 总览 · 目录
引擎 opentake-ops 纯引擎(Overwrite/Ripple/Snap) + EditCommand + 撤销栈 总览 · 目录
能力 opentake-project 工程持久化 / bundle / archive / 导出 总览 · 目录
能力 opentake-render wgpu 合成器 + 文本栅格化(预览/导出共享 RenderPlan) 总览 · 目录
能力 opentake-media FFmpeg 编解码 / 缩略图 / 波形 / 转写 / 语义搜索 总览 · 目录
能力 opentake-motion Lottie / web 动态图形 总览 · 目录
能力 opentake-agent MCP server(当前 44 个可发布工具:基础 + 生成 + 动效,能力门控后按能力发布) + 内置 Agent + Context Signal 总览 · 目录
能力 opentake-gen 生成式 AI 客户端(BYOK,无后端) 总览 · 目录
装配 opentake-core 会话管理 / DI / 事件总线(命令路由层) 总览 · 目录
装配 src-tauri Tauri 2 桌面壳 + Tauri 命令 总览 · 目录
前端 web React/TS 前端(只读镜像 + 版本号) 总览 · 目录

🏗️ 架构与规划 → architecture/INDEX.md

跨切面、不属单一模块的设计/规划/报告:总体架构、路线图、1:1 移植图与差距、剪映 gap、已知 Bug、编辑自动化 DOS。

长期背景计划:OpenTake 全功能与上游收敛计划。

已记录的 Preview 对齐切片:Preview tabs parity plan。

已记录的 Preview temporal parity 切片:Preview temporal remap parity plan。

已记录的媒体导入切片:File import dialog reliability plan。

已记录的媒体视图切片:Media view modes parity plan。

能力清单与证据:Capability ledger · Desktop functional matrix。

📐 上游拆解参考 → upstream-analysis/README.md

上游 Palmier Pro(Swift)的架构、Apple 框架可移植性、闭源云边界、MCP/Agent 工具拆解。


📄 仓库根级文档

文档 用途
README.md · README.zh-CN.md · README.ja.md 项目概览(多语言)
CLAUDE.md historical:早期交接快照,非当前任务入口
AGENTS.md AI Agent 协作指南
DECISIONS.md 技术选型决策(为何 Rust/Tauri/GPL-3.0)
CHANGELOG.md 变更历史
CONTRIBUTING.md 贡献指南
Specs Index 已批准/历史规格目录
Beta 发布与验证 · Motion Studio 验证 Beta 5 发布时范围与历史执行证据
Superpowers Recovery 历史恢复集成设计与计划入口(Beta 2 已收口)