docs: add permissions-required to front-matter example block - #1865
Draft
github-actions[bot] wants to merge 1 commit into
Draft
docs: add permissions-required to front-matter example block#1865github-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
FrontMatter.permissions_required(serialized aspermissions-required) is a real, fully-documented front-matter field (seedocs/imports.md#permissions-required), but it was absent from the comprehensive front-matter example block indocs/front-matter.md, unlike every other top-level field (permissions,network,supply-chain,execution-context, etc.). An agent skimming the example to see the full field surface would not discover it.docs/front-matter.mdApplied Fixes
permissions-required:example right after thepermissions:block indocs/front-matter.md, with a cross-link 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 documentation of the field's semantics indocs/imports.md. Cross-checked the rest ofAGENTS.md's architecture tree,docs/cli.mdagainstsrc/main.rs'sCommandsenum,docs/safe-outputs.mdagainstsrc/safe_outputs/*.rs, anddocs/network.md's ecosystem identifier table againstsrc/data/ecosystem_domains.json/src/ecosystem_domains.rs— all found accurate and complete, so no further changes were made this run.Created by the agent-documentation maintainer workflow.