docs: fix documentation drift — document inlined-imports field in README and workflow prompt#658
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
…prompt The `inlined-imports` front-matter field has been implemented and documented in docs/front-matter.md and docs/runtime-imports.md, but was absent from both the README front-matter fields reference table and the create-ado-agentic-workflow.md prompt guide. - Add `inlined-imports` row to the README "Front Matter Fields" table - Add Step 16 to the workflow creation prompt explaining when and how to use the field (default false, trade-off with compile-time resolution) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
github-actions
Bot
added
the
documentation
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 inconsistency between code and documentation:
Findings
inlined-importsfield is implemented and documented indocs/front-matter.md+docs/runtime-imports.mdbut absent from the README's reference table and the workflow creation promptREADME.md,prompts/create-ado-agentic-workflow.mdDetails
The
inlined-importsfront-matter field (src/compile/types.rs:711) controls whether\{\\{\#runtime-import ...}}markers in the agent body are resolved at compile time (self-contained YAML) or at pipeline runtime (default, edit-without-recompile). It is fully implemented and documented indocs/front-matter.mdanddocs/runtime-imports.md, but was missing from:README.md— The "Front Matter Fields" table lists all supported fields, butinlined-importswas not included.prompts/create-ado-agentic-workflow.md— The step-by-step authoring guide covers Steps 1–15 but never mentionsinlined-imports, meaning AI agents using this prompt would never know to suggest it even when appropriate (e.g., for air-gapped or self-contained pipeline deployments).Applied Fixes
inlined-importsrow to the README "Front Matter Fields" table with its default value (false) and a link todocs/runtime-imports.mdprompts/create-ado-agentic-workflow.mdexplaining when to use it and the compile-time trade-offThis pull request was created by the automated documentation freshness check.