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.
main
drakezhang 2026-08-19 17:56:33 +08:00 committed by lyingbug
parent a788115ef3
commit 4acda533b7
1 changed files with 5 additions and 5 deletions

View File

@ -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