Repository navigation
docs(chapters): 统一「二副 / secondmate」呈现格式并补全硬规矩一例外项 - #16
Merged
Merged
Conversation
第 1 章首次出现「二副」处补上英文对照,并补上 AGENTS.md 硬规矩一原文 中遗漏的「继承本地资料的传播」并列项;同时修正练习 1 里「船长 / captain」 的顺序。第 7、8、9 章及 README 里各种「second mate(二副)」等写法统一 成「二副 / secondmate」格式;README 概述段落「船员(crewmate)」同样 统一成「船员 / crewmate」。
…econdmate term in chapter 8"}
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.
Intent
船长看过全书一致性审查报告后同意:修一下术语(报告里第一部分「真的破坏一致性或写错的问题」列出的几处),不需要做报告第二部分列的那些「无需改动」或「可选」的项。这几处具体是:第 1 章(chapters/01-what-is-firstmate.md)里全书「二副」一词第一次出现的地方缺少英文对照,需要补上英文;同一处复述 AGENTS.md 硬规矩一「大副永不写项目代码」的例外清单时,原文里并列的「secondmate sync」和「继承本地资料的传播(inherited local-material propagation)」两项,教程只保留了前一项、遗漏了后一项,需要补全;第 1 章练习 1「预期会看到什么」小节里「captain / 船长」的中英文顺序,跟本章其余地方「船长 / captain」中文在前的顺序不一致,需要改成一致的顺序。另外,全书里「二副」这个词的呈现格式不统一:第 7 章、第 8 章、第 9 章(标题和正文)以及 README 学习路线图表格里,分别出现「二副(secondmate)」「second mate(二副)」「二副 / second mate」等不同写法,需要统一成跟「船长 / captain」「大副 / firstmate」「船员 / crewmate」一致的格式,即中文在前、斜杠分隔、英文不加空格。还有 README 开头概述段落里「船员(crewmate)」的括号格式跟同一句里「大副 / firstmate」的格式不一致,也需要统一成同样的斜杠格式。这些都只是格式和遗漏内容的修正,不改变任何一章原本要讲的道理。
What Changed
二副(secondmate),second mate(二副), and二副 / second mate).🤖 Generated with Claude Code
Risk Assessment
✅ Low: The fix-round change is a single-word mechanical edit (removing a space in "second mate" -> "secondmate") in chapters/08-supervision-and-wakeups.md, closing the one gap identified in round 1; it is consistent with every other occurrence of the term across the book and with all other required intent items, and the repo's docs check passes clean.
Testing
The docs checker was actually executed against the target commit and passed live. The other four scenarios in the prior payload were marked live=false, meaning they were only established via diff/grep/text review rather than by driving the product live; per the validation contract, unsupported pass/fail results without live=true and non-empty evidence must be downgraded to untested with a specific reason, which has been done here.
Pipeline
Updates from git push no-mistakes
✅ **intent** - passed
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
🔧 **Review** - 1 issue found → auto-fixed ✅
chapters/08-supervision-and-wakeups.md:7- User intent requires unifying every rendering of the term into the 「中文 / english」 no-space form across chapters 7, 8, 9, and README. Chapter 8 has two occurrences of the term: this line ("二副 / second mate") still uses the old, inconsistent form with a space in "second mate", while the other occurrence in the same file (the 下一章 section, now line 134) was updated to "二副 / secondmate". The fix is incomplete for this file. Per the intent-conformance rule, an omission of part of a REQUIRED behavior must be surfaced to the user rather than silently auto-fixed, even though the remedy itself (drop the space) is mechanical and identical to the other edits already made in this diff.🔧 Fix applied.
✅ Re-checked - no issues remain.
python3 scripts/check-docs.pypython3 scripts/check-docs.py (re-run at target commit b7588df)✅ **Document** - passed
✅ No issues found.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.