fix(docs): rephrase backtick-in-table cell that breaks docs-build CI on dev#1312
Open
tamirdresher wants to merge 1 commit into
Open
fix(docs): rephrase backtick-in-table cell that breaks docs-build CI on dev#1312tamirdresher wants to merge 1 commit into
tamirdresher wants to merge 1 commit into
Conversation
… 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>
Contributor
🛫 PR Readiness Check
PR Scope: 🔧 Infrastructure
|
| 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.
Contributor
🟢 Impact Analysis — PR #1312Risk tier: 🟢 LOW 📊 Summary
🎯 Risk Factors
📦 Modules Affecteddocs (1 file)
This report is generated automatically for every PR. See #733 for details. |
Contributor
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes the
Squad CI / testjob that's red ondevright now (run 27488323855, commit567f4475).Root cause
The
skill-security-scanner.mddoc landed via #1276 with a 4-backtick table cell intended to display a literal triple-backtick:That made
test/docs-build.test.ts's regex/```/gsee 5 occurrences across the file (the realbashexample 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 passnpm run buildindocs/→ 171 files emitted; pagefind indexes 168 pages / 6911 words