docs: fix agent documentation drift in AGENTS.md and front-matter.md - #1940
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs: fix agent documentation drift in AGENTS.md and front-matter.md#1940github-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
src/safe_outputs/assign_work_item.rsexists (backs the documentedassign-work-itemsafe output) but was missing from the architecture tree in AGENTS.mdpermissions-requiredFrontMatter field (#[serde(rename = "permissions-required")]insrc/compile/types.rs) is documented indocs/imports.mdbut was absent from the annotated front-matter example indocs/front-matter.md, so an agent skimming just that page would miss itApplied Fixes
assign_work_item.rsto thesrc/safe_outputs/listing in AGENTS.md architecture tree, alphabetically placedpermissions-required:entry to the annotated example in docs/front-matter.md, cross-linking to docs/imports.md#permissions-requiredNotes
Verified by diffing
find src -type f -name "*.rs"and theFrontMatterstruct insrc/compile/types.rsagainst AGENTS.md and docs/front-matter.md. All other CLI commands (main.rsCommandsenum), safe-output tool names (src/safe_outputs/*.rs), and docs/cli.md content were cross-checked and found accurate — no further drift found in this pass.Created by the agent-documentation maintainer workflow.