Skip to content

docs: fix architecture-index and front-matter reference drift - #2033

Draft
github-actions[bot] wants to merge 2 commits into
mainfrom
docs/agents-md-safe-outputs-index-a0cdaec59a3efab3
Draft

docs: fix architecture-index and front-matter reference drift#2033
github-actions[bot] wants to merge 2 commits into
mainfrom
docs/agents-md-safe-outputs-index-a0cdaec59a3efab3

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 (implements the assign-work-item safe output, already documented in docs/safe-outputs.md) but was missing from the safe_outputs/ module listing in the AGENTS.md architecture tree AGENTS.md
structure permissions-required: (the PermissionsRequired { read, write } front-matter field in src/compile/types.rs) is only shown in docs/imports.md; the main front-matter field reference/example in docs/front-matter.md had no mention of it, making it hard to discover alongside permissions: docs/front-matter.md

Applied Fixes

  • Added assign_work_item.rs to the safe_outputs/ file listing in AGENTS.md, alphabetically placed next to assign_github_issue_to_user.rs
  • Added a commented permissions-required: example block in docs/front-matter.md right after the permissions: block, cross-linking to docs/imports.md#permissions-required for full semantics

Notes

Verified by diffing find src -name '*.rs' against every filename referenced in AGENTS.md's architecture tree — assign_work_item.rs was the only safe-output module actually missing (all compile/ir/tasks/*.rs files are intentionally summarized rather than enumerated, per the existing tasks/ comment). Verified the PermissionsRequired struct shape (read: bool, write: bool) directly in src/compile/types.rs before writing the new example. No source/config files were touched; git diff --name-only confirms only AGENTS.md and docs/front-matter.md changed.


Created by the agent-documentation maintainer workflow.

Generated by Agent Documentation Maintainer · auto · 76.6 AIC · ⌖ 12.4 AIC · ⊞ 13.5K ·

github-actions Bot and others added 2 commits August 28, 2026 03:32
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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