Skip to content

docs: fix documentation drift — permissions.write incorrectly documented as required#897

Merged
jamesadevine merged 1 commit into
mainfrom
docs/fix-documentation-drift-permissions-fields-e121c98e02f368a6
Jun 8, 2026
Merged

docs: fix documentation drift — permissions.write incorrectly documented as required#897
jamesadevine merged 1 commit into
mainfrom
docs/fix-documentation-drift-permissions-fields-e121c98e02f368a6

Conversation

@jamesadevine
Copy link
Copy Markdown
Collaborator

Fixes documentation drift in README.md:

  • Remove false claim that compilation fails without permissions.write for write safe outputs. The Stage 3 executor always has write access via $(System.AccessToken); permissions.write only overrides the default with an ARM-minted credential.
  • Correct the Permission Combinations table. Both the 'Only read' and 'Neither (default)' rows incorrectly showed safe outputs cannot write. All rows can write; the difference is which token is used ($(System.AccessToken) vs ARM-minted).
  • Add the missing �xecution-context field to the Front Matter Fields table. The field exists in the FrontMatter struct and has its own docs page but was absent from the table.

Generated by agentic workflow run 27088800996.

…ted as required

- Fix README: remove false claim that compilation fails without
  permissions.write for write safe outputs. The executor always has
  write access via $(System.AccessToken); permissions.write only
  overrides the default with an ARM-minted credential.

- Fix README: correct the Permission Combinations table. Both the
  'Only read' and 'Neither (default)' rows incorrectly showed safe
  outputs cannot write. All rows can write; the difference is which
  token is used (System.AccessToken vs ARM-minted).

- Fix README: add missing 'execution-context' field to the Front
  Matter Fields table. This field exists in the FrontMatter struct
  and has its own docs page but was absent from the table.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@jamesadevine jamesadevine merged commit 06dc22b into main Jun 8, 2026
13 checks passed
@jamesadevine jamesadevine deleted the docs/fix-documentation-drift-permissions-fields-e121c98e02f368a6 branch June 8, 2026 08:40
@github-actions github-actions Bot mentioned this pull request Jun 8, 2026
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.

1 participant