docs(delegate): document max_concurrent_children and max_spawn_depth … - #14568
docs(delegate): document max_concurrent_children and max_spawn_depth …#14568MorAlekss wants to merge 1 commit into
Conversation
|
@alt-glitch Not a duplicate. #13745 covered |
|
Merged via #15454 (rebase-merge) with your authorship preserved on the doc commit. The only tweak: kept the two knobs commented in cli-config.yaml.example so users aren't pinned to the literal default when we raise it later. Improved comments, warning, docs table, and tool-description update all landed as-is. Thanks for the thorough documentation pass — these two knobs were genuinely underdocumented. |
Summary
Documents two existing but undocumented
delegate_taskconfiguration parameters:max_concurrent_childrenandmax_spawn_depth. Both are already implemented in code but easy to miss without reading the source.What changed
cli-config.yaml.example: uncommented and expanded descriptions formax_concurrent_childrenandmax_spawn_depthtools/delegate_tool.py:_get_max_concurrent_children(): added warning log when value > 10delegation.*config keys and nested delegation requirementswebsite/docs/guides/delegation-patterns.md: added "Tuning Concurrency and Depth" table to the Constraints sectionWhy
Skills like #379 (simplify, 3 parallel reviewers) and custom batch workflows need users to know that (a) the concurrency limit is configurable and (b) nested delegation requires both
role="orchestrator"andmax_spawn_depth >= 2. Currently neither is discoverable without readingdelegate_tool.pysource.Example configuration
Raising
max_spawn_depthto 2+ enablesrole="orchestrator"children to spawn their own workers.Testing
No functional code changes - docs and logging only. Verified that
cli-config.yaml.exampleparses as valid YAML.