[Daily Report] Daily documentation quality report - 2026-07-10

[github-actions]

Overview

I scanned open issues for documentation-related wording and cross-referenced the current docs. I found a small set of real doc-quality signals, but several are already covered by existing pages and mainly need a clearer pointer.

Key findings

• Documentation missing for GH_AW_GITHUB_TOKEN magic secret #20593 Documentation missing for GH_AW_GITHUB_TOKEN magic secret

  • Existing coverage: Authentication and the glossary already document the secret, fallback chain, and PAT creation.
  • Assessment: this looks closeable with a pointer; the docs answer is already present.

• Self hosted runner pre-requisite on kubernetes are not clear #40107 Self hosted runner pre-requisite on kubernetes are not clear

  • Existing coverage: Self-Hosted Runners and the ARC guide How to run GitHub Copilot coding agent on ARC with Docker-in-Docker already list Linux/Docker, sudo, DinD, and topology requirements.
  • Assessment: mostly documented, but the setup path would benefit from a single concise prerequisites checklist.

• Bug: .github/agents imports on Claude/Codex take fragile prompt-assembly path; .github/snippets avoids it #19611 Bug: .github/agents imports on Claude/Codex take fragile prompt-assembly path; .github/snippets avoids it

  • Existing coverage: Importing Copilot Agent Files and Imports describe .github/agents/ imports and say non-Copilot engines inject the markdown body as a prompt.
  • Assessment: docs and behavior look out of sync; either the docs need a limitation note or the implementation needs to match the documented path.

• Safe-output sanitizer strips HTML comments — no structured metadata channel for downstream workflows #18992 Safe-output sanitizer strips HTML comments — no structured metadata channel for downstream workflows

  • Existing coverage: Safe Outputs and the spec sanitization rules explain general redaction, but they do not clearly warn that HTML comments are stripped and should not be used as metadata.
  • Assessment: real documentation gap.

Already-documented behavior

• Don't filter "<...>" in code paragraphs or inline code in markdown posted to issues, issue comments and PR descriptions #18829 Don't filter "<...>" in code paragraphs or inline code in markdown posted to issues, issue comments and PR descriptions

  • The spec explicitly says code blocks and inline code are excluded from sanitization. This reads more like a behavior bug than a docs gap.

• Link redaction needs to be less strict #17513 Link redaction needs to be less strict

  • The safe-outputs docs already describe domain allowlist redaction for links. This is documented behavior, not a missing-docs problem.

Gap summary

• Clear docs gap: HTML comment sanitization / metadata guidance.
• Mostly answered already: GH_AW_GITHUB_TOKEN and self-hosted runner prerequisites.
• Doc-vs-behavior mismatch: .github/agents imports on non-Copilot engines.

Next actions

• Add an explicit note in safe-outputs docs about HTML comments being stripped.
• Consider a short self-hosted runner prerequisites checklist near the setup entry point.
• Verify whether the agent-import behavior still matches the current docs promise.

Generated by 💻 Dev · 10 AIC · ⌖ 3.16 AIC · ⊞ 9.1K · ◷
_{Add label dev to run again}

• expires on Jul 17, 2026, 2:02 AM UTC-08:00