external-control-api.md: unwrap HTMLBlock for the General ECP commands table#50
Merged
Merged
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.
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
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 — including the Roku OS 15.0 / 15.2 / 13.0 / 12.0 / 11.5 release-notes links plus the self-references to#input-command-conventionsandroinputevent.Changes
<HTMLBlock>wrapper and reformat the single-line table as one row per line, with the nestedsgrendezvousandfwbeaconssub-tables on their own indented lines.<KEY>,<APP_ID>) as<...>so MDX doesn't read them as JSX tag opens.<<em>NAME</em>>placeholder syntax used for path params (<channelId>,<seconds>,<appId>, etc.) the same way.<pre><code>response examples, entity-encode the XML payload (<sgrendezvous>,<tracking-enabled>,<status>, etc.) so MDX doesn't try to parse it as JSX.