Skip to content

fix(docs): rephrase backtick-in-table cell that breaks docs-build CI on dev#1312

Open
tamirdresher wants to merge 1 commit into
bradygaster:devfrom
tamirdresher:fix/docs-build-skill-security-fences
Open

fix(docs): rephrase backtick-in-table cell that breaks docs-build CI on dev#1312
tamirdresher wants to merge 1 commit into
bradygaster:devfrom
tamirdresher:fix/docs-build-skill-security-fences

Conversation

@tamirdresher

Copy link
Copy Markdown
Collaborator

Fixes the Squad CI / test job that's red on dev right now (run 27488323855, commit 567f4475).

Root cause

The skill-security-scanner.md doc landed via #1276 with a 4-backtick table cell intended to display a literal triple-backtick:

| Inside a fenced code block (```` ``` ````) | Suppressed |

That made test/docs-build.test.ts's regex /```/g see 5 occurrences across the file (the real bash example contributes 2; the 4-backtick cell's inner ``` contributes 1; the surrounding ```` contributes 2 split across opening + closing) — odd total, even-fence check fails. The same construct also tripped the "code blocks contain language specification or valid content" check.

Fix

Two-line rephrase in skill-security-scanner.md: say "three backticks" / "single backtick" in prose instead of trying to render literal delimiters in a markdown table cell. Reads cleaner anyway.

Verified locally

  • npx vitest run test/docs-build.test.ts → 22/22 pass
  • npm run build in docs/ → 171 files emitted; pagefind indexes 168 pages / 6911 words

… table

CI failure on dev tip (567f447, Squad CI run 27488323855):
  test/docs-build.test.ts > 'all code blocks are properly fenced (even
  count of backticks)' → expected 1 to be 0
  test/docs-build.test.ts > 'code blocks contain language specification
  or valid content' → expected 1 to be greater than 1

Root cause: a 4-backtick table cell intended to display a literal
triple-backtick:

  | Inside a fenced code block (\\\\ \\\ \\\\) | Suppressed |

made the regex /\\\/g see 5 triple-backtick occurrences across the
file (instead of the 2 from the real bash example), tripping both the
even-fence check and the line-count > 1 check.

Rephrased the table to say 'three backticks' / 'single backtick' in
prose — no embedded delimiters, no need to defend against the markdown
fence escape mechanism. Reads cleaner anyway.

Verified locally: 22/22 docs-build tests pass; npm run build in docs/
completes (171 files emitted; pagefind indexes 168 pages, 6911 words).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings June 14, 2026 04:41
@github-actions

Copy link
Copy Markdown
Contributor

🛫 PR Readiness Check

ℹ️ This comment updates on each push. Last checked: commit 3c4b09e

PR Scope: 🔧 Infrastructure

⚠️ 2 item(s) to address before review

Status Check Details
Single commit 1 commit — clean history
Not in draft Ready for review
Branch up to date Up to date with dev
Copilot review No Copilot review yet — it may still be processing
Changeset present No source files changed — changeset not required
Scope clean No .squad/ or docs/proposals/ files
No merge conflicts No merge conflicts
Copilot threads resolved No Copilot review threads
CI passing 5 check(s) still running

Files Changed (1 file, +2 −2)

File +/−
docs/src/content/docs/features/skill-security-scanner.md +2 −2

Total: +2 −2


This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.

@github-actions

Copy link
Copy Markdown
Contributor

🟢 Impact Analysis — PR #1312

Risk tier: 🟢 LOW

📊 Summary

Metric Count
Files changed 1
Files added 0
Files modified 1
Files deleted 0
Modules touched 1

🎯 Risk Factors

  • 1 files changed (≤5 → LOW)
  • 1 module(s) touched (≤1 → LOW)

📦 Modules Affected

docs (1 file)
  • docs/src/content/docs/features/skill-security-scanner.md

This report is generated automatically for every PR. See #733 for details.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Fixes docs-build CI failures on dev by removing a markdown construct that introduced an odd number of triple-backtick fence tokens, which broke the docs validation in test/docs-build.test.ts.

Changes:

  • Rephrases the “Suppression” table rows to describe delimiters in prose (“three backticks” / “single backtick”) rather than attempting to render literal backticks inside a table cell.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants