π Documentation Quality β Daily Status Report
Date: 2026-03-31 | Scope: gh-aw documentation health
Previous report: #22630 (2026-03-24)
Summary
| Category |
Count |
| Carry-over documentation gaps |
1 β οΈ |
| Open issues with documentation problems |
5 π΄ |
| Issues answerable by existing documentation |
1 β
|
| Documentation gaps without coverage |
3 β |
β οΈ Carry-Over from Previous Report
Issue #22207 β toolsets: [all] shorthand undocumented
Status: Still open β no doc addition yet for toolsets: [all] in reference/github-tools.md.
docs/src/content/docs/reference/github-tools.md documents the dependabot toolset requirement (vulnerability-alerts: read) but never mentions [all] as a valid shorthand. Users who discover toolsets: [all] from examples have no docs warning them about implied permissions.
Recommended action: Add a callout to reference/github-tools.md:
β οΈ toolsets: [all] includes the dependabot toolset, which requires vulnerability-alerts: read (GitHub Appβonly). Prefer listing specific toolsets if you don't need Dependabot tools.
π΄ Open Issues with Documentation Problems
Issue #19703 β .github/agents/ path does not resolve
Title: Agent imports: .github/agents/ path does not resolve β must be under .github/workflows/
Problem: The [custom agents documentation]((github.github.io/redacted) states agent files should live in .github/agents/, but the compiler resolves imports relative to .github/workflows/, causing a "file not found" error for the documented path.
Docs cross-reference: docs/src/content/docs/reference/copilot-custom-agents.md β says .github/agents/ works, but it doesn't.
Classification: β Documentation describes behavior that doesn't match implementation. Either fix the compiler or update the docs to reflect that agents/ must be under .github/workflows/agents/.
Issue #19611 β .github/agents imports on Claude/Codex take fragile prompt-assembly path
Title: Bug: .github/agents imports on Claude/Codex take fragile prompt-assembly path; .github/snippets avoids it
Problem: Docs claim .github/agents/*.md imports work for non-Copilot engines by injecting markdown into the prompt. In practice, agent imports trigger special AGENT_CONTENT + PROMPT_TEXT assembly that fails with --print mode, while .github/snippets/ imports use a more robust path.
Docs cross-reference: docs/src/content/docs/reference/imports.md (lines 76β120) and docs/src/content/docs/reference/copilot-custom-agents.md.
Classification: β Docs/implementation mismatch. Related to #19703. Workaround (use .github/snippets/) is undocumented.
Issue #22939 β AWF agent cannot reach Postgres started via services:
Title: BUG: AWF agent cannot reach Postgres started via services:
Problem: The services: frontmatter is documented (with a Postgres example in docs/src/content/docs/reference/frontmatter.md), but the docs never clarify whether service containers are reachable from inside the AWF sandbox. A user followed the documented example and found Postgres unreachable β service ports bind to the host, but the agent container's network isolation prevents connection.
Docs cross-reference: docs/src/content/docs/reference/frontmatter.md β ## Service Containers (services:) β documents the field but says nothing about sandbox networking.
Classification: β Documentation gap. The services: section should include a note clarifying whether service containers are accessible from the agent sandbox (and what workaround to use if not β e.g., access via host.docker.internal or loopback).
Issue #23212 β gh aw add rewrites \{\\{\#import shared/X.md}} with incorrect cross-repo path
Title: gh aw add rewrites \{\\{\#import shared/X.md}} with incorrect cross-repo path (resolves from repo root instead of .github/workflows/)
Problem: Two bugs in one: (1) gh aw add unconditionally rewrites all local \{\\{\#import shared/X.md}} directives to pinned cross-repo paths, with no way to mark an import as local; (2) when it does rewrite, it uses the wrong base path (repo root instead of .github/workflows/), producing a 404.
Docs cross-reference: docs/src/content/docs/guides/packaging-imports.md covers the packaging pattern but does not document gh aw add's import rewriting behavior or how to keep imports local.
Classification: β Undocumented behavior causing breakage. Docs should explain the rewriting strategy and how to opt out.
Issue #1250 β "web-search" not available when using Copilot CLI
Title: "web-search" is reported as not available when using Copilot CLI
Problem: Many sample workflows trigger a warning Engine 'copilot' does not support the web-search tool. The warning is unhelpful β no link to documentation about alternatives (e.g., third-party MCPs).
Docs cross-reference: docs/src/content/docs/guides/mcps.md and docs/src/content/docs/guides/getting-started-mcp.md exist but do not specifically address the "what to do instead of web-search" question.
Classification: β Missing documentation page. A short "Web Search Alternatives" page linking to MCP options (Brave Search MCP, Tavily, etc.) would address the issue. The warning itself should emit a link to this new page.
β
Issues Answerable by Existing Documentation
Issue #20593 β Documentation missing for GH_AW_GITHUB_TOKEN
Title: Documentation missing for GH_AW_GITHUB_TOKEN magic secret
Original problem: PR #17990 removed the auth.mdx guidance for GH_AW_GITHUB_TOKEN, leaving users without clear instructions on when and why it's needed.
Current state: docs/src/content/docs/reference/tokens.md now provides a comprehensive token reference including:
- Full quick-reference table listing
GH_AW_GITHUB_TOKEN and its fallback chain
- Dedicated section explaining use as a general-purpose fallback
- Per-use-case documentation (MCP server, agent assignment, plugins, etc.)
Assessment: β
This issue appears to be closeable with a pointer to docs/src/content/docs/reference/tokens.md#gh_aw_github_token. Recommend closing #20593 and linking the tokens reference.
π Day-over-Day Trend
| Metric |
2026-03-24 |
2026-03-31 |
Change |
| Open doc-problem issues |
0 |
5 |
β¬οΈ +5 |
| Issues closeable with doc pointer |
0 |
1 |
β
+1 |
| Carry-over gaps |
1 |
1 |
β Stable |
| Docs testing warnings |
2 |
2 |
β Stable (skip-link target, sitemap 404 in dev) |
π― Recommended Actions
| Priority |
Action |
Target |
| High |
Fix compiler or update docs for .github/agents/ path resolution |
#19703, #19611 |
| High |
Add sandbox networking note to services: docs section |
#22939 |
| Medium |
Document gh aw add import rewriting behavior + local-import opt-out |
#23212 |
| Medium |
Add toolsets: [all] warning to github-tools.md |
#22207 carry-over |
| Low |
Create "Web Search Alternatives" MCP guide page |
#1250 |
| Low |
Close #20593 with pointer to tokens.md#gh_aw_github_token |
#20593 |
Generated by Daily Status Report workflow β 2026-03-31 09:30 UTC
Generated by Dev Β· β·
π Documentation Quality β Daily Status Report
Date: 2026-03-31 | Scope: gh-aw documentation health
Previous report: #22630 (2026-03-24)
Summary
Issue #22207 β
toolsets: [all]shorthand undocumentedStatus: Still open β no doc addition yet for
toolsets: [all]inreference/github-tools.md.docs/src/content/docs/reference/github-tools.mddocuments thedependabottoolset requirement (vulnerability-alerts: read) but never mentions[all]as a valid shorthand. Users who discovertoolsets: [all]from examples have no docs warning them about implied permissions.Recommended action: Add a callout to
reference/github-tools.md:π΄ Open Issues with Documentation Problems
Issue #19703 β
.github/agents/path does not resolveTitle:
Agent imports: .github/agents/ path does not resolve β must be under .github/workflows/Problem: The [custom agents documentation]((github.github.io/redacted) states agent files should live in
.github/agents/, but the compiler resolves imports relative to.github/workflows/, causing a "file not found" error for the documented path.Docs cross-reference:
docs/src/content/docs/reference/copilot-custom-agents.mdβ says.github/agents/works, but it doesn't.Classification: β Documentation describes behavior that doesn't match implementation. Either fix the compiler or update the docs to reflect that
agents/must be under.github/workflows/agents/.Issue #19611 β
.github/agentsimports on Claude/Codex take fragile prompt-assembly pathTitle:
Bug: .github/agents imports on Claude/Codex take fragile prompt-assembly path; .github/snippets avoids itProblem: Docs claim
.github/agents/*.mdimports work for non-Copilot engines by injecting markdown into the prompt. In practice, agent imports trigger specialAGENT_CONTENT+PROMPT_TEXTassembly that fails with--printmode, while.github/snippets/imports use a more robust path.Docs cross-reference:
docs/src/content/docs/reference/imports.md(lines 76β120) anddocs/src/content/docs/reference/copilot-custom-agents.md.Classification: β Docs/implementation mismatch. Related to #19703. Workaround (use
.github/snippets/) is undocumented.Issue #22939 β AWF agent cannot reach Postgres started via
services:Title:
BUG: AWF agent cannot reach Postgres started via services:Problem: The
services:frontmatter is documented (with a Postgres example indocs/src/content/docs/reference/frontmatter.md), but the docs never clarify whether service containers are reachable from inside the AWF sandbox. A user followed the documented example and found Postgres unreachable β service ports bind to the host, but the agent container's network isolation prevents connection.Docs cross-reference:
docs/src/content/docs/reference/frontmatter.mdβ## Service Containers (services:)β documents the field but says nothing about sandbox networking.Classification: β Documentation gap. The
services:section should include a note clarifying whether service containers are accessible from the agent sandbox (and what workaround to use if not β e.g., access viahost.docker.internalor loopback).Issue #23212 β
gh aw addrewrites\{\\{\#import shared/X.md}}with incorrect cross-repo pathTitle:
gh aw add rewrites \{\\{\#import shared/X.md}} with incorrect cross-repo path (resolves from repo root instead of .github/workflows/)Problem: Two bugs in one: (1)
gh aw addunconditionally rewrites all local\{\\{\#import shared/X.md}}directives to pinned cross-repo paths, with no way to mark an import as local; (2) when it does rewrite, it uses the wrong base path (repo root instead of.github/workflows/), producing a 404.Docs cross-reference:
docs/src/content/docs/guides/packaging-imports.mdcovers the packaging pattern but does not documentgh aw add's import rewriting behavior or how to keep imports local.Classification: β Undocumented behavior causing breakage. Docs should explain the rewriting strategy and how to opt out.
Issue #1250 β "web-search" not available when using Copilot CLI
Title:
"web-search" is reported as not available when using Copilot CLIProblem: Many sample workflows trigger a warning
Engine 'copilot' does not support the web-search tool. The warning is unhelpful β no link to documentation about alternatives (e.g., third-party MCPs).Docs cross-reference:
docs/src/content/docs/guides/mcps.mdanddocs/src/content/docs/guides/getting-started-mcp.mdexist but do not specifically address the "what to do instead of web-search" question.Classification: β Missing documentation page. A short "Web Search Alternatives" page linking to MCP options (Brave Search MCP, Tavily, etc.) would address the issue. The warning itself should emit a link to this new page.
β Issues Answerable by Existing Documentation
Issue #20593 β Documentation missing for
GH_AW_GITHUB_TOKENTitle:
Documentation missing for GH_AW_GITHUB_TOKEN magic secretOriginal problem: PR #17990 removed the
auth.mdxguidance forGH_AW_GITHUB_TOKEN, leaving users without clear instructions on when and why it's needed.Current state:
docs/src/content/docs/reference/tokens.mdnow provides a comprehensive token reference including:GH_AW_GITHUB_TOKENand its fallback chainAssessment: β This issue appears to be closeable with a pointer to
docs/src/content/docs/reference/tokens.md#gh_aw_github_token. Recommend closing #20593 and linking the tokens reference.π Day-over-Day Trend
π― Recommended Actions
.github/agents/path resolutionservices:docs sectiongh aw addimport rewriting behavior + local-import opt-outtoolsets: [all]warning togithub-tools.mdtokens.md#gh_aw_github_tokenGenerated by Daily Status Report workflow β 2026-03-31 09:30 UTC