docs: fix architecture-index and front-matter reference drift - #2033
Draft
github-actions[bot] wants to merge 2 commits into
Draft
docs: fix architecture-index and front-matter reference drift#2033github-actions[bot] wants to merge 2 commits into
github-actions[bot] wants to merge 2 commits into
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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 (implements theassign-work-itemsafe output, already documented indocs/safe-outputs.md) but was missing from thesafe_outputs/module listing in theAGENTS.mdarchitecture treeAGENTS.mdpermissions-required:(thePermissionsRequired { read, write }front-matter field insrc/compile/types.rs) is only shown indocs/imports.md; the main front-matter field reference/example indocs/front-matter.mdhad no mention of it, making it hard to discover alongsidepermissions:docs/front-matter.mdApplied Fixes
assign_work_item.rsto thesafe_outputs/file listing inAGENTS.md, alphabetically placed next toassign_github_issue_to_user.rspermissions-required:example block indocs/front-matter.mdright after thepermissions:block, cross-linking todocs/imports.md#permissions-requiredfor full semanticsNotes
Verified by diffing
find src -name '*.rs'against every filename referenced inAGENTS.md's architecture tree —assign_work_item.rswas the only safe-output module actually missing (allcompile/ir/tasks/*.rsfiles are intentionally summarized rather than enumerated, per the existingtasks/comment). Verified thePermissionsRequiredstruct shape (read: bool,write: bool) directly insrc/compile/types.rsbefore writing the new example. No source/config files were touched;git diff --name-onlyconfirms onlyAGENTS.mdanddocs/front-matter.mdchanged.Created by the agent-documentation maintainer workflow.