docs: fix documentation drift — add inlined-imports field and runtime import guidance#660
Merged
jamesadevine merged 2 commits intoMay 20, 2026
Conversation
… import guidance
- README.md Front Matter Fields table was missing the `inlined-imports` field,
which is implemented in src/compile/types.rs and documented in
docs/front-matter.md and docs/runtime-imports.md.
- prompts/create-ado-agentic-workflow.md had no mention of `inlined-imports`
or `{{#runtime-import ...}}` markers, so agents creating new workflows
would be unaware of this feature. Added Step 16 covering both.
- prompts/create-ado-agentic-workflow.md: expanded the network.allowed
documentation to show ecosystem identifiers (python, node, rust, dotnet,
lean) as an alternative to raw domain patterns, consistent with
docs/network.md and docs/front-matter.md.
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 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:
|
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 code and documentation:
Findings
inlined-importsfield missing from tableREADME.mdinlined-importsor\{\\{\#runtime-import ...}}markersprompts/create-ado-agentic-workflow.mdnetwork.allowedecosystem identifiers not documentedprompts/create-ado-agentic-workflow.mdDetails
1.
inlined-importsmissing from README Front Matter Fields tableThe
inlined-importsfield is fully implemented insrc/compile/types.rs(line 710–711) and documented indocs/front-matter.mdanddocs/runtime-imports.md, but the README's Front Matter Fields table did not include it. Agents and contributors looking at the README for a field list would not discover this feature.2.
inlined-importsand\{\\{\#runtime-import ...}}absent from workflow creation promptprompts/create-ado-agentic-workflow.mdis the guide AI agents use when creating new workflow files. It had no mention ofinlined-importsor runtime-import markers. This means agents creating new pipelines would never setinlined-imports: trueeven when appropriate (e.g., compliance/audit scenarios where the prompt body must be frozen at compile time).3.
network.allowedecosystem identifiers not shown in workflow creation promptdocs/front-matter.mdanddocs/network.mddocument thatnetwork.allowedaccepts ecosystem identifiers (e.g.,python,rust,node) that expand to curated domain lists, but the prompt only showed raw domain patterns. Agents would miss this shorthand.Applied Fixes
inlined-importsrow to the Front Matter Fields table inREADME.mdprompts/create-ado-agentic-workflow.mdcoveringinlined-imports: true/falsesemantics, a decision table, and\{\\{\#runtime-import ...}}marker usageprompts/create-ado-agentic-workflow.mdto show ecosystem identifiers as an alternative to raw domain patternsThis pull request was created by the automated documentation freshness check.