docs: document all builtin hooks in schema and hooks page#2555
Merged
dgageot merged 1 commit intodocker:mainfrom Apr 28, 2026
Merged
Conversation
trungutt
approved these changes
Apr 28, 2026
rumpl
approved these changes
Apr 28, 2026
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
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.
The hooks page and JSON schema only mentioned three builtins (
add_date,add_environment_info,add_prompt_files) even though the runtime now shipsnine. This brings the docs back in sync with
pkg/hooks/builtins.Changes:
agent-schema.json–HookDefinition.typedescription now lists everyshipped builtin with its target event and arg semantics;
argsdescriptionwas extended with concrete examples for builtins that accept parameters
(
add_prompt_files,add_recent_commits,add_git_diff,max_iterations).docs/configuration/hooks/index.md– New Built-in Hooks sectionwith a YAML example, a reference table of all 9 builtins (event + args +
behavior), and callouts explaining per-turn vs. per-session semantics, the
agent-flag shorthands (`add_date: true` etc.), and the difference between
the `max_iterations` agent field and the same-name builtin hook.
comment with the full list of shipped builtins and their events/args.
Validation: `go test ./pkg/config/... ./pkg/hooks/...` (incl.
`TestJsonSchemaWorksForExamples`).