| name | codexguide-development |
| description | 当开发 CodexGuide 仓库,需要遵循本项目规则集合时使用;当前包含文档迁移、编号重排、导航和交叉链接更新规范。 |
CodexGuide 开发规则
本 Skill 是 CodexGuide 的项目规则集合。每条规则都应保持极简、可迁移、可扩展,并写明触发场景、执行步骤和可检查的完成标准。
规则 1:文档迁移原则
当文档被移动、重命名、重排编号,或放入新的章节分组时,使用本规则。目标是迁移完成后,仓库看起来像内容本来就位于最终位置一样自然。
-
确定最终位置。
- 如果用户指定目标位置,按用户指定的位置处理。
- 如果用户未指定,根据当前文档结构判断最合适的章节。
完成标准:最终目录、文件名、所在顺序都已明确。
-
真正移动文档。
- 如果所在章节使用编号文件名,同步重命名文件,保持编号连续。
- 按需顺延或回退受影响的相邻文档。
- 周围章节使用编号时,不保留无编号的过渡文件。
完成标准:文件系统顺序与预期阅读顺序一致。
-
更新所有相关引用。
- 在仓库中搜索旧路径、旧 slug、标题和旧编号文件名。
- 若 Markdown 链接、README、导航、侧边栏、SEO 元数据、致谢页或索引页指向被移动内容,都要同步更新。
完成标准:仓库搜索不到指向旧文档路径的过期引用。
-
修复阅读链路。
- 更新被移动文档和受影响相邻文档底部的
下一步 链接。
- 保持索引列表编号与文件名编号一致。
完成标准:从前一篇读到迁移文档,再读到后一篇时,顺序符合新的文档结构。
-
验证迁移结果。
- 先运行最小有效检查:优先搜索旧链接;可行时运行站点构建。
- 如果跳过某项检查,说明原因。
完成标准:验证结果已记录,剩余风险已说明。
扩展方式
后续项目规范按独立编号规则追加。每条规则只放一个清晰约束,避免把不同职责混在同一条规则里。