socket-based-debugger.md: unwrap HTMLBlock for tables with doc: links#45
Merged
Merged
Conversation
The handshake fields, debugger request/response, and DebuggerUpdate
tables were wrapped in JSX <HTMLBlock>{`...`}</HTMLBlock> template
literals. ReadMe's markdown processor doesn't run inside HTMLBlock, so
the 11 [Roku OS X.Y](doc:release-notes#...) and `[Debugging Commands](#...)`
references in those cells rendered literally.
Drop the wrappers, fix <br> to <br /> for MDX, escape the bracketed
\[1970-01-01T00:00:00.000Z] timestamp so MDX doesn't read it as a
reference-style link, and indent each table by nesting depth (the
source had everything flush-left). For the cells that contain a
nested compatibility-matrix table, break the cell open onto its own
line so the nested <table> sits at a reasonable depth.
The other 16 HTMLBlock tables on the page had no markdown link syntax
inside, so they render correctly today and are left alone.
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
2 participants
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.
Summary
Four tables on the BrightScript debug protocol page wrap their HTML in a JSX
<HTMLBlock>{...}</HTMLBlock>template literal. ReadMe doesn't run its markdown processor insideHTMLBlock, so the 11[Roku OS X.Y](doc:release-notes#...)and[Debugging Commands](#debugging-commands)references inside those cells were rendering literally.The reported example was the Roku OS ↔ debug-protocol-version compatibility matrix in the handshake-fields table, where every Roku OS entry showed as raw bracket-and-parens text instead of a link.
Changes
<HTMLBlock>{/\}` wrappers around four tables (handshake fields, Debugger Request Format, Debugger Response Format, DebuggerUpdate fields).<br>→<br />so MDX doesn't reject the now-bare HTML.\[1970-01-01T00:00:00.000Z]so MDX doesn't try to read it as a reference-style link.<table>sits at a reasonable indent level.The other 16
HTMLBlocktables on the page contain no markdown link syntax, so they render correctly today and are left alone.