Skip to content

Remove payload-dir from frontmatter documentation#14069

Merged
pelikhan merged 2 commits intomainfrom
copilot/remove-payload-dir-config
Feb 6, 2026
Merged

Remove payload-dir from frontmatter documentation#14069
pelikhan merged 2 commits intomainfrom
copilot/remove-payload-dir-config

Conversation

Copy link
Contributor

Copilot AI commented Feb 6, 2026

The payload-dir field was documented as a user-configurable frontmatter option, but extractMCPGatewayConfig() never parses it from frontmatter. The field is set programmatically by ensureDefaultMCPGatewayConfig() to /tmp/gh-aw/mcp-payloads and is an internal implementation detail.

Changes

  • Removed payload-dir section from docs/src/content/docs/reference/frontmatter.md
  • No code changes required - the field was never extracted from frontmatter
  • Preserved payloadDir documentation in mcp-gateway.md where it correctly appears as part of the gateway configuration JSON schema

The field remains properly documented in the MCP Gateway Specification as an internal gateway config parameter, which is its correct location.

Original prompt

Remove payload-dir from frontmatter and docs. It is not configurable.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

The payload-dir field was never user-configurable from workflow frontmatter.
It's an internal implementation detail set programmatically by
ensureDefaultMCPGatewayConfig(). The extractMCPGatewayConfig() function
does not extract this field from frontmatter.

The payloadDir field remains correctly documented in the MCP Gateway
Specification (mcp-gateway.md) as part of the gateway configuration JSON
schema, which is the correct location for internal gateway configuration.

Changes:
- Removed payload-dir section from frontmatter.md
- No code changes needed (field was never parsed from frontmatter)
- PayloadDir field in MCPGatewayRuntimeConfig remains unchanged (internal use)
- MCP gateway specification documentation unchanged (correct location)

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Remove payload-dir from frontmatter and documentation Remove payload-dir from frontmatter documentation Feb 6, 2026
Copilot AI requested a review from pelikhan February 6, 2026 07:23
@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

🔍 PR Triage Results

Category: docs | Risk: low | Priority: 27/100

Scores Breakdown

  • Impact: 20/50 - Documentation improvement - improves clarity and organization.
  • Urgency: 0/30 - Age: 5.2 hours (0.2 days). Draft status reduces urgency - not yet ready for review.
  • Quality: 7/20 - CI status: pending. Draft status - needs review before merge.

📋 Recommended Action: Defer

Draft PR - defer until marked ready for review. Complete testing and validation, then mark as ready.


Triaged by PR Triage Agent on 2026-02-06

AI generated by PR Triage Agent

@pelikhan pelikhan marked this pull request as ready for review February 6, 2026 12:27
Copilot AI review requested due to automatic review settings February 6, 2026 12:27
@pelikhan pelikhan merged commit 3eb54ff into main Feb 6, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/remove-payload-dir-config branch February 6, 2026 12:27
Copy link
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

This PR corrects documentation by removing the payload-dir field from the frontmatter reference documentation. The field was incorrectly documented as a user-configurable frontmatter option, but it is actually an internal implementation detail that is set programmatically and never extracted from frontmatter.

Changes:

  • Removed the payload-dir section from frontmatter.md that incorrectly suggested users could configure this field
  • No code changes were needed since the field was never extracted from frontmatter

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants