Skip to content

[Daily Report] Daily Documentation Status Report - 2026-08-29 #56869

Description

@github-actions

Documentation review of open issues found several real docs problems, plus one partial-answer case where the relevant configuration area is documented but the behavior is not.

Daily Documentation Status Report - 2026-08-29

Open issues reporting documentation problems

Issue Problem reported Current documentation section Assessment
#56618 gh-aw workshop docs incorrect External workshop page lists gh aw init artifacts that are not actually created. This repo does not contain the workshop page source. docs/src/content/docs/workshop.md only points users to the external gh-aw-workshop repository/site. Gap exists, but the source is upstream/outside this repo.
#56660 [cli-consistency] CLI Consistency 问题 - 2026-08-28 gh aw edit --help tells users to pass --no-merge, but the command has no such flag; edit is also missing from the CLI reference. pkg/cli/edit_command.go still contains the --no-merge wording; docs/src/content/docs/setup/cli.md has no edit section. Real doc/help-text bug plus a reference-doc gap.
#56301 [deep-report] Fix max-daily-ai-credits default-behavior contradiction across docs, schema, and compiler Current docs disagree on whether max-daily-ai-credits is disabled by default or defaults to 5000. docs/src/content/docs/reference/frontmatter.md and docs/src/content/docs/reference/glossary.md still say disabled by default; docs/src/content/docs/reference/rate-limiting-controls.md says default 5000 AIC. Real contradiction in current docs.
#56563 Suppress org- based billing tip somehow Users cannot find how to opt out of the repeated org-billing suggestion for Copilot. docs/src/content/docs/reference/frontmatter.md documents permissions levels generally, but docs/src/content/docs/reference/auth.mdx and docs/src/content/docs/reference/permissions.md only explain the write path, not the none opt-out behavior. Partial answer exists, but the opt-out behavior is undocumented.
#56721 [spec-coverage] Daily Spec Coverage Report — 33214368431 .github/aw/test-expression.md is missing a description: frontmatter field. .github/aw/test-expression.md begins with frontmatter but no description: entry. Gap exists.
#56683 [spdd] Daily spec work plan - 2026-08-28 Spec docs contain stale/missing content: allowed-transitions is described in compliance docs but not in the normative spec; otel-observability-spec.md body still says version 0.4.0. specs/replace-label-compliance/README.md documents allowed-transitions; specs/replace-label-spec.md has no matching normative section; specs/otel-observability-spec.md still says Version 0.4.0 in its abstract/status prose while the change log has Version 0.5.0. Real spec-doc gaps and stale text.

问题 already answered by current docs

None of the reviewed open issues look fully closable with a documentation pointer alone.

The closest partial-answer case is #56563: current docs already imply the setting belongs under permissions, not engine, but they still do not document that permissions.copilot-requests: none suppresses the compile-time org-billing tip.

Gaps with no current in-repo documentation source

Warning

Firewall blocked 4 domains

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

  • ab.chatgpt.com
  • api.github.com
  • chatgpt.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
    - "ab.chatgpt.com"
    - "api.github.com"
    - "chatgpt.com"
    - "github.com"

See 网络 Configuration for more information.

Generated by 💻 Dev · codex · gpt54 · 69.3 AIC · ⌖ 6.33 AIC · ⊞ 10.6K ·
Add label dev to run again

  • expires on Sep 5, 2026, 12:49 AM UTC-08:00

Metadata

Metadata

Assignees

No one assigned

    标签

    documentationImprovements or additions to documentation

    Type

    No type

    项目

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions