docs: sync canonical pipeline shape description with AGENTS.md - #1879
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs: sync canonical pipeline shape description with AGENTS.md#1879github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
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. |
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/cli.mdanddocs/extending.mddescribed the canonical pipeline shape asSetup → Agent → Detection → SafeOutputs → Teardown(+ optional Conclusion), which pre-dates theManualReviewgate,Custom_<tool>*safe-output jobs, and theSafeOutputs/SafeOutputs_Reviewedsplit.AGENTS.mdand the source doc-comment insrc/compile/agentic_pipeline.rsalready document the correct, current shape, so these two pages had drifted out of sync with the canonical description.docs/cli.md,docs/extending.mdApplied Fixes
docs/cli.mdto describe the fullSetup → Agent → Detection → (ManualReview?) → Custom_<tool>* → SafeOutputs(+SafeOutputs_Reviewed?) → Teardown → Conclusionshape, noting whenManualReviewand theSafeOutputs_Reviewedsplit are inserted.docs/extending.mdwith the same corrected shape.Notes
Verified against
src/compile/agentic_pipeline.rsmodule doc-comment (lines 3-58) and itsbuild_canonical_jobsimplementation, which explicitly buildsManualReview, custom safe-output jobs, and theSafeOutputsVariantsplit. ConfirmedAGENTS.md's architecture-tree entry foragentic_pipeline.rsalready 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.