docs: fix documentation drift — inlined-imports missing from README, front-matter example, and workflow prompt#659
Merged
jamesadevine merged 3 commits intoMay 20, 2026
Conversation
…le, and workflow prompt The FrontMatter struct has an inlined-imports: bool field (documented in docs/front-matter.md's 'Inlined Imports' section) but it was absent from: - README.md front matter fields table - docs/front-matter.md YAML example (other rarely-used fields like env: are shown commented-out in the example) - prompts/create-ado-agentic-workflow.md (the step-by-step guide AI agents use to create new workflows) This PR adds the field to all three locations so contributors and AI agents can discover it without having to read docs/front-matter.md in full. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Collaborator
|
@copilot resolve the merge conflicts in this pull request |
Co-authored-by: jamesadevine <4742697+jamesadevine@users.noreply.github.com>
Contributor
Resolved and pushed in commit Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
Collaborator
|
@copilot resolve the merge conflicts in this pull request |
Contributor
Checked again against the latest No UI changes were made, so there is no screenshot to share. |
jamesadevine
deleted the
docs/add-inlined-imports-to-docs-2949c9af24d22cbb
branch
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
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 the codebase and documentation:
Findings
inlined-imports:field missing from the front matter fields tableREADME.mdinlined-imports:not shown in the comprehensive YAML example (other rarely-needed fields likeenv:are shown commented-out)docs/front-matter.mdinlined-imports:, leaving AI agents unaware of this fieldprompts/create-ado-agentic-workflow.mdDetails
The
FrontMatterstruct insrc/compile/types.rshas:The field is fully documented in its own Inlined Imports section in
docs/front-matter.md, but was absent from:README.mdfront matter fields table — The table is the canonical quick-reference for human developers.inlined-imports:was omitted even though every other user-facingFrontMatterfield appears there.docs/front-matter.mdYAML example — The comprehensive YAML example at the top of the file shows other rarely-needed fields (e.g.,env:commented-out).inlined-imports:was not included.prompts/create-ado-agentic-workflow.md— This is the step-by-step guide AI agents use to author new pipeline files. With no mention ofinlined-imports:, agents would never set it totrueeven in environments where the source.mdfile is not available at pipeline runtime. Omissions in this file directly cause agents to produce incomplete pipeline configurations.Applied Fixes
inlined-importsrow to the README.md front matter fields tableinlined-imports: falseentry to thedocs/front-matter.mdYAML example, alongside the existing commentedenv:entryprompts/create-ado-agentic-workflow.md, with a usage table and a pointer todocs/runtime-imports.mdThis pull request was created by the automated documentation freshness check.