docs: verify latest installs and document command catalog - #11
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
问题
现有安装文档存在三个需要统一处理的问题:
remove输出的 npm 卸载命令缺少全局参数-g,Core help 仍显示已取消治理的内部名称Core Contract 0.2。修改
使用 npm
latest安装所有面向普通用户的安装示例统一使用:
npm install -g dev-flow-codex@latest TARBALL="$(npm pack dev-flow-deepseek@latest --silent)"同步范围包括:
Support Matrix、Release Tag、npm 精确版本链接、bundled Core identity 与最终制品证据继续保留
0.5.1/0.5.0等精确身份,不使用latest替代不可变证据。对照实现建立完整命令目录
新增:
docs/COMMANDS.mddocs/COMMANDS_en.md命令目录按调用层分开说明:
setup [--json]、remove [--json]、--version;mcp;npm pack @latest、profile add、--dump-config、profile remove;version、mcp --stdio;命令事实分别对照:
packages/*/package.json的 package、bin与平台约束;packages/codex/bin/dev-flow-codex.mjs的实际参数 parser;cmd/dev-flow/main.go;internal/mcp/的闭合 tool catalog。文档明确指出
dev-flow-deepseek没有独立bin,并且不会记录实现不接受的 Codexhelp、update、uninstall或其他推测子命令。修正代码与输出一致性
dev-flow-codex remove的后续提示从:修正为:
同步更新 launcher 定向测试。
Core help 从
governed Core Contract 0.2改为governed Core,移除已经取消治理的内部合同版本号,并只修改对应帮助断言。将
packages/codex/tests/launcher.test.mjs加入仓库 bounded validation,确保 Codex 命令 parser、版本输出、setup/remove 行为、未知命令拒绝和全局卸载提示在普通 PR CI 中执行。文档与 I18n 治理
AGENTS.md现在要求安装与命令文档对照实际 parser、manifest、Journey 和 MCP catalog;docs/COMMANDS*、受影响的 package README 与全部相关根 README locale;@latest,精确支持与发布证据继续使用不可变版本;docs/I18N*、CONTRIBUTING*和 Pull Request 模板。明确范围外
验证
当前 Head:
39b0603d1519562071e088d3c5f0cf708337a3d9GitHub Actions
pull-request-validationrun #111 已通过,包含:go vet ./...:passed;go test ./...:passed,包括cmd/dev-flow;Repository validation passed.另外使用本地 npm fixture 验证了
npm pack <package>@latest --silent仍在 stdout 返回 tarball 文件名,因此TARBALL="$(...)"安装形式成立。I18n
已同步:
zh-CN、en、zh-TW、ja、ko、es、fr、de、pt-BR。9 个根 README 保持相同的安装命令、selector、MCP tool catalog、状态图拓扑、精确支持身份和命令参考入口。新增翻译已完成结构与技术事实同步;合并前仍建议由对应语言的母语开发者进行措辞 review。