Description
docs/src/content/docs/reference/frontmatter-full.md documents safe-outputs.dispatch_repository (underscore form) alongside the canonical dispatch-repository (hyphen form). The parser at pkg/workflow/dispatch_repository.go:41 actively warns users to rename the underscore spelling, but the full reference doc still surfaces it prominently like a normal peer key. This creates churn: users copy from docs and immediately get a warning.
Suggested Changes
- In
frontmatter-full.md around line 8468: demote or clearly mark dispatch_repository as deprecated (e.g., add a > **Deprecated**: use dispatch-repository instead notice)
- Or move it to a "deprecated aliases" section and out of primary examples
- Add a regression note: the canonical schema key in
pkg/parser/schemas/main_workflow_schema.json:9533 is dispatch-repository
Files Affected
docs/src/content/docs/reference/frontmatter-full.md (~line 8468)
pkg/workflow/dispatch_repository.go:41 (reference — no change needed)
Success Criteria
dispatch_repository no longer appears as a primary/peer key in the full reference
- Clear deprecation notice points users to
dispatch-repository
- No false impressions that underscore form is equivalent
Source
Extracted from Schema Consistency Check #46539
Priority
Medium — Avoidable user-facing deprecation warnings from copying docs examples
🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent · 40.8 AIC · ⌖ 6.1 AIC · ⊞ 7K · ◷
Description
docs/src/content/docs/reference/frontmatter-full.mddocumentssafe-outputs.dispatch_repository(underscore form) alongside the canonicaldispatch-repository(hyphen form). The parser atpkg/workflow/dispatch_repository.go:41actively warns users to rename the underscore spelling, but the full reference doc still surfaces it prominently like a normal peer key. This creates churn: users copy from docs and immediately get a warning.Suggested Changes
frontmatter-full.mdaround line 8468: demote or clearly markdispatch_repositoryas deprecated (e.g., add a> **Deprecated**: usedispatch-repositoryinsteadnotice)pkg/parser/schemas/main_workflow_schema.json:9533isdispatch-repositoryFiles Affected
docs/src/content/docs/reference/frontmatter-full.md(~line 8468)pkg/workflow/dispatch_repository.go:41(reference — no change needed)Success Criteria
dispatch_repositoryno longer appears as a primary/peer key in the full referencedispatch-repositorySource
Extracted from Schema Consistency Check #46539
Priority
Medium — Avoidable user-facing deprecation warnings from copying docs examples