docs(hooks): correct hook-command examples to bare script paths#64
Merged
Conversation
## What Fixes the settings.local.json hook examples in docs/hooks-guide.md (7), docs/configuration-reference.md (1), and docs/enterprise-security.md (1): each `command` is now a bare script path, not `bash "<path>"`. Adds a note in hooks-guide.md explaining the correct format and the failure mode. ## Why The docs taught the shell-prefixed `command` form that fails at runtime with "bash.exe: bash.exe: cannot execute binary file" (the installer bug fixed in v0.4.1). Docs must teach the corrected format so anyone hand-editing settings.local.json does not reintroduce the bug. ## Risk None. Documentation only. ## Test plan - [x] no `"command": "bash` examples remain in docs (method: grep)
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
1 participant
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.
docs(hooks): correct hook-command examples to bare script paths
What
Fixes the settings.local.json hook examples in docs/hooks-guide.md (7),
docs/configuration-reference.md (1), and docs/enterprise-security.md (1):
each
commandis now a bare script path, notbash "<path>". Adds a notein hooks-guide.md explaining the correct format and the failure mode.
Why
The docs taught the shell-prefixed
commandform that fails at runtime with"bash.exe: bash.exe: cannot execute binary file" (the installer bug fixed in
v0.4.1). Docs must teach the corrected format so anyone hand-editing
settings.local.json does not reintroduce the bug.
Risk
None. Documentation only.
Test plan
"command": "bashexamples remain in docs (method: grep)