docs: fix agent-doc drift in architecture tree and front-matter index - #1931
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs: fix agent-doc drift in architecture tree and front-matter index#1931github-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 and is registered (assign-work-itemsafe output, documented indocs/safe-outputs.md) but was missing from thesrc/safe_outputs/architecture tree listingAGENTS.mdpermissions-required:front-matter field (deserialized insrc/compile/types.rs::FrontMatter) is documented only indocs/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 pagedocs/front-matter.mdApplied Fixes
assign_work_item.rsto thesrc/safe_outputs/tree inAGENTS.md, restoring alphabetical accuracy with the actual directory contentspermissions-required:example plus a cross-link todocs/imports.md#permissions-requiredin the front-matter example block indocs/front-matter.mdNotes
Verified by diffing
find src -type f -name '*.rs'output forsrc/safe_outputs/against theAGENTS.mdtree, and by cross-checking everyFrontMatterfield insrc/compile/types.rsagainstdocs/front-matter.mdcoverage. All other fields and CLI subcommands (checked againstsrc/main.rs'sCommandsenum vsdocs/cli.md) were confirmed accurate — no other drift found this run.Created by the agent-documentation maintainer workflow.