docs(ir): fix stale canonical pipeline shape and Conclusion trigger - #2226
Draft
github-actions[bot] wants to merge 1 commit into
Draft
github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
…n ir.md Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Azure Pipelines: 2 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
2 tasks
This branch has not been deployed
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.
Agent Documentation Update
Findings
docs/ir.mddescribed the canonical agentic-pipeline shape asSetup → Agent → Detection → SafeOutputs → Teardown(plus Conclusion "whenconclusion:is configured") in two places (the module-layout intro and the "Per-target compilers" section). This is stale:src/compile/agentic_pipeline.rs(and every other reference page —AGENTS.md,docs/cli.md,docs/extending.md) documents the real shape asSetup → Agent → Detection → (ManualReview?) → Custom_* → SafeOutputs(+SafeOutputs_Reviewed?) → Teardown → Conclusion. It also invented aconclusion:front-matter field that does not exist —FrontMatterinsrc/compile/types.rshas no such field; Conclusion is actually emitted wheneversafe-outputs:is configured (correctly stated indocs/conclusion.md).docs/ir.mdApplied Fixes
docs/ir.mdto the correctSetup → Agent → Detection → (ManualReview?) → Custom_* → SafeOutputs(+SafeOutputs_Reviewed?) → Teardown → Conclusionshape, matchingAGENTS.md,docs/cli.md, anddocs/extending.md.conclusion:front-matter field and replaced it with the accurate trigger rule (Conclusion emitted wheneversafe-outputs:is configured), consistent withdocs/conclusion.md.Notes
Verified by comparing
docs/ir.mdagainstsrc/compile/agentic_pipeline.rs,src/compile/types.rs(FrontMatterstruct — noconclusionfield), and the matching, already-correct shape descriptions inAGENTS.md,docs/cli.md,docs/extending.md, anddocs/conclusion.md.Before making this change I audited CLI commands (
src/main.rsCommandsenum vsdocs/cli.md), theFrontMatterfield list vsdocs/front-matter.md, safe-output tool coverage (src/safe_outputs/*.rsvsdocs/safe-outputs.md), MCP/runtime/execution-context/supply-chain/codemod docs vs their source structs, theAGENTS.mdarchitecture tree vsfind src -name '*.rs', and all threeprompts/*.mdguides — no further material drift was found there.An earlier PR (#2147) proposed this exact fix but was closed without merging, and no currently open PR targets this file, so the drift is still live on
main.Created by the agent-documentation maintainer workflow.