Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-09-30 - #64596

Merged
pelikhan merged 1 commit into
mainfrom
docs/doc-healer-cli-gaps-2026-09-30-8de30abf6c0df9a9
Oct 1, 2026
Merged

[docs] Self-healing documentation fixes from issue analysis - 2026-09-30#64596
pelikhan merged 1 commit into
mainfrom
docs/doc-healer-cli-gaps-2026-09-30-8de30abf6c0df9a9

Conversation

@github-actions

@github-actions github-actions Bot commented Sep 30, 2026

Copy link
Copy Markdown
Contributor

Self-Healing Documentation Fixes

This PR was automatically created by the Daily Documentation Healer workflow.

It fixes 5 setup/cli.md gaps that were confirmed against the current source. They come from two CLI Consistency Checker issues that auto-closed as not_planned without a docs fix.

Gaps Fixed

  • Issue [cli-consistency] CLI Consistency Issues - 2026-09-28 #64018: [cli-consistency] CLI Consistency Issues - 2026-09-28. Added --visibility to the env update options, with its allowed values (all|private|selected), the default (all), and the fact that it is rejected for repo scope. Source: pkg/cli/env_command.go:219, validateDefaultsVisibility.
  • Issue [cli-consistency] CLI Consistency Issues - 2026-09-23 #62964: [cli-consistency] CLI Consistency Issues - 2026-09-23:
    • audit --artifacts: added the missing info set (ArtifactSetInfo, pkg/cli/logs_artifact_set.go).
    • mcp list-tools: added an options line for the required --server flag (pkg/cli/mcp_list_tools.go:231).
    • domains: replaced "ecosystem identifiers" with the CLI's "named domain sets" wording and added copilot to the examples, matching pkg/cli/domains_command.go.
    • json-schema: added the missing Utility Commands section (audit, logs, logs-jsonl), linking to the existing reference/audit.md#json-output-schemas.
Issues analyzed and skipped

Root Cause

DDUw has two compounding gaps for CLI Consistency Checker issues:

  1. Pre-flight fetch Add workflow: githubnext/agentics/weekly-research #4 only sees open issues. gh issue list --label documentation --label cookie ... in daily-doc-updater.md has no --state flag, so gh returns open issues only. These reports expire and auto-close within about 2 days, so they drop out of the fetch before DDUw sees them again.
  2. The Step 1c not_planned rule treats expiry as rejection. Auto-expired issues are closed as not_planned by github-actions[bot]. Step 1c then says "Do not create documentation based solely on this issue" unless a same-window code change is found. The cross-cutting exception covers "coverage or convention" gaps, not flag-level drift. Step 1d is meant to catch cookie issues, but it does not say that it overrides Step 1c.
💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

  1. In Pre-flight step 4, add --state all and a date bound:
    gh issue list --label documentation --label cookie --state all --search "updated:>=YYYY-MM-DD" --limit 30 --json number,title,body,state,stateReason,closedAt,url
  2. In Step 1c not_planned, add a carve-out: "If the issue was closed by github-actions[bot] and its body contains a gh-aw-expires marker (automatic expiry), treat it as unreviewed, not rejected, and process it as in Step 1d."
  3. In Step 1d, state that it takes precedence over the Step 1c not_planned rule for CLI Consistency Checker issues. For each finding, check the Options line and prose in cli.md against the flag definitions in pkg/cli/*.go. Findings that are Go help-text bugs only should be ignored.
  4. In Pre-flight step 3, raise --limit 20 to at least 50. The closed documentation list had 28 items in the last 7 days, most of them report issues, so a limit of 20 can drop older actionable issues.

Related Issues

Generated by 📝 Daily Documentation Healer · claude · haiku45 · 405.2 AIC · ⌖ 46.5 AIC · ⊞ 6.7K · ◷

  • expires on Oct 3, 2026, 3:53 PM UTC-08:00

@github-actions @claude
docs: document missing CLI flags and json-schema command in cli.md
5abfa80 
Fills gaps reported by CLI Consistency Checker issues #64018 and #62964
that DDUw missed after the issues auto-closed as not_planned.

Co-Authored-By: Claude Code <noreply@anthropic.com>
@github-actions github-actions Bot added automation documentation Improvements or additions to documentation labels Sep 30, 2026
@github-actions github-actions Bot mentioned this pull request Sep 30, 2026
Closed
@pelikhan
pelikhan marked this pull request as ready for review October 1, 2026 03:11
Copilot AI balanced review requested due to automatic review settings October 1, 2026 03:11
@pelikhan
pelikhan merged commit f7e82bf into main Oct 1, 2026
1 check passed
@pelikhan
pelikhan deleted the docs/doc-healer-cli-gaps-2026-09-30-8de30abf6c0df9a9 branch October 1, 2026 03:11
@github-actions

github-actions Bot commented Oct 1, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

✅ Test Quality Sentinel completed test quality analysis.

No test files were added or modified in this PR (only docs/src/content/docs/setup/cli.md changed). Test Quality Sentinel skipped.

🧪 Test quality analysis by Test Quality Sentinel

Copilot AI reviewed Oct 1, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟢 Approval recommended

All five documentation updates accurately match the corresponding CLI implementations.

Review effort: Balanced
Findings: None

What changed in this PR

Updates the CLI reference to match current command behavior and available options.

Changes:

  • Documents missing audit, env update, and mcp list-tools values.
  • Aligns domains terminology and examples with CLI help.
  • Adds json-schema command documentation.
File Description
docs/​src/​content/​docs/​setup/​cli.md Corrects and expands CLI reference documentation.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

This was referenced Oct 1, 2026
Closed
Closed
Merged
Merged
@github-actions

github-actions Bot commented Oct 3, 2026

Copy link
Copy Markdown
Contributor Author

🎉 This pull request is included in a new release.

Release: v0.90.3

This was referenced Oct 4, 2026
Merged
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments

Assignees

No one assigned

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[cli-consistency] CLI Consistency Issues - 2026-09-28 [cli-consistency] CLI Consistency Issues - 2026-09-23

2 participants

@pelikhan