Skip to content

docs: fix agent-doc drift in architecture tree and front-matter index - #1931

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/agent-doc-fixes-1786912758-ada0aff0b4a1f88f
Draft

docs: fix agent-doc drift in architecture tree and front-matter index#1931
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/agent-doc-fixes-1786912758-ada0aff0b4a1f88f

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 and is registered (assign-work-item safe output, documented in docs/safe-outputs.md) but was missing from the src/safe_outputs/ architecture tree listing AGENTS.md
structure The permissions-required: front-matter field (deserialized in src/compile/types.rs::FrontMatter) is documented only in docs/imports.md, with no entry/cross-link in the front-matter field reference and example block, making it hard to discover from the primary front-matter page docs/front-matter.md

Applied Fixes

  • Added assign_work_item.rs to the src/safe_outputs/ tree in AGENTS.md, restoring alphabetical accuracy with the actual directory contents
  • Added a commented permissions-required: example plus a cross-link to docs/imports.md#permissions-required in the front-matter example block in docs/front-matter.md

Notes

Verified by diffing find src -type f -name '*.rs' output for src/safe_outputs/ against the AGENTS.md tree, and by cross-checking every FrontMatter field in src/compile/types.rs against docs/front-matter.md coverage. All other fields and CLI subcommands (checked against src/main.rs's Commands enum vs docs/cli.md) were confirmed accurate — no other drift found this run.


Created by the agent-documentation maintainer workflow.

Generated by Agent Documentation Maintainer · auto · 72.8 AIC · ⌖ 5.38 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