Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-05-07#30709

Merged
pelikhan merged 1 commit into
mainfrom
doc-healer/imports-engine-mcp-2026-05-07-b7879bfc67e9eb55
May 7, 2026
Merged

[docs] Self-healing documentation fixes from issue analysis - 2026-05-07#30709
pelikhan merged 1 commit into
mainfrom
doc-healer/imports-engine-mcp-2026-05-07-b7879bfc67e9eb55

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

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

Self-Healing Documentation Fixes

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

Gaps Fixed

  • imports.md missing engine.mcp import support — The feature added in feat commit e409999 (feat: support importing engine.mcp.tool-timeout and session-timeout from shared workflows) was not reflected in the imports reference documentation. Three locations were updated:
    1. Allowed Import Fields list: added engine.mcp (without engine identifier) as an importable field
    2. Field-Specific Merge Semantics table: added a row describing the first-wins merge behavior
    3. New section: "Importing MCP Gateway Settings" with a worked example showing a shared file that exports tool-timeout and session-timeout

Root Cause

DDUw scanned the last 24 hours of merged PRs, but the large squash commit bundles many changesets together, making it harder to detect individual feature additions. The engine.mcp import feature was added to pkg/parser/import_field_extractor.go and the JSON schema (main_workflow_schema.json) but no corresponding documentation update was included in the commit.

💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

Gap class: New importable frontmatter fields not reflected in docs/src/content/docs/reference/imports.md.

Specific step that failed: Step 4 (Identify Documentation Gaps) — DDUw did not cross-reference the "Allowed Import Fields" list against the JSON schema's engine field oneOf variants to detect the new MCP-only engine variant.

Suggested improvements:

  1. Add a scan step: after processing merged PRs, check pkg/parser/schemas/main_workflow_schema.json for any oneOf variants under the engine field definition that are not mentioned in docs/src/content/docs/reference/imports.md.
  2. Add a heuristic: any commit that modifies import_field_extractor.go should trigger a review of imports.md to ensure the "Allowed Import Fields" section and "Field-Specific Merge Semantics" table are updated.

References: §25467911393

Generated by Daily Documentation Healer · ● 362.5K ·

  • expires on May 10, 2026, 12:06 AM UTC

Add engine.mcp (tool-timeout, session-timeout) to the Allowed Import
Fields list, the Field-Specific Merge Semantics table, and a new
"Importing MCP Gateway Settings" section with a worked example.

Closes gap introduced by feat: support importing engine.mcp.tool-timeout
and session-timeout from shared workflows (#30686).

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels May 7, 2026
@pelikhan pelikhan marked this pull request as ready for review May 7, 2026 01:13
Copilot AI review requested due to automatic review settings May 7, 2026 01:13
@pelikhan pelikhan merged commit e3d1de7 into main May 7, 2026
15 checks passed
@pelikhan pelikhan deleted the doc-healer/imports-engine-mcp-2026-05-07-b7879bfc67e9eb55 branch May 7, 2026 01:14
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 imports reference documentation to include support for importing MCP gateway timeout settings via engine.mcp from shared workflows, matching existing parser/schema behavior.

Changes:

  • Adds engine.mcp to the “Allowed Import Fields” list for shared workflows.
  • Documents merge semantics for imported engine.mcp.tool-timeout / engine.mcp.session-timeout (consumer override + first-wins across imports).
  • Adds a new “Importing MCP Gateway Settings” section with a worked example.
Show a summary per file
File Description
docs/src/content/docs/reference/imports.md Documents engine.mcp import support, merge semantics, and provides an example for shared timeout configuration.

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

Copy link
Copy Markdown
Contributor Author

@github-actions github-actions Bot left a comment

Choose a reason for hiding this comment

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

🧠 Reviewed using Matt Pocock's skills by Matt Pocock Skills Reviewer · ● 2.9M

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