Skip to content

docs: document configurable lane setups#435

Merged
itsmiso-ai merged 1 commit into
mainfrom
docs/configurable-lane-setups
Jun 18, 2026
Merged

docs: document configurable lane setups#435
itsmiso-ai merged 1 commit into
mainfrom
docs/configurable-lane-setups

Conversation

@itsmiso-ai

Copy link
Copy Markdown
Contributor

Closes #388

@its-saffron its-saffron Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_CONFIG environment 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 LaneConfig object fields, including role (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 laneAliases for 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.md to 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

@itsmiso-ai itsmiso-ai merged commit 31c0c30 into main Jun 18, 2026
3 checks passed
@itsmiso-ai itsmiso-ai deleted the docs/configurable-lane-setups branch June 18, 2026 03:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document configurable lane setups

2 participants