Skip to content

[deep-report] Document 7 missing top-level frontmatter fields + fix 2 broken schema See: anchors #31526

Closed as not planned

Description

@github-actions

Source

DeepReport intelligence briefing — 2026-05-11. References: Schema Consistency Report (discussion #31437).

Problem

docs/src/content/docs/reference/frontmatter.md (the canonical reference) is missing dedicated ### sections for several implemented top-level schema fields. Worse, 2 of 3 See: https://github.github.com/gh-aw/reference/frontmatter/#... URLs embedded in the JSON schema point to anchors that do not exist on the rendered page.

Missing sections in frontmatter.md:

Field Why it matters
max-effective-tokens ET budget cap (default 10M); only documented in an ADR
max-runs Only in the engines.md table
check-for-updates Broken schema anchor #check-for-updates
run-install-scripts Broken schema anchor #run-install-scripts
disable-model-invocation Only in auto-generated frontmatter-full.md
user-rate-limit Documented in rate-limiting-controls.md but not cross-linked
inline-sub-agents Has dedicated page, not linked from canonical reference

Suggested fix

  1. Add a ### section for each of the 7 fields above to docs/src/content/docs/reference/frontmatter.md. For fields with separate pages (inline-sub-agents, user-rate-limit), include a short summary + cross-link.
  2. Tighten the inline-sub-agents schema (pkg/parser/schemas/main_workflow_schema.json:2723) from "type": "boolean" to "const": true so schema-aware editors surface the same rejection that the compiler does (per pkg/workflow/compiler_validators.go:59-62).

Effort / Impact

  • Effort: 2–3 hours (single docs PR + 1-line schema change)
  • Impact: Medium — closes a documentation gap visible to every user reading the canonical reference; fixes 2 broken anchor links shipped in the schema.
  • Suggested agent: Documentation-writing agent (Claude)

Success criteria

  • frontmatter.md has ### sections for all 7 missing fields.
  • Following the See: URLs in check-for-updates and run-install-scripts lands on a real anchor.
  • inline-sub-agents: false is rejected by schema-aware validators (not only by the compiler).

Related: discussion #31437

Generated by DeepReport - Intelligence Gathering Agent · ● 12.8M · ◷

  • expires on May 13, 2026, 3:54 PM UTC

Activity

  1. github-actions commented on May 13, 2026

    @github-actions
    ContributorAuthor

    This issue was automatically closed because it expired on 2026-05-13T15:54:01.536Z.

    Closed by Workflow

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions