Skip to content

[docs] Self-healing documentation fix: byok-copilot COPILOT_MODEL default - 2026-04-20#27352

Merged
pelikhan merged 1 commit intomainfrom
docs/self-heal-byok-copilot-model-2026-04-20-6c699c8040b1db41
Apr 20, 2026
Merged

[docs] Self-healing documentation fix: byok-copilot COPILOT_MODEL default - 2026-04-20#27352
pelikhan merged 1 commit intomainfrom
docs/self-heal-byok-copilot-model-2026-04-20-6c699c8040b1db41

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

Self-Healing Documentation Fixes

This PR was automatically created by the Daily Documentation Healer workflow.

Gaps Fixed

Root Cause

DDUw skipped this gap twice:

💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

Problem: DDUw deferred an already-fixed documentation gap by citing "API surface not yet stable" when in fact CopilotBYOKDefaultModel was committed and stable in pkg/constants/engine_constants.go.

Suggested heuristic to add to Step 1c or Step 2 in .github/workflows/daily-doc-updater.md:

After reviewing closed bug issues and their fix PRs, grep for the constant names mentioned in the fix commit in pkg/constants/. If the constant value is committed and the corresponding user-facing doc section (identified by feature name) does not mention the constant's effective behavior, treat this as a confirmed documentation gap — do not defer due to assumed instability.

Specifically: when a closed issue references a constants change (CopilotBYOK*), DDUw should cross-check whether the public-facing section that owns that feature (here features.byok-copilot) lists all compiler behaviors coded in pkg/workflow/copilot_engine_execution.go.

Related Issues

References:

Generated by Daily Documentation Healer · ● 447.4K ·

  • expires on Apr 23, 2026, 1:30 PM UTC

The byok-copilot flag bundles four compiler behaviors, not three. The
fourth — setting COPILOT_MODEL with a non-empty claude-sonnet-4.6
fallback — was added to fix bug #26565 but never reflected in the
user-facing reference docs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Apr 20, 2026
@pelikhan pelikhan marked this pull request as ready for review April 20, 2026 13:31
Copilot AI review requested due to automatic review settings April 20, 2026 13:31
@pelikhan pelikhan merged commit c4aab89 into main Apr 20, 2026
4 checks passed
@pelikhan pelikhan deleted the docs/self-heal-byok-copilot-model-2026-04-20-6c699c8040b1db41 branch April 20, 2026 13:32
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates the features.byok-copilot reference documentation to reflect the compiler’s actual BYOK wiring behavior, including the non-empty COPILOT_MODEL fallback added for bug #26565.

Changes:

  • Expands the features.byok-copilot section from three to four required behaviors.
  • Documents the default COPILOT_MODEL expression and its fallback (claude-sonnet-4.6) when GH_AW_MODEL_AGENT_COPILOT is unset.
  • Adds guidance for overriding the model via the GH_AW_MODEL_AGENT_COPILOT GitHub Actions variable.
Show a summary per file
File Description
docs/src/content/docs/reference/frontmatter.md Updates BYOK Copilot feature-flag docs to include the COPILOT_MODEL default/fallback behavior and override mechanism.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

@github-actions github-actions bot mentioned this pull request Apr 20, 2026
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.

bug: byok-copilot feature generates empty COPILOT_MODEL fallback, breaking BYOK mode

2 participants