Skip to content

docs(chapters): 写第八章《supervision(监督)与唤醒机制》并更新导航 - #15

Merged
jasontopia merged 4 commits into
mainfrom
fm/learn-fm-ch8-v2
Sep 26, 2026
Merged

jasontopia merged 4 commits into
mainfrom
fm/learn-fm-ch8-v2

Conversation

@jasontopia

Copy link
Copy Markdown
Owner

Intent

继续 Learn FirstMate 教程,写第八章。前七章已写完或正在走质检流水线。README 的学习路线图里,第八章的定位是:大副怎么在不烧 token 的前提下盯住整支队伍,什么事件会把它叫醒,什么时候才该轮到船长被打扰。第八章是路线图里「从单件活扩展到一支队伍要处理的事」这条线(第 6 到 8 章)的最后一章。

What Changed

  • Added chapters/08-supervision-and-wakeups.md, a new chapter covering how firstmate supervises a whole crew of crewmates without burning tokens while idle, the four wake-event types (signal, stale, check, heartbeat) and how each is handled, why a status line is a wake event rather than current state, and a hypothetical case study illustrating a stale-wake misjudgment.
  • Updated README.md's roadmap table to link chapter 8 to the new file and change its status from "待写" to "已写".

Risk Assessment

✅ Low: Docs-only change: the README edit is exactly the single-row link/status update the user specified during the rebase, and the new chapter's quoted material from AGENTS.md, docs/architecture.md, and the bin/ script headers all verified verbatim against the read-only FirstMate checkout; the docs-check script passes and the two prior fix rounds' targeted ellipsis edits are correctly and minimally applied.

Testing

Verified the change is confined to two markdown files (README.md roadmap row 8, and new chapters/08-supervision-and-wakeups.md), re-ran the repo's only check (scripts/check-docs.py, clean), and manually confirmed both prior review-round decisions landed correctly in the diff. The chapter's hands-on exercise (running it against a live FirstMate session) was not exercised here since that session/checkout lives outside this docs repo and outside what these three checks stood up.

  • Live validation: ✅ go - 3 of 4 scenarios driven live against the product
Scenario Result Live Evidence
docs-check-passes ✅ pass live python3 scripts/check-docs.py output: 'checked 14 markdown file(s): no problems found'
readme-roadmap-row-8-updated-correctly ✅ pass live git diff shows only row 8 changed: link now points to chapters/08-supervision-and-wakeups.md and status changed from 待写 to 已写; rows 3,4,5,6,7,9,10,12 untouched, matching the recorded rebase-1 decision
stale-wake-quote-ellipsis-fix-applied ✅ pass live chapters/08-supervision-and-wakeups.md:32 now reads '...unresponsive worker...' matching the recorded review-1 decision
reader-follows-chapter-8-exercise-against-a-live-firstmate-session ⏸️ untested no This repo is documentation-only with no runtime product surface (per AGENTS.md: no build system, dependency manifest, test framework, or package manager). Exercising the chapter's hands-on exercise wo…

Pipeline

Updates from git push no-mistakes

✅ **intent** - passed

✅ No issues found.

🔧 **Rebase** - 1 issue found → auto-fixed ✅
  • ⚠️ README.md - merge conflict rebasing onto origin/main

🔧 Fix applied.
✅ Re-checked - no issues remain.

🔧 **Review** - 1 issue found → auto-fixed ✅
  • ⚠️ chapters/08-supervision-and-wakeups.md:32 - The four-item wake-handling blockquote is introduced as '原文' (the original text), and item 3 correctly signals its truncation with a trailing '...'. Item 2, however, silently drops the second clause of the actual AGENTS.md sentence ('; a deep-inspection reason also requires current-state and validation-log inspection.') without any ellipsis or truncation marker, so it reads as a complete verbatim quote when it isn't. A reader relying on this section for the full authoritative rule on stale-wake handling would miss the deep-inspection requirement. Fix is mechanical: either quote the full sentence or add '...' like item 3 does.

🔧 Fix applied.
✅ Re-checked - no issues remain.

✅ **Test** - passed

✅ No issues found.

  • Live validation: ✅ go - 3 of 4 scenarios driven live against the product
Scenario Result Live Evidence
docs-check-passes ✅ pass live python3 scripts/check-docs.py output: 'checked 14 markdown file(s): no problems found'
readme-roadmap-row-8-updated-correctly ✅ pass live git diff shows only row 8 changed: link now points to chapters/08-supervision-and-wakeups.md and status changed from 待写 to 已写; rows 3,4,5,6,7,9,10,12 untouched, matching the recorded rebase-1 decision
stale-wake-quote-ellipsis-fix-applied ✅ pass live chapters/08-supervision-and-wakeups.md:32 now reads '...unresponsive worker...' matching the recorded review-1 decision
reader-follows-chapter-8-exercise-against-a-live-firstmate-session ⏸️ untested no This repo is documentation-only with no runtime product surface (per AGENTS.md: no build system, dependency manifest, test framework, or package manager). Exercising the chapter's hands-on exercise wo…
  • python3 scripts/check-docs.py
  • python3 scripts/check-docs.py (baseline, already run: 14 markdown files, no problems found)
  • git diff 6b1f56e..a3f523d -- README.md (confirmed only row 8 changed, matching rebase decision)
  • grep -n "unresponsive worker" chapters/08-supervision-and-wakeups.md (confirmed ellipsis fix present)
✅ **Document** - passed

✅ No issues found.

✅ **Lint** - passed

✅ No issues found.

✅ **Push** - passed

✅ No issues found.

@jasontopia
jasontopia merged commit f858a31 into main Sep 26, 2026
1 check passed
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