[Daily Report] Documentation Quality Report - 2026-05-31

[github-actions]

Open documentation-related issues this morning:

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

  • Current docs only show gh aw compile with a positional workflow argument, not --workflow-name: https://github.com/github/gh-aw/blob/main/docs/src/content/docs/reference/compilation-process.md#L222-L240 and https://github.com/github/gh-aw/blob/main/docs/src/content/docs/setup/cli.md#L1-L24
  • This looks like a real docs/help mismatch. The report issue should point readers to --workflows or the command help text.

• [cli-tools-test] UX: Parameter naming inconsistency between logs (--workflow_name) and compile (--workflows) #35655 UX: Parameter naming inconsistency between logs (--workflow_name) and compile (--workflows)

  • Current docs already distinguish the two shapes, but they do not call out the naming difference clearly: logs examples use .workflow_name in JSON output, while compile docs describe positional workflow names and the workflows array mapping. See https://github.com/github/gh-aw/blob/main/docs/src/content/docs/reference/cost-management.md#L63-L73 and https://github.com/github/gh-aw/blob/main/docs/src/content/docs/reference/compilation-process.md#L222-L240
  • This is mostly a clarity gap rather than a missing feature. A short comparison note in the CLI docs would reduce repeat confusion.

• 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

  • Public docs do not currently document Antigravity setup/auth. reference/engines.md lists other engines but not Antigravity, and quick-start.mdx only documents ANTHROPIC_API_KEY: https://github.com/github/gh-aw/blob/main/docs/src/content/docs/reference/engines.md#L14-L24 and https://github.com/github/gh-aw/blob/main/docs/src/content/docs/setup/quick-start.mdx#L84-L87
  • The only Antigravity runtime guidance I found is in an ADR, not user-facing docs. This is a genuine documentation gap: add engine: antigravity, required secret/setup, and headless CI auth guidance (or explicitly note unsupported auth paths).

Net: 3 open issues, 2 partial-docs pointers, 1 clear public-docs gap. No issue was fully answerable from the current docs alone.

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 9.5M · ◷

• expires on Jun 7, 2026, 9:42 AM UTC