Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-08-07 - #51235

Merged
pelikhan merged 1 commit into
mainfrom
doc-healer/engines-max-turns-disambiguation-235bac4f787b6e02
Aug 8, 2026
Merged

[docs] Self-healing documentation fixes from issue analysis - 2026-08-07#51235
pelikhan merged 1 commit into
mainfrom
doc-healer/engines-max-turns-disambiguation-235bac4f787b6e02

Conversation

@github-actions

@github-actions github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Overview

Documentation fix disambiguating a duplicate max-turns row in the engine feature-comparison table on the Engines reference page.

Key Change

The table previously listed two rows both labeled max-turns, which was ambiguous. This PR clarifies them:

Before After
`max-turns` (AWF invocation cap; `max-runs` deprecated) `max-turns` (top-level AWF invocation cap; `max-runs` deprecated)
`max-turns` `engine.max-turns` (deprecated nested alias)

Files Changed

  • docs/src/content/docs/reference/engines.md — 1 file, 2 lines changed (2 additions, 2 deletions)

Impact

  • Type: Documentation only
  • Breaking: No
  • Risk: Low — no code or behavior change, clarifies existing table wording

References:

Two rows in the engine feature comparison table were both labeled
`max-turns` with contradictory support values, making the table
self-contradictory. Per the explanatory prose below the table, the
second row describes the deprecated nested `engine.max-turns` alias
(Claude-only), not the top-level field.

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Aug 7, 2026
@pelikhan
pelikhan marked this pull request as ready for review August 8, 2026 00:29
Copilot AI balanced review requested due to automatic review settings August 8, 2026 00:29
@pelikhan
pelikhan merged commit 93273c4 into main Aug 8, 2026
7 checks passed
@pelikhan
pelikhan deleted the doc-healer/engines-max-turns-disambiguation-235bac4f787b6e02 branch August 8, 2026 00:30
@github-actions

github-actions Bot commented Aug 8, 2026

Copy link
Copy Markdown
Contributor Author

Test Quality Sentinel completed test quality analysis.

No test files were added or modified in this PR. Test Quality Sentinel skipped.

🧪 Test quality analysis by Test Quality Sentinel

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Clarifies two max-turns configuration paths in the engine comparison table.

Changes:

  • Qualifies the top-level max-turns field.
  • Renames the nested alias to engine.max-turns.
Show a summary per file
File Description
docs/src/content/docs/reference/engines.md Disambiguates max-turns table rows.

Review details

Tip

Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

  • Files reviewed: 1/1 changed files
  • Comments generated: 1
  • Review effort level: Balanced

| `max-turns` (AWF invocation cap; `max-runs` deprecated) | ✅ | ✅ | ✅ | ✅ | ✅ |
| `max-turns` | ❌ | ✅ | ❌ | ❌ | ❌ |
| `max-turns` (top-level AWF invocation cap; `max-runs` deprecated) | ✅ | ✅ | ✅ | ✅ | ✅ |
| `engine.max-turns` (deprecated nested alias) | ❌ | ✅ | ❌ | ❌ | ❌ |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants