Skip to content

[docs] Self-healing documentation fixes from issue analysis - 2026-06-19#40171

Closed
github-actions[bot] wants to merge 1 commit into
mainfrom
doc-healer/echo-pipe-secret-setup-2026-06-19-dd92adfb19c35452
Closed

[docs] Self-healing documentation fixes from issue analysis - 2026-06-19#40171
github-actions[bot] wants to merge 1 commit into
mainfrom
doc-healer/echo-pipe-secret-setup-2026-06-19-dd92adfb19c35452

Conversation

@github-actions

Copy link
Copy Markdown
Contributor

Self-Healing Documentation Fixes

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

Gaps Fixed

  • Issue [deep-report] Docs: replace beginner-hostile < /path/to/token.txt with an echo-pipe in Quick Start #40096: Docs: replace beginner-hostile < /path/to/token.txt with an echo-pipe in Quick Start — Replaced the file-redirect form in both the COPILOT_GITHUB_TOKEN and ANTHROPIC_API_KEY setup callouts in docs/src/content/docs/setup/quick-start.mdx with the copy-pasteable echo "..." | gh secret set ... form. The issue was closed without a merged PR addressing it, so the beginner-hostile snippet remained on lines 81 and 87.

Root Cause

DDUw's Pre-flight batch fetches recently closed documentation issues (step 3) but does not verify that each closed issue actually produced a merged docs PR. When a documentation issue is closed manually (or via auto-cleanup) without an associated docs change, the gap silently persists. Issue #40096 was a deep-report quick-win that was closed by a human without a PR landing, and DDUw did not re-detect the literal /path/to/token.txt string still present in the quick-start.

💡 DDUw Improvement Suggestions

DDUw Improvement Suggestions

In .github/workflows/daily-doc-updater.md, after the Pre-flight batch fetch (step 3 fetches recently closed documentation issues), add a verification step:

  1. Verify closure type for each recently closed documentation issue. For every closed issue returned by step 3, follow its timeline and check whether any cross-referenced event points to a merged PR (require merged == true). If none, treat the issue as an unaddressed gap and queue it for re-evaluation alongside the merged-PR scan — not as already-handled.

  2. Sanity-check specific drift strings cited in the issue body. For deep-report quick-win issues that quote a literal file path and line, grep the working tree for the quoted snippet before assuming the gap is closed. If the snippet still exists at the cited file, fix it directly.

  3. Treat issues closed without a linked merged PR as drift candidates, not as resolved work. Mention this explicitly in the workflow body so the agent does not over-trust an issue's closed state.

These rules would have caught #40096 on the same day it was closed.

Related Issues

Generated by 📝 Daily Documentation Healer · 235.3 AIC · ⊞ 6.9K ·

  • expires on Jun 21, 2026, 4:22 PM UTC-08:00

Issue #40096 reported that the Quick Start secret-setup steps reference
'gh secret set ... < /path/to/token.txt', which a brand-new user has no
way to act on. No PR landed for this issue. Use the copy-pasteable
echo-pipe form instead so the steps work as written.

Closes #40096
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation closed:unknown PR was closed without merging: unknown documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[deep-report] Docs: replace beginner-hostile < /path/to/token.txt with an echo-pipe in Quick Start

1 participant