Skip to content

docs(release): align generated manual and book with v1.2.1 - #5147

Merged
huangruiteng merged 1 commit into
mainfrom
codex/release-v1.2.1-doc-parity
Sep 26, 2026
Merged

huangruiteng merged 1 commit into
mainfrom
codex/release-v1.2.1-doc-parity

Conversation

@huangruiteng

Copy link
Copy Markdown
Collaborator

LoopX1.2.1 preparation exposed two stale publication contracts: the checked-in manpage differed from the canonical renderer and bilingual Developer Book release anchors still named1.2.0. Regenerate the manual with the existing catalog and synchronize the four lower-page version anchors to1.2.1; no runtime or first-screen presentation change.

The generated-manual check, actual CLI/help/manpage installation smoke and Developer Book publication smoke pass. First65 lines of both book home pages are byte-identical to the base, preserving their hero/navigation. Risk-based premerge and exact-scope quality are recorded before merge. Final release qualification will be restarted on the clean resulting release commit.

@huangruiteng huangruiteng left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approval conclusion (author-owned PR; GitHub blocks formal self-approval)

Reviewed exact head: 5147@ea1981f7605566aad20b30d04b1a0cd218358f3a; base: ea3ace41825b2a0cc1cca45640336eff93f363a1.

动机

1.2.1 发布检查实际复现了两个文档阻塞:已提交 manpage 与现有生成器输出不一致,Developer Book 的版本锚点仍是1.2.0。这会让安装后的手册与命名版本不一致,也会让现有发布资格测试拒绝本版本。

改动思路

保留既有 CLI catalog 与 render_manpage 为手册唯一来源,重新生成当前版本;书籍继续使用原来的四个中英版本基线字段。无需新增生成器、同步状态或测试规则。更小的只更新手册方案留下书籍 marker 失败;绕过断言又会掩盖实际文档漂移。因此把这五个文件作为一个完整、可撤销的文档修复阶段。

具体改动

完整差异是5个文件、7行增加和7行删除:manpage 版本改为1.2.1,并采用生成器现有的 roff 连字符转义;书籍中英首页与阅读指南的下方版本基线更新为1.2.1。实际生成器 equality check、CLI/help/manpage 安装 smoke 和书籍 publication smoke 全部通过,旧版本的 equality/marker 失败已独立复现。中英书首页前65行逐行相等,hero、导航与主入口不变,历史v0.5.4迁移里程碑不变。9项风险预合入检查和当前差异质量回执通过。持续工作与用户体验保持:本 PR 仅修正文档来源,不改变执行、重试、配额、状态或权限;用户仍沿原安装、命令和阅读路线操作。剩余工作由当前发布操作承担,在最终干净提交重新运行全量资格并完成真实产物交付;边界是先把必要的文档契约修复固定在发布源码中。

对主干的风险

风险是手写生成文档与实际目录漂移、把历史迁移基线随版本移动,或意外改变公共首屏。该 head 使用现有生成器,实际 equality/install 检查通过;只替换当前发布字段,历史迁移标记保留。两个书首页前65行与 base 完全一致,不涉及展示层布局或导航实现。没有新的运行时、provider、Host、权限或状态规则。本次文档验证不代表用户已升级,不代替最终 clean commit 的全量与真实模型资格,也不声称远程包已经发布。未来改动便利性检查认为此边界保持原 owner 即可,不需额外抽象。

我的整体评价

这项修复解决已经复现的发布障碍,覆盖同一版本变更的完整文档消费者且没有扩大产品行为。当前精确 head 可以按低风险文档规则合入。最终发布仍由后续固定提交资格与产物读回证明,没有未解决的当前文档 blocker。

English verdict: APPROVE

Signed-off-by: huangruiteng <14976749+huangruiteng@users.noreply.github.com>
@huangruiteng
huangruiteng force-pushed the codex/release-v1.2.1-doc-parity branch from ea1981f to 3ae6cee Compare September 26, 2026 19:51

@huangruiteng huangruiteng left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approval conclusion (author-owned PR; GitHub blocks formal self-approval)

Reviewed exact head: 5147@3ae6ceeb4f3ec90965c1c94b34b5c8ff8379496e; base: 05bf3349d0e20ae2fd7c19cb451213cc8cb92a0e.

动机

1.2.1 发布检查实际复现了两个文档阻塞:已提交 manpage 与现有生成器输出不一致,Developer Book 的版本锚点仍是1.2.0。这会让安装后的手册与命名版本不一致,也会让现有发布资格测试拒绝本版本。

改动思路

保留既有 CLI catalog 与 render_manpage 为手册唯一来源,重新生成当前版本;书籍继续使用原来的四个中英版本基线字段。无需新增生成器、同步状态或测试规则。更小的只更新手册方案留下书籍 marker 失败;绕过断言又会掩盖实际文档漂移。因此把这五个文件作为一个完整、可撤销的文档修复阶段。

具体改动

完整差异是5个文件、7行增加和7行删除:manpage 版本改为1.2.1,并采用生成器现有的 roff 连字符转义;书籍中英首页与阅读指南的下方版本基线更新为1.2.1。当前生成器 equality check 与书籍 publication smoke 通过;CLI/help/manpage 安装 smoke 在前一文档 head ea1981f76 通过,base 的 App 更新未改目录、生成器或安装器,因此保留原版本证据并在最终发布重验安装/浏览器,旧版本的 equality/marker 失败已独立复现。中英书首页前65行逐行相等,hero、导航与主入口不变,历史v0.5.4迁移里程碑不变。9项风险预合入检查和当前差异质量回执通过。持续工作与用户体验保持:本 PR 仅修正文档来源,不改变执行、重试、配额、状态或权限;用户仍沿原安装、命令和阅读路线操作。剩余工作由当前发布操作承担,在最终干净提交重新运行全量资格并完成真实产物交付;边界是先把必要的文档契约修复固定在发布源码中。

对主干的风险

风险是手写生成文档与实际目录漂移、把历史迁移基线随版本移动,或意外改变公共首屏。该 head 使用现有生成器,实际 equality/install 检查通过;只替换当前发布字段,历史迁移标记保留。两个书首页前65行与 base 完全一致,不涉及展示层布局或导航实现。没有新的运行时、provider、Host、权限或状态规则。本次文档验证不代表用户已升级,不代替最终 clean commit 的全量与真实模型资格,也不声称远程包已经发布。未来改动便利性检查认为此边界保持原 owner 即可,不需额外抽象。

我的整体评价

这项修复解决已经复现的发布障碍,覆盖同一版本变更的完整文档消费者且没有扩大产品行为。当前精确 head 可以按低风险文档规则合入。最终发布仍由后续固定提交资格与产物读回证明,没有未解决的当前文档 blocker。

English verdict: APPROVE

@huangruiteng
huangruiteng merged commit 8962b11 into main Sep 26, 2026
4 checks passed
@huangruiteng
huangruiteng deleted the codex/release-v1.2.1-doc-parity branch September 26, 2026 19:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant