Codex 仓库文档审计技能:检查安装说明与构建命令
EnglishCodex 安装步骤
- 从固定 GitHub 提交复制 `.codex/skills/docs-cleanup/` 完整目录到项目 `.agents/skills/docs-cleanup/`。
- 在 Codex 指定要检查的入口文档,并列出需要对照的配置与测试文件。
中文摘要
对照构建配置、测试脚本和示例目录,发现过期路径或相互冲突的安装与运行说明。
SKILL.md 中文导读
可复现示例
在本地示例中让 `README.md` 指向 `scripts/build.sh`,而当前 `CMakeLists.txt` 给出实际构建目标且旧脚本已移除。请 Codex 核对。工作步骤
- 逐条核对路径、命令参数和先决条件,记录支持每条发现的文件位置。
- 按严重程度列出问题及可独立验证的修复建议。
验收方法
报告给出过期指引的位置、命令失效的仓库证据和基于实际构建目标的修正建议。
GitHub 原文 · 更新日期
适用环境
需要本地仓库、现有 README、实际构建文件和对应脚本。
常见问题
如何处理自动生成的文档?
在源文件和生成配置中找问题,修正文档源并用项目现有流程重新生成。