Restore HTMLBlock unwraps clobbered by May 18 ReadMe re-export#56
Open
chrisdp wants to merge 2 commits into
Open
Restore HTMLBlock unwraps clobbered by May 18 ReadMe re-export#56chrisdp wants to merge 2 commits into
chrisdp wants to merge 2 commits into
Conversation
…s table
The "General ECP commands" table was on a single ~25,000-char line
inside a JSX <HTMLBlock>{`...`}</HTMLBlock> template literal, which
kept ReadMe from rendering the [text](doc:slug) references inside —
the Roku OS 15.0/15.2/13.0/12.0/11.5 release-notes links and the
self-references to #input-command-conventions and roinputevent.
Drop the wrapper and reformat as one row per line. To survive MDX:
- Escape the bare uppercase placeholder syntax (<KEY>, <APP_ID>) as
<...> so they aren't read as JSX tag opens.
- Escape the `<<em>NAME</em>>` placeholder syntax used for path
params (`<channelId>`, `<seconds>`, `<appId>`, etc.) the same way.
- Inside the <pre><code> response examples, entity-encode the XML
payload (<sgrendezvous>, <tracking-enabled>, <status>, etc.) so
MDX doesn't read them as JSX.
- Nested sgrendezvous and fwbeacons sub-tables are placed on their
own indented lines inside their parent cell.
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
1 participant
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
PRs #45 and #50 unwrapped HTMLBlock wrappers from five tables so that ReadMe could render the
[text](doc:slug)references inside (Roku OS release-notes links, in-page anchors, etc.). The May 18 commits070c2945(socket-based-debugger) andcd61cf12(external-control-api) — both auto-generated re-exports from ReadMe.com — put the wrappers back, breaking those links again.This PR just re-removes the two wrapper lines (
<HTMLBlock>{\`` and`}`) around each affected table. The table contents themselves survived the re-export, so the diff is small (10 deletions total across 2 files).external-control-api.md: 1 table re-unwrapped (General ECP commands)socket-based-debugger.md: 4 tables re-unwrapped (HandshakeFromDVP, DebuggerRequest, DebuggerResponse, DebuggerUpdate)If the re-export was triggered by a ReadMe-side edit that didn't pull from GitHub first, it would be worth syncing those pages on the ReadMe side after this merges so the unwrap sticks through the next export.