docs: fix documentation drift — undocumented create-pr config fields and missing MCP container fields#500
Merged
Conversation
…and missing MCP container fields - docs/safe-outputs.md: add 7 undocumented create-pull-request configuration options: title-prefix, if-no-changes, max-files, protected-files, excluded-files, allowed-labels, fallback-record-branch - prompts/create-ado-agentic-workflow.md: add args: and mounts: fields to MCP container config example (both are valid, documented in README and docs/mcp.md but missing from the primary workflow authoring guide) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation Freshness Audit
This audit found the following inconsistencies between code and documentation:
Findings
create-pull-requestconfigCreatePrConfigstruct but are undocumenteddocs/safe-outputs.mdargs:andmounts:fields missing from the primary workflow authoring guideprompts/create-ado-agentic-workflow.mdDetails
1. Undocumented
create-pull-requestconfig fields (docs/safe-outputs.md)The
CreatePrConfigstruct insrc/safeoutputs/create_pr.rsdefines these fields, butdocs/safe-outputs.mddidn't document them:title-prefixif-no-changes"warn""warn","error","ignore"max-files100protected-files"blocked""blocked"or"allowed"excluded-files[]allowed-labels[](any)fallback-record-branchtrue2. Missing MCP container fields in workflow authoring prompt (
prompts/create-ado-agentic-workflow.md)The
McpOptionsstruct hasargsandmountsfields that are documented inREADME.mdanddocs/mcp.mdbut were absent from the MCP container config example in the primary workflow authoring guide. AI agents using this prompt wouldn't know these fields exist when creating workflows that need Docker volume mounts or custom runtime arguments.Applied Fixes
docs/safe-outputs.md: Added documentation for 7 missingcreate-pull-requestconfiguration optionsprompts/create-ado-agentic-workflow.md: Addedargs:andmounts:fields to the MCP container config exampleThis pull request was created by the automated documentation freshness check.