Description
The Schema Consistency Checker (discussion #53917) found three documentation gaps in docs/src/content/docs/reference/frontmatter.md and related pages, all independently verified against schema/parser source:
threat-detection-suppress is fully implemented and schema-validated (pkg/workflow/threat_detection_suppression.go enforces rule matching CTR-###, non-empty reason, expires as YYYY-MM-DD) but has no section in the main frontmatter guide — only generated skeleton lines in frontmatter-full.md.- Deprecated top-level
max-runs (still accepted by the parser as a fallback alias per pkg/workflow/frontmatter_types.go / engine.go, documented in glossary.md) is missing from the main frontmatter guide's max-turns/rate-limit area, so users reading only that page won't know it's deprecated or should migrate with gh aw fix.
- Code comments in
pkg/workflow/strict_mode_update_check_validation.go reference https://github.github.com/gh-aw/reference/check-for-updates/ as a dedicated page, but no such page was found in the scanned docs corpus — likely a stale link that should point at the existing check-for-updates section in frontmatter.md instead.
Expected Impact
Closes real discoverability gaps for two implemented-but-undocumented/under-documented config surfaces, and removes a stale maintainer-facing doc link. Low-risk, docs-only bundle.
Suggested Agent
New Agent (or docs-focused agent) — add one short section for threat-detection-suppress with a minimal example, one sentence noting max-runs deprecation, and update/remove the stale check-for-updates link in code comments.
Estimated Effort
Quick (< 1 hour) — three small, independent doc edits.
Data Source
DeepReport Intelligence Briefing analysis of discussion #53917 (Schema Consistency Checker, 2026-08-19).
Generated by 🔬 Deep Report · agent · 159.8 AIC · ⌖ 12.4 AIC · ⊞ 11.9K · ◷
Description
The Schema Consistency Checker (discussion #53917) found three documentation gaps in
docs/src/content/docs/reference/frontmatter.mdand related pages, all independently verified against schema/parser source:threat-detection-suppressis fully implemented and schema-validated (pkg/workflow/threat_detection_suppression.goenforcesrulematchingCTR-###, non-emptyreason,expiresasYYYY-MM-DD) but has no section in the main frontmatter guide — only generated skeleton lines infrontmatter-full.md.max-runs(still accepted by the parser as a fallback alias perpkg/workflow/frontmatter_types.go/engine.go, documented inglossary.md) is missing from the main frontmatter guide'smax-turns/rate-limit area, so users reading only that page won't know it's deprecated or should migrate withgh aw fix.pkg/workflow/strict_mode_update_check_validation.goreferencehttps://github.github.com/gh-aw/reference/check-for-updates/as a dedicated page, but no such page was found in the scanned docs corpus — likely a stale link that should point at the existingcheck-for-updatessection infrontmatter.mdinstead.Expected Impact
Closes real discoverability gaps for two implemented-but-undocumented/under-documented config surfaces, and removes a stale maintainer-facing doc link. Low-risk, docs-only bundle.
Suggested Agent
New Agent (or docs-focused agent) — add one short section for
threat-detection-suppresswith a minimal example, one sentence notingmax-runsdeprecation, and update/remove the stalecheck-for-updateslink in code comments.Estimated Effort
Quick (< 1 hour) — three small, independent doc edits.
Data Source
DeepReport Intelligence Briefing analysis of discussion #53917 (Schema Consistency Checker, 2026-08-19).