lix-2026
b4c8bcb647
清理历史 Electron、Graphify、沙箱和截图等仓库跟踪残留，补充 CodeGraph 与 Convex active deploy source 协作说明。 新增 tree-first 下一阶段设计稿和 2026-05-20 清理总结，记录本地工作区、路径身份和 Zed/Lapce/VSCode 参考收口方向。 扩展 Rust Web 本地文件夹、DocumentBuffer、mindmap 资源、tree runtime 和页面聚合链路，并补充 task455 local-folder mindmap clean smoke。 验证：git diff --check 通过；pnpm store status --store-dir .pnpm-store 通过；npm ls --depth=0 --json 通过；find -L node_modules 未发现断链。cargo test -p mnote-web 当前 418 passed / 35 failed。
148 lines
16 KiB
Markdown
148 lines
16 KiB
Markdown
# 仓库协作指南（AGENTS）
|
||
|
||
## 当前主线
|
||
|
||
- 当前长期方向以 `tree-first graph kernel` 为准，不以 `BlockNote-first` 或 `Mindmap-first` 为准。
|
||
- 当前产品形态固定为：`VSCode 简化版工作区 + tiptap 的 Markdown 前端编辑器 + Hermes/Reasonix agent + simplemindmap/office 插件 + Wolai 主题 Web 壳 + 鉴权控制面`。
|
||
- 本地文件夹是早期产品默认数据真相；本地 `.md` 是页面正文真相。`Convex` / 服务端降级为 auth、membership、share grants、sync state、AI policy、cloud source、compat 和 sync replica 控制面，不再作为新增能力的默认正文、附件或 AI 会话全文主存储。
|
||
- `Rust kernel` 持有树、子树、边、projection、query、command 的语义主导权；新增树规则不要继续散落到前端、Next route 或临时 compat 层。
|
||
- `mnote-web` 是当前 Rust Web 承载层，负责 transport、projection 分发、兼容切流；`compat` 与 `fixture` 只用于过渡和测试，不应继续承载长期业务语义。`3000` 是唯一前端公开入口；`3104` 已退役为仅显式 debug/internal 使用的边界。`/tree`、`/document-debug` 等 debug 壳默认关闭，仅在显式 debug/runtime 验证时启用。
|
||
- 前端主路径应消费稳定 projection，不应在 UI 层重新拼出第二份对象真相。
|
||
- Next `documents/page` 读取主链已优先消费 Rust `mnote.page_aggregate.v1` 快照；TS `page-aggregate-builder` 仅保留为历史 adapter / test helper，不再作为 runtime fallback，也不再把“前端手工拼 `meta + content`”描述为当前主路径。
|
||
- `3000` 当前主壳已接入 Rust Web WebSocket push 主链（`/api/realtime/ws`）+ SSE fallback（`/api/tree/events`）的 snapshot / delta / resync consumer，并已有 browser smoke 验证（2026-05-17 WS 迁移 `57ec8322`）；后续收口重点是统一 live cache 与减少补偿链，而不是把它描述成“还没接 live stream”。
|
||
- 文档页默认主编辑器已切到页面内 `leptos-tiptap` island；`BlockNote` 已退出文档页默认主路径，只保留为历史参考实现 / 对照材料。
|
||
- Page Aggregate 当前已输出 `blockDocument / blockProjectionVersion / projectionSource`（`projectionSource=documents.content`），标题/正文/页面设置写入后 smoke 已通过（`task110`、`task-page-aggregate-body-sync-smoke`、`task-page-aggregate-options-sync-smoke`）；页面/块 AI 最小工具链已通过 Rust Hermes tools 读取和写入块投影；但这仍是从 `documents.content` / local markdown content 投影出来的过渡态，不是 EditorBlockDocument 原生落库完成态。客户端 `PageAggregateClientState` reducer 仍在，页面域单一真源未完全闭环。
|
||
- 当前最优先的架构收口不是继续扩编辑器 UI，而是 local-first 工作区产品化、`Page Aggregate` 单一真源收口、`tree command cutover` 收尾、`tree realtime event stream` live cache 统一（WS push 主链 2026-05-17 上线，SSE 降级为 fallback）。AI 侧普通 Markdown 编辑主路径已收口为“当前文件引用 + selection + allowed roots + agent 原生 patch/diff + watcher 同步”；`mnote.doc.fetch`、`mnote.doc.markdown_edit`、`mnote.doc.apply_block_ops`、`mnote.block.*` 只作为 cloud / remote agent / compat fallback 或复杂结构辅助；`review session`/流式 apply 属于 Phase C（设计冻结，当前不实施），不扩新 AI 功能，不把粗粒度 `mnote.page.save` 当成精确块编辑主入口。
|
||
|
||
## 组件定位
|
||
|
||
- `leptos-tiptap` island 是当前文档页默认主编辑区 runtime，但不是系统事实源。
|
||
- `BlockNote` 是历史参考实现 / 对照材料，不再是运行时系统组件、默认回退编辑器或系统事实源。
|
||
- `Mindmap` 是 `tree-first graph` 的一种视图和编辑挂件，不是对象真相层。
|
||
- `OnlyOffice` 是独立页面型编辑器，不直接嵌入 `BlockNote` 画布；正文中通常通过附件块跳转进入。
|
||
- `page-ai/block-edit-workflow` route 只保留为兼容门面或非 local source 的快捷路径，不作为 local-first 普通 Markdown 编辑默认主路径；local-first 下优先给 Hermes / Reasonix 授权文件引用并让 agent 使用自身文件编辑能力。`mnote.doc.markdown_edit` 是 cloud / remote agent / compat fallback；`mnote.block.*` 保留为结构性辅助。
|
||
- 树域三层模型：`Resource Tree`（kernel 对象组织真源）→ `File Tree`（主组织投影，`{title}.md` 为页面正文行）→ `Page Tree`（导航投影，不持有结构真相）。涉及资源归属优先走 Rust kernel 的 `KernelObjectIdentity` / `KernelProjectionResourceKind`。
|
||
|
||
## 目录优先级
|
||
|
||
- `/mnt/Data1T/mnote/recycle/wolai-frontend/src/`
|
||
wolai-frontend（Next.js React 前端）已退役移入 recycle，不作为当前实现依据。页面、编辑器、Sidebar、树视图、阅读态、交互壳默认先看 Rust mnote-web SSR（`rust/crates/mnote-web/src/`）。
|
||
- `/mnt/Data1T/mnote/recycle/wolai-frontend/convex/`
|
||
已随 wolai-frontend 移入 recycle，不允许作为当前 Convex deploy fallback。当前 active Convex functions 部署源在仓库根 `convex/`（现阶段为 ACP / Hermes runtime session store：`schema.ts` + `aiSessions.ts`）；`infra/convex/` 只负责自托管 Convex 基础设施。
|
||
- `/mnt/Data1T/mnote/rust/crates/core-protocol/`
|
||
Kernel 类型、projection 协议、树/图核心术语先看这里。
|
||
- `/mnt/Data1T/mnote/rust/crates/bridge-runtime/`
|
||
Kernel query / command / subtree / graph traversal 入口先看这里。
|
||
- `/mnt/Data1T/mnote/rust/crates/mnote-web/`
|
||
Rust Web route、transport、compat、tree shell、projection 分发先看这里。
|
||
- `/mnt/Data1T/mnote/wolai-backend/app/`
|
||
辅助后端、异步处理、接口配合先看这里。
|
||
- `/mnt/Data1T/mnote/infra/convex/`
|
||
Convex 自托管部署与本地基础设施先看这里。
|
||
- `/mnt/Data1T/mnote/src/components/onlyoffice/`
|
||
只在处理 OnlyOffice 静态资源、插件或兼容问题时进入。
|
||
- `/mnt/Data1T/mnote/recycle/`
|
||
默认视为历史回收区，不作为当前实现依据，除非任务明确要求。
|
||
|
||
## 架构约束
|
||
|
||
- 涉及树、页面结构、文件树、Sidebar、阅读投影、搜索投影、引用边语义时，优先判断是否应落到 Rust kernel，而不是直接改前端拼装逻辑。
|
||
- 前端可以做展示、交互和局部适配，但不要新增第二套树真相、排序真相或 projection 契约。
|
||
- `mnote-web` 的 `compat route` 可以承接过渡流量，但不要把新的长期业务逻辑继续堆进 compat。
|
||
- 涉及文档页标题、页面设置、正文保存、页头与树一致性时，优先判断是否应收口到 `Page Aggregate`，不要继续在页面壳或 island 外侧拼第二份页面真相。
|
||
- 涉及页面新建、重命名、移动、归档、恢复、嵌入时，优先沿 `tree.*` 正式命名推进；`documents.*` 只视为兼容层，不应继续扩写为长期命令面。
|
||
- 涉及 local-first AI 普通 Markdown 编辑时，优先沿“授权文件引用 + `AiAccessScope` + allowed roots + agent 原生 patch/diff + 文件版本冲突模型 + watcher 同步”推进；涉及 cloud / remote agent / 复杂结构辅助时，才沿 `mnote.doc.*` / `mnote.block.*` Hermes tools 与 Rust `EditorCommand` 推进。`mnote.page.save` 只作为页面级兜底写入工具。
|
||
- 涉及资源归属（哪个页面拥有哪个 mindmap/附件）、object identity 和资源生命周期时，优先沿 Resource Tree → File Tree projection → `tree.resource.*` 命令面推进；`tree.*` 是正式命令面，`documents.*` 只视为兼容层。
|
||
- 页面 AI 编辑当前 local-first 主路径为：页面定位到真实 `.md` 文件，MNote 计算 `AiAccessScope` / allowed roots / selection，Hermes 或 Reasonix 在白名单目录内用自身 patch/diff/文件编辑能力写入，MNote 通过 watcher / refresh 同步 tiptap。`mnote.doc.markdown_edit` 只作为 cloud / remote agent / compat fallback；`mnote.block.*` 保留为结构性辅助（拖拽排序等）。两层操作模型已获 CLI Main（Lark Doc）参考实现验证。流式 apply + suggest/review（参考 BlockNote AI）作为 Phase C 设计冻结，当前不实施。
|
||
- 需要架构判断时，优先参考：
|
||
- `/mnt/Data1T/mnote/ARCHITECTURE.md`
|
||
- `/mnt/Data1T/mnote/design/01-05-current-priority-overview.md`
|
||
- `/mnt/Data1T/mnote/design/01-tree-first-graph-kernel/process/1-tree-first-graph-kernel-v1.md`
|
||
- `/mnt/Data1T/mnote/design/02-convex-rust-long-term-architecture/done/2-2-local-first-workspace-convex-control-plane-v1.md`
|
||
- `/mnt/Data1T/mnote/design/05-editor-mainline/process/5-5-page-aggregate-single-truth-alignment-v1.md`
|
||
- `/mnt/Data1T/mnote/design/05-editor-mainline/process/5-6-page-aggregate-alignment-checklist-v1.md`
|
||
- `/mnt/Data1T/mnote/design/07-ai/process/7-10-page-block-ai-tooling-execution-checklist-v1.md`
|
||
- `/mnt/Data1T/mnote/design/04-tree-domain/done/4-6-tree-command-protocol-cutover-stage2-v1.md`
|
||
- `/mnt/Data1T/mnote/design/03-rust-web/process/3-3-rust-web-tree-realtime-event-stream-v1.md`
|
||
- `design/03-rust-web/done/3-14-rust-web-tree-realtime-ws-push-v1.md`
|
||
- `/mnt/Data1T/mnote/design/10-review/process/08-kernel-architecture-next-priority-review-and-checklist.md`
|
||
- `/mnt/Data1T/mnote/design/10-review/done/09-page-ai-fast-block-edit-runtime-review.md`
|
||
- `/mnt/Data1T/mnote/design/10-review/done/10-current-mnote-ai-runtime-review-v1.md`
|
||
- `/mnt/Data1T/mnote/design/10-review/done/11-current-full-architecture-review-v1.md`
|
||
- `/mnt/Data1T/mnote/design/07-ai/process/7-14-online-local-ai-markdown-editing-convergence-v1.md`
|
||
- `/mnt/Data1T/mnote/design/04-tree-domain/done/4-24-resource-tree-filetree-pagetree-source-contract-checklist-v1.md`
|
||
- `/mnt/Data1T/mnote/design/05-editor-mainline/done/5-12-main-editor-object-tab-resource-alignment-checklist-v1.md`
|
||
|
||
## 设计稿目录规则
|
||
|
||
- `design/01-*` 到 `design/07-*` 主线大类统一按 `process/` 与 `done/` 分层。
|
||
- 主线设计稿在推进中时放到对应大类的 `process/`。
|
||
- 主线设计稿在当前真实代码中已完成后，必须移动到对应大类的 `done/`。
|
||
- 已被后续实现或更新稿明确覆盖、但又不属于 `done` 的旧主线稿，必须移动到 `design/old/` 并标记为 `[recycle]`，不要继续占用活跃 `process/`。
|
||
- `design/old/` 下的历史废弃稿也统一按 `process/` 与 `done/` 分层，但标题继续标记 `[recycle]`。
|
||
- `design/90-reference/` 只放参考资料，不参与 `process/done` 状态迁移。
|
||
|
||
## Bugs 目录规则
|
||
|
||
- `bugs/` 默认镜像 `design/` 的主线分类方式，按对应大类放置缺陷。
|
||
- 每个大类继续按 `process/` 与 `done/` 分层：
|
||
- `process/`：缺陷已确认存在，仍在修复或验证中
|
||
- `done/`：缺陷已修复，且已有真实代码与验证证据
|
||
- 新确认的缺陷先放 `process/`；修复完成后必须移动到同类目的 `done/`，不要在两个目录同时保留同一条缺陷。
|
||
- 缺陷归类以真正 owner 和长期主线为准，不以表面症状命名：
|
||
- `sidebar/topbar/breadcrumb/文档页壳/Wolai 体验对齐` 优先归到 `05-editor-mainline/`
|
||
- `projection/row model/selection/focus/keyboard/DnD/tree command` 优先归到 `04-tree-domain/`
|
||
|
||
## 协作边界
|
||
|
||
- 仅修改与当前任务直接相关的文件。
|
||
- 不要擅自恢复、覆盖、删除用户已有改动。
|
||
- 若发现与当前任务无关的脏改动，保持不动；若怀疑会影响当前任务，先确认再处理。
|
||
- 若当前问题只是 UI 表现异常，先确认是否是实验性 tree shell、compat 路径、轮询或 fallback 混入首屏主链，而不是直接怀疑 Convex 本身。
|
||
|
||
## CodeGraph 使用
|
||
|
||
- 当前项目已配置 CodeGraph MCP；结构性代码问题优先使用 `codegraph_*` 工具：`codegraph_search` 查符号，`codegraph_callers` / `codegraph_callees` 查调用关系，`codegraph_impact` 做影响分析，`codegraph_context` / `codegraph_explore` 获取聚焦上下文，`codegraph_files` 查看索引文件结构，`codegraph_status` 检查索引健康。
|
||
- CodeGraph 是当前开发态代码图主工具；代码改动后运行 `codegraph sync .`，大范围重构、排除规则变化或索引异常时运行 `codegraph index . --force`。只有查找字面文本、日志字符串、注释原文，或已经明确目标文件时，才优先用 `rg` / 直接读文件。
|
||
|
||
## 常用命令
|
||
|
||
- 根目录热启动：`npm run desktop:hot`
|
||
- 前端开发（已迁移至 Rust SSR）：`npm run desktop:hot` 启动后直接访问 `http://localhost:3000`
|
||
- 前端检查：Rust 测试 `cargo test -p mnote-web`（Rust SSR 与 API），旧 React 前端已移入 recycle
|
||
- 后端开发：`cd /mnt/Data1T/mnote/wolai-backend && uvicorn app.main:app --reload --port 8000`
|
||
- Convex 自托管：参考 `/mnt/Data1T/mnote/infra/convex/README.md`
|
||
|
||
## 默认测试账号
|
||
|
||
- 后续网页测试、浏览和 smoke 默认使用当前 Convex Auth 测试账号：邮箱 `mnote.e2e@example.com`，密码 `MnoteE2E123!`，用户名 `mnote-e2e`。
|
||
- 优先从 `http://localhost:3000/auth` 点击“测试账号快速登录”进入；若需手动注册，也必须注册同一组账号，不要改用 `MNOTE_DEV_AUTH=1` 跳过真实 auth。
|
||
- 需要核验登录是否真实生效时，优先检查当前 auth cookie/JWT 是否能读取到 Convex `users.currentUser`，避免把 `devFallback` 当成真实登录。
|
||
|
||
## 前端测试方法
|
||
|
||
- 看页面当前真实渲染结果、登录态下实际内容、JS 渲染后的 `localhost` 页面时，优先用 `/doko`；它适合读取真实 Chrome 中已经渲染完成的页面。
|
||
- 做交互测试、文件创建/删除/移动、上传、快速登录、侧边栏展开、回归断言时，优先用浏览器自动化测试工具；这类任务不要只靠 `/doko`。
|
||
- 推荐顺序是：先用 `/doko` 快速确认页面是否正常渲染，再用浏览器自动化测试工具验证关键交互链路。
|
||
- 影响主页入口、Sidebar、tree shell、文档页首屏时，优先补或复用 `scripts/task*-smoke.js` 这类 smoke 脚本。
|
||
- 排查高 CPU / 高内存 / 卡顿时，先看是否存在首屏误走实验性 tree shell、compat fallback、重复请求、轮询或回链面板持续刷新，再看数据底座。
|
||
|
||
|
||
## Wolai-aline 对标流程
|
||
|
||
- 凡任务涉及 `wolai-aline`、Wolai 对标、复刻 Wolai 体验或把 `3000` 行为与 Wolai 页面比对，必须启用 `/home/lix/.codex/skills/wolai-aline` skill，并参考 `/mnt/Data1T/mnote/design/08-wolai-aline-test-flow/process/wolai-aline-test-flow-v1.md`。
|
||
- Wolai-aline 任务默认采用“Wolai 基线取证（默认只读，编辑器任务可用 Hermes editable-test mode）-> 本地 RED smoke -> 小范围实现 -> 本地验证 -> subagent 浏览器对标复测 -> 主线程截图复核 -> 汇报剩余差异”的流程。
|
||
- 浏览器对标测试必须使用 subagent 执行；subagent 只做浏览器验证和截图，不修改源码、不还原文件、不清理证据；编辑器任务可在明确声明的 Hermes editable-test mode 下做最小编辑验证。
|
||
- Wolai 默认优先只读；当前 Hermes 测试页 `https://www.wolai.com/liaibo/ikFSSM1a4GgvmHBYFCNfVd` 已授权用于 Wolai-aline 编辑器对标，可做最小范围编辑测试。其他 Wolai 页面写入仍需沙盒页 URL 和明确授权。
|
||
- 即使在 Hermes 测试页，也禁止未经确认地删除、移动、归档、发布、评论、改权限或批量修改既有非测试内容；编辑测试必须记录前后截图、动作链、输入内容和清理状态。
|
||
- 对标验收不能只看文案或 DOM 是否存在；必须检查截图中的控件形态、开启/关闭状态、hover/active 状态、快捷键行为、URL 是否跳转等真实体验差异。
|
||
- 发现截图或实测行为与本地实现不一致时，先把差异补进 smoke 形成可复现失败，再修改实现并复测。
|
||
- Wolai owner 登录态优先复用 `/mnt/Data1T/mnote/tmp/wolai-playwright-profile`；遇到登录或滑块验证，不绕过，记录阻塞并让用户介入。
|
||
|
||
## 文件编码与风格
|
||
|
||
- 所有新增或修改文件统一使用 UTF-8。
|
||
- TS/TSX 默认 2 空格缩进，Python 默认 4 空格缩进。
|
||
- 注释使用简体中文。
|
||
-当使用deepseek模型编程时，遇到疑难问题可以使用MCP求助codex，但需要注意codex回复比较慢，可能需要等待长一点的时间>3min。
|