Skip to content

[docs] Consolidate developer specifications - fix 42 code fence regressions (v3.2)#18586

Merged
pelikhan merged 2 commits intomainfrom
docs/consolidation-2026-02-27-a65ec5785317ade7
Feb 27, 2026
Merged

[docs] Consolidate developer specifications - fix 42 code fence regressions (v3.2)#18586
pelikhan merged 2 commits intomainfrom
docs/consolidation-2026-02-27-a65ec5785317ade7

Conversation

@github-actions
Copy link
Contributor

Fixes 42 non-standard code fence closing markers that were reintroduced when the HEAD commit (a8a4ea7, "Fix #18574 (#18578)") replaced all scratchpad/ files, reverting formatting fixes from the previous consolidation run.

Changes Made

  • 42 non-standard closing code fences fixed across 12 spec files: code-organization.md (17), github-actions-security-best-practices.md (7), actions.md (4), firewall-log-parsing.md (3), capitalization.md (3), end-to-end-feature-testing.md (2), and 6 single-instance files
  • scratchpad/dev.md bumped to v3.2 with updated history entry

Background

CommonMark specifies closing code fences must not have an info string. Lines like ```text used as closing markers are rendered as content of the preceding block rather than closing it, causing all subsequent code blocks to be incorrectly nested. The previous consolidation run (22421430881) fixed 173 such fences, but the bulk file replacement in the merge commit reintroduced them.

Two false positives were intentionally preserved: adding-new-engines.md:659 and workflow-refactoring-patterns.md:159 contain ```yaml/```bash as content within ```markdown blocks (intentional nested code examples).

Files Modified

  • scratchpad/dev.md — v3.1 → v3.2, updated document history
  • scratchpad/actions.md — 4 fences
  • scratchpad/agents/hierarchical-agents.md — 1 fence
  • scratchpad/breaking-cli-rules.md — 1 fence
  • scratchpad/capitalization.md — 3 fences
  • scratchpad/code-organization.md — 17 fences
  • scratchpad/end-to-end-feature-testing.md — 2 fences
  • scratchpad/firewall-log-parsing.md — 3 fences
  • scratchpad/github-actions-security-best-practices.md — 7 fences
  • scratchpad/labels.md — 1 fence
  • scratchpad/safe-output-messages.md — 1 fence
  • scratchpad/string-sanitization-normalization.md — 1 fence
  • scratchpad/validation-architecture.md — 1 fence

Validation

✅ All 42 identified fences corrected
✅ 2 false positives preserved
✅ dev.md structure, tone, and 9 Mermaid diagrams intact
✅ 100% spec coverage maintained

References: §22466445409

Generated by Developer Documentation Consolidator

  • expires on Mar 1, 2026, 12:12 AM UTC

The HEAD commit (a8a4ea7) replaced all scratchpad/ files, reverting
formatting fixes from the previous consolidation run. This commit
re-fixes 42 non-standard closing code fences across 12 spec files.

CommonMark requires closing fences to be plain backticks without an
info string. Replaced ```text and ```yaml as closing markers with ```
in: actions.md, code-organization.md, github-actions-security-best-
practices.md, capitalization.md, firewall-log-parsing.md, and 7 others.

Also bumps dev.md to v3.2 with updated history entry.

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 27, 2026
@pelikhan pelikhan merged commit b69fb5c into main Feb 27, 2026
@pelikhan pelikhan deleted the docs/consolidation-2026-02-27-a65ec5785317ade7 branch February 27, 2026 00:32
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.

In private repos, events triggered in comments PRs are not able to access the PR branch

1 participant