docs: document configurable lane setups#435
Merged
Merged
Conversation
There was a problem hiding this comment.
AI Automated Review
Full PR review.
Analysis engine: review@https://litellm.jory.dev/v1 (openai) — primary route
Summary
This PR provides comprehensive documentation for the configurable execution lanes feature, fulfilling the requirements outlined in issue PR 388. It introduces a new documentation file docs/configurable-lanes.md and updates the README.md and docs/issue-lane-classification.md to guide users on how to configure, migrate, and understand the role of execution lanes.
Change-by-change findings
README.md
- Added a high-level overview of Execution Lanes, explaining their purpose in controlling agent queue behavior and claimability. It also introduces the
DISPATCH_LANE_CONFIGenvironment variable and provides a link to the detailed documentation.
docs/configurable-lanes.md
- New Documentation: This file is a thorough guide covering:
- Core Concepts: Explains what lanes are and how they differ from GitHub status labels.
- Default Setup: Details the out-of-the-box configuration (
normal,escalated,backlog). - Configuration Schema: Provides a detailed breakdown of the
LaneConfigobject fields, includingrole(default vs. escalation). - Configuration Examples: Includes the required examples: a single claimable lane setup and a multi-lane setup (routine, complex, review).
- Migration Support: Explains the use of
laneAliasesfor safe, read-time migrations of existing issue data. - Operational Details: Covers queue API filtering, classification/reconciliation behavior, and how to handle unknown/unconfigured lanes to prevent data loss.
- Environment Variable: Provides a clear example of how to set the configuration via
DISPATCH_LANE_CONFIG.
docs/issue-lane-classification.md
- Added a link to the new
docs/configurable-lanes.mdto ensure users can easily find configuration details from the classification documentation.
Linked Issue Fit
This PR directly addresses PR 388 and meets all specified requirements and acceptance criteria:
- Explains default and custom lanes: Covered in
This was referenced Jun 18, 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.
Closes #388