[docs] Self-healing documentation fixes from issue analysis - 2026-05-26#34801
Closed
github-actions[bot] wants to merge 1 commit into
Closed
[docs] Self-healing documentation fixes from issue analysis - 2026-05-26#34801github-actions[bot] wants to merge 1 commit into
github-actions[bot] wants to merge 1 commit into
Conversation
Add a `forecast` section to docs/src/content/docs/setup/cli.md covering the command's purpose, flags, Monte Carlo projection method, skipped-run exclusion, A/B variant split, and `--eval` backtesting mode. Links to the existing forecast and effective-tokens specifications. Closes #aw_dh1
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.
Self-Healing Documentation Fixes
This PR was automatically created by the Daily Documentation Healer workflow.
Gaps Fixed
gh aw forecastcommand is completely undocumented indocs/src/content/docs/setup/cli.md— Added a#### \forecast`section under **Monitoring** describing the command's purpose, flags (--days,--period,--sample,--eval,--repo,--json), Monte Carlo projection method, skipped-run exclusion (introduced in #34740), refocused effective-token output (#34750), A/B variant split, and--eval` backtesting semantics. The new section links to the existing Forecast Specification and Effective Tokens pages.Root Cause
The
gh aw forecastcommand was introduced on 2026-05-11 in #31377 and has received two feature changes within the last 7 days (#34740 on 2026-05-25 making it interruption-aware and excluding skipped runs, and #34750 on 2026-05-25 refocusing output on effective-token predictions). Thecli.mdreference page — which lists every othergh awsubcommand — never received a corresponding entry.The gap surfaced in cli-consistency issue #33322 (closed
not_plannedon 2026-05-19). Per doc-healer policy fornot_plannedclosures, the issue was cross-referenced against commits in the same 7-day window; the recent forecast-related commits confirm an independent code-driven documentation gap separate from the original aggregate report.DDUw's pre-flight (Step 1) scans only PRs merged in the last 24 hours, so feature additions older than that window are not re-checked against
cli.md. There is no DDUw step that enumerates the live CLI surface (cobra.Commandset) and compares it to the####subcommand sections incli.md, so commands added on older days drift silently.💡 DDUw Improvement Suggestions
DDUw Improvement Suggestions
Add a new heuristic step to
.github/workflows/daily-doc-updater.mdthat detects CLI commands missing fromdocs/src/content/docs/setup/cli.md, independent of recent merges. Concretely:Step 4a — CLI surface vs. reference parity check (new step before "Identify Documentation Gaps"):
grep -hoP 'Use:\s+"\K[a-z][a-z0-9-]' pkg/cli/_command.go | sort -u
Step 1c clarification — recent commits trigger drift checks for the affected feature even when the original triggering PR is older than 24h. Currently Step 1c only re-checks closed-issue body items. Adding "if commits in the 7-day window touch a feature file (e.g.,
pkg/cli/forecast*.go), confirm that feature has a section incli.md" would have caught this gap on the day of Makeforecastinterruption-aware, ignore skipped runs, and clean up empty CI output #34740/Refocusforecastoutput on effective-token predictions by removing yield and episode metrics #34750.These two additions together close the class of gaps where DDUw misses an undocumented feature because no merge in the last 24 hours explicitly says "add docs for X."
Related Issues
[cli-consistency] CLI Consistency Issues - 2026-05-19(closednot_planned; this PR addresses only the forecast-documentation item from that aggregate report, which is independently confirmed by recent commits Makeforecastinterruption-aware, ignore skipped runs, and clean up empty CI output #34740 and Refocusforecastoutput on effective-token predictions by removing yield and episode metrics #34750)References