docs: document permissions-required in front-matter reference - #2023
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs: document permissions-required in front-matter reference#2023github-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
permissions-requiredis a top-levelFrontMatterfield (src/compile/types.rs) with real compile-time semantics (abstract read/write capability requirements, unioned across imports and consumer), but the primarydocs/front-matter.mdreference never mentioned the key — it only appeared indocs/imports.mdunder import-merge semantics. An agent skimming the front-matter reference alone would not discover this field.docs/front-matter.mdApplied Fixes
permissions-required:example directly after thepermissions:block indocs/front-matter.md, matching the surrounding style (commented-out optional field with inline explanation), and cross-linked todocs/imports.md#permissions-requiredfor the full semantics.Notes
Verified against
src/compile/types.rs(FrontMatter::permissions_required: PermissionsRequired,#[serde(rename = "permissions-required")]) and the existing full write-up indocs/imports.md. No behavior was changed or invented — this only closes a discoverability gap in the canonical front-matter page. Also auditeddocs/cli.mdagainstsrc/main.rsCommands/SecretsCmd/GraphCmd(all subcommands and flags present and accurate),docs/safe-outputs.mdagainstsrc/safe_outputs/*.rs(every tool documented, includingassign-work-item), andprompts/create-ado-agentic-workflow.mdfield lists againstFrontMatter— no further drift found.Created by the agent-documentation maintainer workflow.