[docs] Update documentation for features from 2026-05-29#35686
Merged
Conversation
…mple - cli.md: complete the audit run-id and diff Options lists with the --artifacts, --experiment, --variant, --output/-o, and --format flags that are already implemented (closes the audit portion of the CLI consistency gap tracked in #35223). - tools.md: update the safeoutputs add_comment CLI example to use --item_number (the parameter name actually accepted by the safe- output schema). The previous --issue_number form is silently stripped, per the hardening done in #35584.
github-actions
Bot
added
automation
documentation
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
1 participant
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.
Summary
Documentation-only update addressing two gaps identified after the 2026-05-29 feature release.
Changes
docs/src/content/docs/reference/tools.mdadd_commenttool: the parameter was incorrectly shown as--issue_number; corrected to--item_number.docs/src/content/docs/setup/cli.mdgh aw audit(both single-run and diff invocations).--artifacts,--experiment,--format,--json/-j,--output/-o, and--variant, each with a description of its behaviour.Impact
reference/tools.mdsetup/cli.mdNo source code was changed; all modifications are confined to documentation.
Testing
No automated tests required — documentation prose changes only. Recommend a quick visual review of the rendered pages for both files.