Skip to content

fix(docs): render inline SVG diagrams correctly - #2368

Merged
chaliy merged 1 commit into
mainfrom
codex/fix-scripted-tools-diagram
Sep 1, 2026
Merged

fix(docs): render inline SVG diagrams correctly#2368
chaliy merged 1 commit into
mainfrom
codex/fix-scripted-tools-diagram

Conversation

@chaliy

@chaliy chaliy commented Aug 31, 2026

Copy link
Copy Markdown
Contributor

What changed

Inline SVG diagrams now render as complete diagrams across all four affected guides instead of exposing their remaining SVG markup as code.

The site postbuild now rejects blank lines inside inline SVG blocks in both canonical guide trees, preventing the rendering failure from recurring. The durable authoring constraint is recorded in the documentation playbook.

Why

CommonMark ends a raw HTML block at a blank line. Blank lines inside the diagrams split each SVG during Markdown rendering, leaving only the first group visible and displaying the rest as escaped source.

Before / After

Before:

Broken scripted-tools diagram

After:

Rendered scripted-tools diagram

Proof:

  • Regression verifier failed on the four affected guides before the fix and passes after it.
  • Full site build and postbuild validation pass.
  • Browser smoke test finds one complete SVG with 6 rectangles and 8 text labels, with zero leaked SVG source.
  • just pre-pr passes.

Risk

  • Low
  • Limited to Markdown diagram formatting and site documentation validation.

Checklist

  • Tests added or updated
  • Backward compatibility considered

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
bashkit c76fc5d Commit Preview URL

Branch Preview URL
Aug 31 2026, 11:52 PM

@chaliy
chaliy merged commit 4b9fcc0 into main Sep 1, 2026
25 checks passed
@chaliy
chaliy deleted the codex/fix-scripted-tools-diagram branch September 1, 2026 00:06
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.

1 participant