Skip to content

docs: sync canonical pipeline shape description with AGENTS.md - #1879

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

docs: sync canonical pipeline shape description with AGENTS.md#1879
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-pipeline-shape-drift-5f4ff00f2ffd2697

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Agent Documentation Update

Findings

Area Issue File(s)
accuracy docs/cli.md and docs/extending.md described the canonical pipeline shape as Setup → Agent → Detection → SafeOutputs → Teardown (+ optional Conclusion), which pre-dates the ManualReview gate, Custom_<tool>* safe-output jobs, and the SafeOutputs/SafeOutputs_Reviewed split. AGENTS.md and the source doc-comment in src/compile/agentic_pipeline.rs already document the correct, current shape, so these two pages had drifted out of sync with the canonical description. docs/cli.md, docs/extending.md

Applied Fixes

  • Updated the "Pipeline IR Reference" section in docs/cli.md to describe the full Setup → Agent → Detection → (ManualReview?) → Custom_<tool>* → SafeOutputs(+SafeOutputs_Reviewed?) → Teardown → Conclusion shape, noting when ManualReview and the SafeOutputs_Reviewed split are inserted.
  • Updated the "New compile targets" guidance in docs/extending.md with the same corrected shape.

Notes

Verified against src/compile/agentic_pipeline.rs module doc-comment (lines 3-58) and its build_canonical_jobs implementation, which explicitly builds ManualReview, custom safe-output jobs, and the SafeOutputsVariant split. Confirmed AGENTS.md's architecture-tree entry for agentic_pipeline.rs already had the accurate description, so it was used as the source of truth for the wording applied to both drifted pages. No source-code changes were made; only the two documentation pages were edited.


Created by the agent-documentation maintainer workflow.

Generated by Agent Documentation Maintainer · auto · 37.6 AIC · ⌖ 6.39 AIC · ⊞ 13.2K ·

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