Skip to content

仓库知识使用约定 ​

docs/ 是根目录和各模块 AGENTS.md 的按需知识扩展,网站直接展示同一套 Markdown。

从问题到实现 ​

已有类名、界面文字、报错或协议字段时,用 rg 找实现,沿调用核对测试。专题补充设计理由、兼容约束和现场语义。代码入口不清楚时,可在仓库根目录用下面的命令,也可查知识地图。 知识地图

powershell
node docs/.vitepress/scripts/knowledge.mjs search "问题或代码符号" --limit 5

查询只需 Node,默认查当前主题。查规划或历史时加 --all。 JSON 查询结果

资料职责 ​

工作规则在 AGENTS.md,能力契约和实现入口在所属主题,测试随实现查找。模块和安装包的入口在各自 README。地图、catalog 和导航由主题元数据生成。版本变化查 CHANGELOG.md、Git 或仓库内的 docs/_history/。

常用入口 ​

基于 MIT License 发布。