Skip to content

docs: add permissions-required to front-matter example block - #1865

Draft
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/permissions-required-front-matter-example-06518a0682f72fb2
Draft

docs: add permissions-required to front-matter example block#1865
github-actions[bot] wants to merge 1 commit into
mainfrom
docs/permissions-required-front-matter-example-06518a0682f72fb2

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Agent Documentation Update

Findings

Area Issue File(s)
accuracy/completeness FrontMatter.permissions_required (serialized as permissions-required) is a real, fully-documented front-matter field (see docs/imports.md#permissions-required), but it was absent from the comprehensive front-matter example block in docs/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.md

Applied Fixes

  • Added a commented permissions-required: example right after the permissions: block in docs/front-matter.md, with a cross-link to docs/imports.md#permissions-required for 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 in docs/imports.md. Cross-checked the rest of AGENTS.md's architecture tree, docs/cli.md against src/main.rs's Commands enum, docs/safe-outputs.md against src/safe_outputs/*.rs, and docs/network.md's ecosystem identifier table against src/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.

Generated by Agent Documentation Maintainer · auto · 74.2 AIC · ⌖ 7.39 AIC · ⊞ 13.2K ·

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