Skip to content

[docs] Fix 175 non-standard code fence closing markers across 20 scratchpad spec files#18417

Merged
pelikhan merged 2 commits intomainfrom
docs/consolidate-dev-specs-2026-02-26-cfcc9dbcb2c5e196
Feb 26, 2026
Merged

[docs] Fix 175 non-standard code fence closing markers across 20 scratchpad spec files#18417
pelikhan merged 2 commits intomainfrom
docs/consolidate-dev-specs-2026-02-26-cfcc9dbcb2c5e196

Conversation

@github-actions
Copy link
Contributor

@github-actions github-actions bot commented Feb 26, 2026

Comprehensive formatting fix for non-standard code fence closing markers found across 20 specification files in scratchpad/.

Problem

The [CommonMark spec]((spec.commonmark.org/redacted) requires that closing code fences have no info string. A line like ```text used as a closing fence is technically invalid because text is an info string. While GitHub's renderer may tolerate this, it creates inconsistency and may cause rendering issues in other markdown tools.

Example of the problem found throughout spec files:

func someFunc() {
    // code
}
```text     ← WRONG: closing fence has info string

Should be:

func someFunc() {
    // code
}
```         ← CORRECT: no info string on closing fence

Changes Made

Fixed 175 non-standard closing fences across 20 spec files:

File Fixes
scratchpad/github-actions-security-best-practices.md 34
scratchpad/safe-output-messages.md 33
scratchpad/string-sanitization-normalization.md 14
scratchpad/mcp_logs_guardrails.md 12
scratchpad/actions.md 11
scratchpad/security_review.md 8
scratchpad/go-type-patterns.md 4
scratchpad/end-to-end-feature-testing.md 4
scratchpad/firewall-log-parsing.md 4
scratchpad/template-injection-prevention.md 4
scratchpad/mods/jsonschema-go.md 4
scratchpad/validation-architecture.md 18
scratchpad/schema-validation.md 3
scratchpad/breaking-cli-rules.md 3
scratchpad/changesets.md 5
scratchpad/testing.md 5
scratchpad/safe-output-environment-variables.md 2
scratchpad/gosec.md 2
scratchpad/code-organization.md 2
scratchpad/capitalization.md 1

Also updated scratchpad/dev.md to version 3.1 with a change history entry.

Validation

  • Automated script parsed all markdown files tracking code block open/close language tags
  • Only changed ```text closing fences that were closing blocks opened with non-text language tags
  • Preserved 3 legitimate nested code blocks inside ```markdown documentation examples
  • Verified no content changes — pure closing fence corrections only

Review Notes

Each changed line was exactly ```text``` (or the appropriate bare closing fence). No code content was modified. The fix is purely syntactic conformance to the CommonMark specification.

References: §22421430881

Generated by Developer Documentation Consolidator

  • expires on Feb 28, 2026, 12:10 AM UTC


✨ PR Review Safe Output Test - Run 22422877284

💥 [THE END] — Illustrated by Smoke Claude

…files

Fixed non-standard closing fences where ```text (or similar) was used
to close ```go, ```yaml, and other language code blocks. CommonMark
spec requires closing fences to have no info string.

Files fixed: code-organization.md (2), validation-architecture.md (18),
actions.md (11), safe-output-messages.md (33),
github-actions-security-best-practices.md (34), and 15 others.

Total: 175 closing fence fixes across 20 scratchpad spec files.
Updated dev.md to v3.1 with change 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 26, 2026
@github-actions
Copy link
Contributor Author

Commit pushed: b1daeb0

💥 [THE END] — Illustrated by Smoke Claude

@pelikhan pelikhan merged commit 912ed21 into main Feb 26, 2026
@pelikhan pelikhan deleted the docs/consolidate-dev-specs-2026-02-26-cfcc9dbcb2c5e196 branch February 26, 2026 02:37
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 smoke-claude

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant