用途:对照 VMark 代码中的快捷键定义与文档,报告差异与冲突,适用于审查、校准或优化快捷键,以及更新快捷键文档的场景。
主要能力:
- 读取文档:读取仓库内的 website/guide/shortcuts.md(主要来源),若存在则读取 dev-docs/shortcuts.md(该文件并非总会创建)。
- 扫描代码中的快捷键来源,可参考 references/paths.md。
- 从代码提取当前快捷键,并映射到文档条目。
- 报告结果:文档中缺失的条目、文档引用了已被移除的快捷键、操作系统级冲突或按键碰撞。
- 若提出修改请求,给出更新建议以及所需测试。
使用方式:当被要求审查、校准或优化快捷键,或需要更新快捷键文档时使用;先确认 WYSIWYG 模式与 Source 模式的绑定需分别核对。
限制:除上述流程外,未提供更多细节;该 dev-docs/shortcuts.md 不一定存在。除非被明确要求重新设计,否则应优先沿用 VMark 中已有约定。