Skip to content

docs: fix agent documentation drift in AGENTS.md and front-matter.md - #1940

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-agent-doc-drift-1786984923-e157911e2f9fa1a4
Draft

docs: fix agent documentation drift in AGENTS.md and front-matter.md#1940
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/fix-agent-doc-drift-1786984923-e157911e2f9fa1a4

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Agent Documentation Update

Findings

Area Issue File(s)
accuracy src/safe_outputs/assign_work_item.rs exists (backs the documented assign-work-item safe output) but was missing from the architecture tree in AGENTS.md AGENTS.md
accuracy The permissions-required FrontMatter field (#[serde(rename = "permissions-required")] in src/compile/types.rs) is documented in docs/imports.md but was absent from the annotated front-matter example in docs/front-matter.md, so an agent skimming just that page would miss it docs/front-matter.md

Applied Fixes

  • Added assign_work_item.rs to the src/safe_outputs/ listing in AGENTS.md architecture tree, alphabetically placed
  • Added a commented permissions-required: entry to the annotated example in docs/front-matter.md, cross-linking to docs/imports.md#permissions-required

Notes

Verified by diffing find src -type f -name "*.rs" and the FrontMatter struct in src/compile/types.rs against AGENTS.md and docs/front-matter.md. All other CLI commands (main.rs Commands enum), 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.

Generated by Agent Documentation Maintainer · auto · 73.5 AIC · ⌖ 5.89 AIC · ⊞ 13.5K ·

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