From 4acda533b7326798a1f677602bf597519530b573 Mon Sep 17 00:00:00 2001 From: drakezhang Date: Wed, 19 Aug 2026 17:56:33 +0800 Subject: [PATCH] docs(cli): keep README.md out of the wire-vocab scan README will carry upgrade notes for agents moving between CLI versions, so it must be allowed to name legacy terms. Scan only current-truth sources: skills/ and AGENTS.md. CHANGELOG.md stays excluded for the same reason. --- cli/scripts/check-skill-wire-vocab.sh | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/cli/scripts/check-skill-wire-vocab.sh b/cli/scripts/check-skill-wire-vocab.sh index 8f0d9ba5..c3eb588d 100755 --- a/cli/scripts/check-skill-wire-vocab.sh +++ b/cli/scripts/check-skill-wire-vocab.sh @@ -21,14 +21,14 @@ BANNED=( "retry_command:retry_argv (error envelope field renamed in v0.10)" ) -# Every doc an agent or integrator reads as current truth. AGENTS.md and -# README.md are in scope because they are the authoritative wire contract that +# Current-truth sources only. AGENTS.md is the authoritative wire contract that # skills are condensed from — a rename that lands in skills/ but not here leaves # the source of truth wrong. # -# CHANGELOG.md is deliberately NOT scanned: recording a rename requires naming -# the legacy term, so scanning it would guarantee a false positive. -SCAN_TARGETS=(skills/ AGENTS.md README.md) +# CHANGELOG.md and README.md are deliberately NOT scanned. Both will name +# legacy terms when recording a rename or writing upgrade notes for agents +# moving between CLI versions; scanning them would guarantee a false positive. +SCAN_TARGETS=(skills/ AGENTS.md) # The v0.10 retry_command miss happened because the scan silently covered less # than the docs that needed covering. Fail loudly if a target disappears rather