[docs] Update documentation for features from 2026-05-11#31491
Merged
Conversation
The CLI flag requires an explicit value: 'gh aw init --codespaces' fails with 'flag needs an argument'. Use '--codespaces ""' for current repo only. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Documentation Updates - 2026-05-11
This PR updates the documentation based on recent code changes and merged PRs.
Features Documented
gh aw init --codespacesflag usage corrected to match CLI behavior (related to Align CLI help text semantics and terminology acrossmcp,project,pr,completion,logs, andinit#30696)📝 Detailed Changes & References
Changes Made
docs/src/content/docs/setup/cli.md: Fixed thegh aw init --codespacesexample. The CLI flag requires an explicit value — runninggh aw init --codespaceserrors withflag needs an argument: --codespaces. The example now uses--codespaces ""to mean "current repo only", matching the CLI help text emitted frompkg/cli/init_command.go.Merged PRs Reviewed
engine.max-runsto top-levelmax-runswith AWF enforcement #31418 — Refactorengine.max-runsto top-levelmax-runs. Docs already correctly updated inengines.mdandglossary.md; schema-drivenfrontmatter-full.mdregenerated by build tooling.check_dependency_vulnerabilitiestosecurity_advisoriestoolset #31417 — Addcheck_dependency_vulnerabilitiestosecurity_advisoriestoolset. Same reason — user docs reference toolsets, not individual tools..github/aw/token-optimization.md; user-facingcost-management.mdalready covers user-relevant topics.aw-portfolio-yieldagent job by switching to the OTel queries skill #31470, fix(daily-cli-tools-tester): replace non-existentlistMCP tool withstatus#31481, Comment out top-levelon.labelsin compiled workflows to prevent push-time workflow parse failures #31411, perf(lockfile-stats): enforce single-script cached analysis to cut token/turn cost #31415, Optimize Claude user docs review workflow with inline sub-agents for extractive phases #31416, model inventory update 2026-05-11: add gemma alias, 12 missing multipliers #31413, [spec-review] Update Safe Outputs conformance checker for recent spec changes #31431 — Internal workflow / engine / CI changes; no user-facing docs impact.Related Code Change for the Fix
mcp,project,pr,completion,logs, andinit#30696 (merged 2026-05-06) aligned CLI help text acrossinit,mcp,logs,pr,project,completion. Theinit --codespaceshelp now explicitly requires--codespaces ""for the current-repo-only mode, but the user-facing CLI reference docs still showed the older bareword form.Skipped Issues
not_planned, CLI Consistency Issues — 2026-05-08) — Only finding rejig docs #1 (--codespacesdocs example) was addressed because PR Align CLI help text semantics and terminology acrossmcp,project,pr,completion,logs, andinit#30696 in the 7-day window touched the related CLI code. Findings Add workflow: githubnext/agentics/weekly-research #2–add cli flag to guard dropping a agentic workflow instructinos file #6 concern CLI help text wording or flag definitions rather than user-facing docs and were not addressed.Notes
No other user-facing docs gaps were found from PRs merged in the last 24 hours.