Skip to content

docs(ir): fix stale canonical pipeline shape and Conclusion trigger in ir.md - #2147

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-ir-pipeline-shape-drift-f715c283f869fad1
Draft

github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-ir-pipeline-shape-drift-f715c283f869fad1

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Agent Documentation Update

Findings

Area Issue File(s)
accuracy docs/ir.md described the canonical agentic-pipeline shape as Setup → Agent → Detection → SafeOutputs → Teardown (plus Conclusion "when conclusion: 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 as Setup → Agent → Detection → (ManualReview?) → Custom_<tool>* → SafeOutputs(+SafeOutputs_Reviewed?) → Teardown → Conclusion. It also invented a conclusion: front-matter field that does not exist — FrontMatter in src/compile/types.rs has no such field; Conclusion is actually emitted whenever safe-outputs: is configured (correctly stated in docs/conclusion.md). docs/ir.md

Applied Fixes

  • Updated both pipeline-shape descriptions in docs/ir.md to the correct Setup → Agent → Detection → (ManualReview?) → Custom_<tool>* → SafeOutputs(+SafeOutputs_Reviewed?) → Teardown → Conclusion shape, matching AGENTS.md, docs/cli.md, and docs/extending.md.
  • Removed the incorrect reference to a conclusion: front-matter field and replaced it with the accurate trigger rule (Conclusion emitted whenever safe-outputs: is configured), consistent with docs/conclusion.md.

Notes

Verified by comparing docs/ir.md against src/compile/agentic_pipeline.rs, src/compile/types.rs (FrontMatter struct — no conclusion field), and the matching shape descriptions already correct in AGENTS.md, docs/cli.md, docs/extending.md, and docs/conclusion.md. Confirmed no open PR already addresses this (checked open PR #2115, which fixes a different docs/ir.md section — the CompilerExtension trait's default declarations() method — with no overlap). Also audited CLI commands (src/main.rs Commands enum vs docs/cli.md), the FrontMatter field list vs docs/front-matter.md, safe-output tool coverage (src/safe_outputs/*.rs vs docs/safe-outputs.md), schedule syntax (src/fuzzy_schedule.rs vs docs/schedule-syntax.md), the AGENTS.md architecture tree vs find src -name '*.rs', and all three prompts/*.md guides — no further material drift found, so no other changes were made.


Created by the agent-documentation maintainer workflow.

Generated by Agent Documentation Maintainer · auto · 169.5 AIC · ⌖ 6.25 AIC · ⊞ 12.4K ·

…n ir.md

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@azure-pipelines

Copy link
Copy Markdown
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants