Skip to content

The guide and README say what the tool does now - #87

Merged
ptescher merged 1 commit into
mainfrom
docs-match-tool
Nov 13, 2026
Merged

ptescher merged 1 commit into
mainfrom
docs-match-tool

Conversation

@ptescher

Copy link
Copy Markdown
Owner

Fixes places where the docs had drifted from what the tool does, found by following the guide in a fresh project and comparing the chapters against the code.

  • Getting started: the shown check output has both warnings the command really prints, with a sentence on what short-story means.
  • Remote drivers: the "In the runner" heading is back above the RemoteDriver snippet, so the link from the agents page lands.
  • Diagnostics: adds the seven page-size warnings (previously only in the README), launch-in-step and reference. Every code the crates emit is now in the chapter.
  • The command: --reader is listed under docs.
  • Drivers: the controls section names the gap keys in interactions.json.
  • README: the crates table lists every command, the phrase-order sentence agrees with the guide and the code, and it points to the guide for Approval:, Launch:, Follows:, Hands over to: and Scopes:.

Docs only. The book builds and the repaired anchors resolve.

🤖 Generated with Claude Code

- Getting started shows the two warnings `check` really prints, and says
  what the second one means.
- Remote drivers has its "In the runner" heading back, so the link from
  the agents page lands.
- Diagnostics lists the page-size warnings, `launch-in-step` and
  `reference`.
- The command's chapter lists `--reader`; Drivers names the gap keys in
  `interactions.json`.
- The README lists every command, agrees with the guide on phrase order,
  and points to the guide for `Approval:`, `Launch:`, `Follows:`,
  `Hands over to:` and `Scopes:`.

Co-Authored-By: Claude Fable 5.2 <noreply@anthropic.com>
@ptescher
ptescher merged commit 98730f8 into main Nov 13, 2026
3 checks 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