Skip to content

Add missing row separators to KaTeX cases blocks - #3751

Closed
Bornoz wants to merge 1 commit into
0xMiden:nextfrom
Bornoz:fix/katex-cases-row-separators
Closed

Add missing row separators to KaTeX cases blocks#3751
Bornoz wants to merge 1 commit into
0xMiden:nextfrom
Bornoz:fix/katex-cases-row-separators

Conversation

@Bornoz

@Bornoz Bornoz commented Aug 31, 2026

Copy link
Copy Markdown

Every \begin{cases} block in the instruction-reference docs was missing the \\ row separator between its rows. remark-math + rehype-katex (per docs/docusaurus.config.ts) needs \\ to separate rows inside cases; without it KaTeX collapses the rows into one and a piecewise definition renders as a single garbled line.

Added the separator to all 47 affected blocks across the four assembly instruction-reference files and stack_ops.md. Each block was verified by rendering it through KaTeX and confirming the row count (<mtr> per case) matches the number of cases — before the fix every one collapsed to a single row.

design/chiplets/ace.md has two more cases blocks inside a blockquote with a different structure; left out to keep this change mechanical and reviewable.

Closes #3650

Every \begin{cases} block in the instruction-reference docs was missing the \\ row separator between its rows. remark-math + rehype-katex (per docs/docusaurus.config.ts) needs \\ to separate rows inside cases; without it KaTeX collapses the two rows into one, so a piecewise definition rendered as a single garbled line.

Added the separator to all 47 affected blocks across the four assembly instruction-reference files and stack_ops.md. Each block was checked by rendering it through KaTeX and confirming the row count matches the number of cases (one <mtr> per case); before the fix every one collapsed to a single row.

(design/chiplets/ace.md has two more cases blocks inside a blockquote with a different multi-row structure; left out of this change to keep it mechanical and reviewable.)

Closes 0xMiden#3650
@github-actions

Copy link
Copy Markdown

This pull request was closed without review because none of the linked open issues
is assigned to @Bornoz.

Our contribution guidelines require contributions to link to an
issue assigned to the author. Please ask to be assigned before opening a new
pull request.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Instruction reference docs: \begin{cases} blocks are missing the \\ row separator, breaking KaTeX rendering (41 occurrences across 4 files)

1 participant