[Daily Report] Documentation Quality Report - 2026-06-02

[github-actions]

Summary

I found 4 open documentation-related issues worth attention and 1 older issue that already has coverage in the current docs.

Open gaps

• [cli-tools-test] compile: --workflow-name CLI flag undocumented/incorrect (should be --workflows) #36076 "[cli-tools-test] compile: --workflow-name CLI flag undocumented/incorrect (should be --workflows)".

  • Current docs still show gh aw compile <workflow-name> and workflow_name wording in .github/aw/cli-commands.md:47-63, and only positional forms in docs/src/content/docs/reference/compilation-process.md:222-243.
  • Gap: document the --workflows form or add an explicit compatibility note.

• Docs: guidelines for configuring Go module/build cache in a security-conscious way #27886 "Docs: guidelines for configuring Go module/build cache in a security-conscious way".

  • Current docs only provide generic cache examples in docs/src/content/docs/reference/frontmatter.md:113-125 and a generic build-cache example in docs/src/content/docs/reference/sandbox.md:228-246.
  • Gap: add Go-specific cache paths, sandbox notes, and cache-security guidance.

• Antigravity engine: CI fails with API key; need documented non-interactive auth path #35818 "Antigravity engine: CI fails with API key; need documented non-interactive auth path".

  • Current engine docs list Copilot, Claude, Codex, Gemini, Crush, OpenCode, and Pi in docs/src/content/docs/reference/engines.md:12-24, and quick-start covers the existing engine secrets in docs/src/content/docs/setup/quick-start.mdx:69-87.
  • Gap: no user-facing Antigravity setup or headless CI auth path is documented.

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

  • Related coverage exists in docs/src/content/docs/reference/auth.mdx:271-278 and docs/src/content/docs/reference/assign-to-copilot.mdx:78-84, but the guidance is split and indirect.
  • Gap: add a single authoritative secret reference entry and clarify when this secret is preferred.

Already answered

• Add WorkQueueOps and BatchOps doc pages under design patterns #22001 "Add WorkQueueOps and BatchOps doc pages under design patterns". The current docs already include WorkQueueOps and BatchOps, plus glossary entries, so this one looks closable with a pointer.

Warning

Firewall blocked 2 domains

The following domains were blocked by the firewall during workflow execution:

• api.github.com
• github.com

💡 Tip: api.github.com is blocked because GitHub API access uses the built-in GitHub tools by default. Instead of adding api.github.com to network.allowed, use tools.github.mode: gh-proxy for direct pre-authenticated GitHub CLI access without requiring network access to api.github.com:

tools:
  github:
    mode: gh-proxy

See GitHub Tools for more information on gh-proxy mode.

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "api.github.com"
    - "github.com"

See Network Configuration for more information.

Generated by 💻 Dev · gpt54 6.7M · ◷

• expires on Jun 9, 2026, 10:11 AM UTC