Skip to content

[docs] Consolidate yaml-version-gotchas.md into dev.md (v3.0)#18236

Merged
pelikhan merged 1 commit intomainfrom
docs/consolidation-2026-02-25-1703d708286037bd
Feb 25, 2026
Merged

[docs] Consolidate yaml-version-gotchas.md into dev.md (v3.0)#18236
pelikhan merged 1 commit intomainfrom
docs/consolidation-2026-02-25-1703d708286037bd

Conversation

@github-actions
Copy link
Contributor

Overview

Daily documentation consolidation run (2026-02-25). This PR completes 100% coverage of all spec files in scratchpad/ by documenting yaml-version-gotchas.md, the last uncovered file from the 7 new specs added since the 2026-02-10 inventory. It also fixes 18 non-standard code fence closing markers in that file.

Changes Made

scratchpad/dev.md — bumped to v3.0:

  • Added YAML Parser Compatibility subsection to the Validation Architecture section documenting:
    • gh-aw's use of goccy/go-yaml v1.18.0 (YAML 1.2 compliant)
    • YAML 1.1 vs 1.2 boolean keyword table (on/yes/no/off behavior)
    • Python yaml.safe_load false positive for the on: trigger key
    • gh aw compile as the correct validation tool
    • YAML 1.2 parser alternatives for tool developers
  • Added yaml-version-gotchas.md to Related Documentation
  • Updated document history with v3.0 entry

scratchpad/yaml-version-gotchas.md — formatting fixes:

  • Fixed 17 closing code fences using non-standard ```text info string → ```
  • Fixed 1 closing code fence using ```yaml as a closing marker → ```

CommonMark specifies that closing fences must not have an info string; these non-standard forms rendered correctly in GitHub's renderer but are not spec-compliant and may fail in other markdown processors.

Coverage Milestone

All 7 spec files added since the 2026-02-10 inventory are now documented in dev.md:

File Version Documented Run
activation-output-transformations.md v2.9 2026-02-24
adding-new-engines.md v2.9 2026-02-24
engine-architecture-review.md v2.9 (referenced) 2026-02-24
engine-review-summary.md v2.9 2026-02-24
html-entity-mention-bypass-fix.md v2.9 2026-02-24
template-syntax-sanitization.md v2.9 2026-02-24
yaml-version-gotchas.md v3.0 2026-02-25

Statistics

  • Files analyzed: 61 (no new files since 2026-02-24)
  • Tone issues: 0
  • Formatting fixes: 18 (in yaml-version-gotchas.md)
  • Lines in dev.md: 2033 → 2071 (+38)
  • dev.md version: v2.9 → v3.0

References: §22375475464

Generated by Developer Documentation Consolidator

  • expires on Feb 27, 2026, 12:08 AM UTC

- Add YAML Parser Compatibility section to dev.md Validation Architecture
  covering goccy/go-yaml YAML 1.2 compliance, Python false positive issue
  with on: trigger key, and YAML 1.2 parser recommendations
- Fix 18 non-standard code fence closings in yaml-version-gotchas.md
  (17 ```text -> ```, 1 ```yaml -> ```)
- Add yaml-version-gotchas.md to Related Documentation
- Bump dev.md to v3.0 completing 100% coverage of all 60 spec files

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions github-actions bot added automation documentation Improvements or additions to documentation labels Feb 25, 2026
@pelikhan pelikhan merged commit a880047 into main Feb 25, 2026
@pelikhan pelikhan deleted the docs/consolidation-2026-02-25-1703d708286037bd branch February 25, 2026 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automation documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants