Skip to content
目录

文档写作约定

本仓库技术文档(docs_vite/)面向读懂原理与做架构决策,不面向逐行抄源码。

原则

  1. 总结优先:用表格、列表、流程图(mermaid)说明「是什么 / 为什么 / 何时用」。
  2. 少贴或不贴源码:不写大段 createStore / workLoop 实现;必要时只保留 1~3 行 API 用法或伪代码。
  3. 指向源码位置:用「包路径 + 函数名」代替粘贴,例如 packages/redux/src/createStore.tsdispatch
  4. 系列内互链:速查放 09-常见问题,原理放专题章,避免同一机制在多文件重复大段代码。
  5. 版本标注:写明库/ React 版本(如 Redux 5、React 18/19),避免读者误用旧语义。

推荐结构(单篇)

markdown
# 标题
## 1. 定位 / 版本
## 2. 心智模型(表或图)
## 3. 核心机制(分点,无长代码)
## 4. 与其它章节的关系(链接)
## 5. 常见误区
## 6. 源码阅读路径(表)
## 7. 总结

已按本约定整理(持续更新)

目录状态
front/frameworks/react/已整理(03 仍较短,可扩写)
front/stores/zustand/✅ 已整理
front/stores/redux/✅ 已整理(含 01 概述)
front/stores/pinia/✅ 已整理(含 01 概述)
front/stores/mobx/✅ 已整理(含 01 概述)
front/frameworks/react/✅ 已整理(含 04-Hooks 精简版)
front/frameworks/xyflow/✅ 已整理
ai/frameworks/langgraphjs/✅ 已整理
front/frameworks/univer/✅ 已整理(01–10,总结为主)
ai/frameworks/langchainjs/✅ 已整理(07 章指向 langgraphjs 系列)
ai/frameworks/cc/✅ 已整理(12 改为专题索引,去掉 58+ 代码块)
ai/frameworks/deepagentsjs/✅ 已整理
ai/frameworks/a2ajs/✅ 已整理
ai/frameworks/a2a/✅ 已整理(去掉大段 proto 摘录)
ai/ 其它(ucp-protocol 等)、chrome/qiankun/待整理

其它目录欢迎按同一模板分批改。

Last updated:

MIT License.