Skip to content

docs: add engine.driver to frontmatter reference#45420

Merged
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-document-engine-driver
Jul 14, 2026
Merged

docs: add engine.driver to frontmatter reference#45420
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-document-engine-driver

Conversation

Copilot AI commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

The frontmatter reference omitted engine.driver even though the field is schema-defined and compiler-validated. This created an inconsistency between the primary frontmatter reference and the engine-specific docs.

  • What changed

    • Added a new Engine Driver (\engine.driver:`)entry todocs/src/content/docs/reference/frontmatter.md`.
    • Documented purpose and behavior at reference level, including Copilot SDK-mode implication.
    • Linked to the detailed engine docs section for constraints and supported formats.
  • Reference example

    engine:
      id: copilot
      driver: .github/drivers/custom-copilot-driver.js

@github-actions

Copy link
Copy Markdown
Contributor

Hey @copilot 👋 — thanks for picking up the engine.driver documentation gap! Filling in the missing frontmatter.md reference entry is a well-scoped, high-value fix for users who rely on it as their primary lookup.

A couple of things to address before this is ready for review:

  • No changes yet — the PR is still a draft with 0 lines changed. Once the doc edit lands, make sure the description is updated from the WIP placeholder to a clear summary of what was added and why.
  • Tests / validation — for pure doc PRs there may be no automated test requirement, but if the project has a doc-linting or link-checking step, confirm it passes.
  • Description — replace the boilerplate opening with a concise summary: what field was added, where, and a one-liner on why it was missing.

If you'd like a hand finishing up, here's a ready-to-use prompt:

In docs/src/content/docs/reference/frontmatter.md, add a documented entry for the `engine.driver` field.

Steps:
1. Locate the `engine:` section in frontmatter.md.
2. Add a `driver:` sub-entry that matches the style of surrounding entries, describing the accepted values and their effect (refer to engines.md and main_workflow_schema.json for the allowed driver values).
3. Update the PR body to replace the WIP placeholder with a concise summary of the change.

Generated by ✅ Contribution Check · 112.9 AIC · ⌖ 10.7 AIC · ⊞ 6.2K ·

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add engine.driver entry to frontmatter reference docs: add engine.driver to frontmatter reference Jul 14, 2026
Copilot AI requested a review from pelikhan July 14, 2026 09:41
@pelikhan pelikhan marked this pull request as ready for review July 14, 2026 10:05
Copilot AI review requested due to automatic review settings July 14, 2026 10:05
@pelikhan pelikhan merged commit aae2285 into main Jul 14, 2026
@pelikhan pelikhan deleted the copilot/deep-report-document-engine-driver branch July 14, 2026 10:05

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

Adds the missing engine.driver frontmatter reference.

Changes:

  • Documents driver overrides and Copilot SDK behavior.
  • Adds a Copilot driver example and detailed-doc link.
Show a summary per file
File Description
docs/src/content/docs/reference/frontmatter.md Adds the engine.driver reference entry.

Review details

Tip

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

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


### Engine Driver (`engine.driver:`)

Overrides the built-in engine runtime driver for engines that support driver mode. For Copilot, setting `engine.driver` also enables SDK mode. See [AI Engines](/gh-aw/reference/engines/#copilot-sdk-support) for driver requirements and supported formats.
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.

[deep-report] Document engine.driver in frontmatter.md reference

3 participants